Skip to content

Commit bc819cf

Browse files
committed
Update installation instructions in README file.
Suggest installing with conda. Remove Mac Ports instructions.
1 parent 407896c commit bc819cf

File tree

1 file changed

+22
-26
lines changed

1 file changed

+22
-26
lines changed

Diff for: README.rst

+22-26
Original file line numberDiff line numberDiff line change
@@ -32,43 +32,39 @@ The functions in diffpy.utils.wx module require
3232

3333
* ``wxPython`` - GUI toolkit for the Python language
3434

35-
Some of the required software packages may be available in the system package
36-
manager, for example, on Ubuntu Linux the dependencies can be installed as::
35+
We recommend to use `Anaconda Python <https://www.continuum.io/downloads>`_
36+
as it allows to install the software dependencies together with
37+
diffpy.utils. For other Python distributions it is necessary to install
38+
the required software separately. As an example, on Ubuntu Linux the
39+
required software can be installed with ::
3740

3841
sudo apt-get install python-setuptools python-numpy
3942

40-
For Mac OS X systems with the MacPorts package manager one could do ::
41-
42-
sudo port install python27 py27-setuptools py27-numpy
43-
44-
When installing for MacPorts, make sure the MacPorts bin directory is the
45-
first in the system PATH and that python27 is selected as the default
46-
Python version in MacPorts::
47-
48-
sudo port select --set python python27
49-
50-
For other required packages see their respective web pages for installation
51-
instructions.
52-
5343

5444
INSTALLATION
5545
------------------------------------------------------------------------
5646

57-
Use ``easy_install`` to download and install the latest release from
58-
`Python Package Index <https://pypi.python.org>`_ ::
47+
The preferred method is to use Anaconda Python and install from the
48+
"diffpy" channel of Anaconda packages ::
49+
50+
conda config --add channels diffpy
51+
conda install diffpy.utils
52+
53+
Another option is to use ``easy_install`` to download and install the
54+
latest release from `Python Package Index <https://pypi.python.org>`_ ::
5955

60-
sudo easy_install diffpy.utils
56+
easy_install diffpy.utils
6157

62-
If you prefer to install from sources, make sure all required software
63-
packages are in place and then run ::
58+
If you prefer to install from sources, obtain the source archive and
59+
run ::
6460

65-
sudo python setup.py install
61+
python setup.py install
6662

67-
This installs diffpy.util for all users in the default system location.
68-
If administrator (root) access is not available, see the usage info from
69-
``python setup.py install --help`` for options to install to user-writable
70-
directories. The installation integrity can be verified by changing to
71-
the HOME directory and running ::
63+
You may need to use ``sudo`` with system Python as it attempts to
64+
install to standard system directories. If sudo is not available, check
65+
the usage info from ``python setup.py install --help`` for options to
66+
install to user-writable locations. The installation integrity can be
67+
verified by changing to the HOME directory and running ::
7268

7369
python -m diffpy.utils.tests.run
7470

0 commit comments

Comments
 (0)