@@ -120,18 +120,54 @@ <h2>Installation<a class="headerlink" href="#installation" title="Link to this h
120
120
< strong > Miniconda</ strong > (< a class ="reference external " href ="https://docs.conda.io/en/latest/miniconda.html#latest-miniconda-installer-links "> https://docs.conda.io/en/latest/miniconda.html#latest-miniconda-installer-links</ a > )
121
121
or Anaconda Python (< a class ="reference external " href ="https://www.anaconda.com/download "> https://www.anaconda.com/download</ a > ).</ p >
122
122
< p > PDFgui is available from the “conda-forge” channel of Anaconda packages.</ p >
123
- < p > To install it, first open a < em > Terminal</ em > window or < em > Anaconda Command Prompt</ em > and use
124
- the < strong class ="program "> conda</ strong > command as follows</ p >
125
- < div class ="highlight-bash notranslate "> < div class ="highlight "> < pre > < span > </ span > conda< span class ="w "> </ span > create< span class ="w "> </ span > --name< span class ="o "> =</ span > pdfgui_env< span class ="w "> </ span > --channel< span class ="w "> </ span > conda-forge< span class ="w "> </ span > diffpy.pdfgui
123
+ < p > There are currently two different sets of instructions o install it depending on your platform.
124
+ If you want to install it on Windows, Linux, or a non-arm64 Mac OSX (i.e., if at the time of writing
125
+ your Mac does not have an M1 or M2 chip) use the first set, otherwise the second set of instructions</ p >
126
+ < section id ="windows-macos-non-arm64-linux ">
127
+ < h3 > Windows, macOS (non-Arm64), Linux< a class ="headerlink " href ="#windows-macos-non-arm64-linux " title ="Link to this heading "> ¶</ a > </ h3 >
128
+ < p > Add the “conda-forge” channel by running the following command in a terminal:</ p >
129
+ < div class ="highlight-bash notranslate "> < div class ="highlight "> < pre > < span > </ span > conda< span class ="w "> </ span > config< span class ="w "> </ span > --add< span class ="w "> </ span > channels< span class ="w "> </ span > conda-forge
126
130
</ pre > </ div >
127
131
</ div >
128
- < p > To use PDFgui you then have to activate this conda environment and type pdfgui.</ p >
129
- < div class ="highlight-bash notranslate "> < div class ="highlight "> < pre > < span > </ span > conda< span class ="w "> </ span > activate< span class ="w "> </ span > pdfgui_env
130
- pdfgui
132
+ < p > Create a new environment named < code class ="docutils literal notranslate "> < span class ="pre "> diffpy.pdfgui_env</ span > </ code > (or any name of your choice) and
133
+ install < code class ="docutils literal notranslate "> < span class ="pre "> diffpy.pdfgui</ span > </ code > :</ p >
134
+ < div class ="highlight-bash notranslate "> < div class ="highlight "> < pre > < span > </ span > conda< span class ="w "> </ span > create< span class ="w "> </ span > -n< span class ="w "> </ span > diffpy.pdfgui_env< span class ="w "> </ span > diffpy.pdfgui
135
+ </ pre > </ div >
136
+ </ div >
137
+ < p > Activate the environment:</ p >
138
+ < div class ="highlight-bash notranslate "> < div class ="highlight "> < pre > < span > </ span > conda< span class ="w "> </ span > activate< span class ="w "> </ span > diffpy.pdfgui_env
139
+ </ pre > </ div >
140
+ </ div >
141
+ < p > Confirm that the installation was successful:</ p >
142
+ < div class ="highlight-bash notranslate "> < div class ="highlight "> < pre > < span > </ span > python< span class ="w "> </ span > -c< span class ="w "> </ span > < span class ="s2 "> "import diffpy.pdfgui; print(diffpy.pdfgui.__version__)"</ span >
143
+ </ pre > </ div >
144
+ </ div >
145
+ </ section >
146
+ < section id ="macos-arm64 ">
147
+ < h3 > macOS (Arm64)< a class ="headerlink " href ="#macos-arm64 " title ="Link to this heading "> ¶</ a > </ h3 >
148
+ < p > Create a new conda environment < code class ="docutils literal notranslate "> < span class ="pre "> diffpy.pdfgui_env</ span > </ code > :</ p >
149
+ < div class ="highlight-bash notranslate "> < div class ="highlight "> < pre > < span > </ span > conda< span class ="w "> </ span > config< span class ="w "> </ span > --add< span class ="w "> </ span > channels< span class ="w "> </ span > conda-forge
150
+ conda< span class ="w "> </ span > create< span class ="w "> </ span > -n< span class ="w "> </ span > diffpy.pdfgui_env< span class ="w "> </ span > < span class ="nv "> python</ span > < span class ="o "> =</ span > < span class ="m "> 3</ span > .13
131
151
</ pre > </ div >
132
152
</ div >
133
- < p > After a brief pause he PDFgui window will appear automatically. An alternative method on Windows is to start
134
- PDFgui through the < em > Diffpy</ em > start menu.</ p >
153
+ < p > Activate the environment:</ p >
154
+ < div class ="highlight-bash notranslate "> < div class ="highlight "> < pre > < span > </ span > conda< span class ="w "> </ span > activate< span class ="w "> </ span > diffpy.pdfgui_env
155
+ </ pre > </ div >
156
+ </ div >
157
+ < p > It is necessary to get versions of pdffit2 built for Mac from Python package index (Pypi). To install
158
+ pdffit2 from Pypi using < code class ="docutils literal notranslate "> < span class ="pre "> pip</ span > </ code > to download and install the latest version from < a class ="reference external " href ="https://pypi.python.org "> Python Package Index</ a > :</ p >
159
+ < div class ="highlight-bash notranslate "> < div class ="highlight "> < pre > < span > </ span > conda< span class ="w "> </ span > install< span class ="w "> </ span > wxpython< span class ="w "> </ span > diffpy.utils< span class ="w "> </ span > matplotlib-base< span class ="w "> </ span > pycifrw
160
+ pip< span class ="w "> </ span > install< span class ="w "> </ span > diffpy.pdffit2
161
+ </ pre > </ div >
162
+ </ div >
163
+ < p > Finally, we want to install PDFgui from conda-forge:</ p >
164
+ < div class ="highlight-bash notranslate "> < div class ="highlight "> < pre > < span > </ span > conda< span class ="w "> </ span > install< span class ="w "> </ span > diffpy.pdfgui< span class ="w "> </ span > --no-deps
165
+ </ pre > </ div >
166
+ </ div >
167
+ </ section >
168
+ </ section >
169
+ < section id ="running-pdfgui ">
170
+ < h2 > Running pdfgui:< a class ="headerlink " href ="#running-pdfgui " title ="Link to this heading "> ¶</ a > </ h2 >
135
171
< div class ="admonition note ">
136
172
< p class ="admonition-title "> Note</ p >
137
173
< p > To start PDFgui from a Terminal make sure < em > pdfgui_env</ em > is
0 commit comments