Skip to content

Commit e6722cf

Browse files
committed
fixed he typo and added arm64 instructions to pdfgui.rst
1 parent bb603e9 commit e6722cf

File tree

1 file changed

+46
-8
lines changed

1 file changed

+46
-8
lines changed

products/pdfgui.rst

Lines changed: 46 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -37,18 +37,56 @@ or Anaconda Python (https://www.anaconda.com/download).
3737

3838
PDFgui is available from the "conda-forge" channel of Anaconda packages.
3939

40-
To install it, first open a *Terminal* window or *Anaconda Command Prompt* and use
41-
the :program:`conda` command as follows ::
40+
There are currently two different sets of instructions o install it depending on your platform.
41+
If you want to install it on Windows, Linux, or a non-arm64 Mac OSX (i.e., if at the time of writing
42+
your Mac does not have an M1 or M2 chip) use the first set, otherwise the second set of instructions
4243

43-
conda create --name=pdfgui_env --channel conda-forge diffpy.pdfgui
44+
Windows, macOS (non-Arm64), Linux
45+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
4446

45-
To use PDFgui you then have to activate this conda environment and type pdfgui. ::
47+
Add the "conda-forge" channel by running the following command in a terminal: ::
4648

47-
conda activate pdfgui_env
48-
pdfgui
49+
conda config --add channels conda-forge
4950

50-
After a brief pause he PDFgui window will appear automatically. An alternative method on Windows is to start
51-
PDFgui through the *Diffpy* start menu.
51+
Create a new environment named ``diffpy.pdfgui_env`` (or any name of your choice) and
52+
install ``diffpy.pdfgui``: ::
53+
54+
conda create -n diffpy.pdfgui_env diffpy.pdfgui
55+
56+
Activate the environment: ::
57+
58+
conda activate diffpy.pdfgui_env
59+
60+
Confirm that the installation was successful: ::
61+
62+
python -c "import diffpy.pdfgui; print(diffpy.pdfgui.__version__)"
63+
64+
macOS (Arm64)
65+
~~~~~~~~~~~~~
66+
67+
Create a new conda environment ``diffpy.pdfgui_env``: ::
68+
69+
conda config --add channels conda-forge
70+
conda create -n diffpy.pdfgui_env python=3.13
71+
72+
Activate the environment: ::
73+
74+
conda activate diffpy.pdfgui_env
75+
76+
It is necessary to get versions of pdffit2 built for Mac from Python package index (Pypi). To install
77+
pdffit2 from Pypi using ``pip`` to download and install the latest version from `Python Package Index <https://pypi.python.org>`_: ::
78+
79+
conda install wxpython diffpy.utils matplotlib-base pycifrw
80+
pip install diffpy.pdffit2
81+
82+
Finally, we want to install PDFgui from conda-forge: ::
83+
84+
conda install diffpy.pdfgui --no-deps
85+
86+
87+
88+
Running pdfgui:
89+
===============
5290

5391
.. note::
5492
To start PDFgui from a Terminal make sure *pdfgui_env* is

0 commit comments

Comments
 (0)