Skip to content

Commit fd0e05b

Browse files
committed
Update README with conda instructions.
1 parent dd551f4 commit fd0e05b

File tree

1 file changed

+29
-30
lines changed

1 file changed

+29
-30
lines changed

README.rst

+29-30
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ http://diffpy.github.io/diffpy.srfit.
3838
REQUIREMENTS
3939
------------------------------------------------------------------------
4040

41-
The diffpy.srfit package requires Python 2.6 or 2.7 and the following software:
41+
The diffpy.srfit package requires Python 2.7 and the following software:
4242

4343
* ``setuptools`` - software distribution tools for Python
4444
* ``NumPy`` - numerical mathematics and fast array operations for Python
@@ -63,53 +63,52 @@ sums require
6363
Optimizations involving small angle scattering or shape characteristic
6464
functions from the diffpy.srfit.sas module require
6565

66-
* ``sas.pr`` - module for calculation of P(R) in small-angle scattering
66+
* ``sas`` - module for calculation of P(R) in small-angle scattering
6767
from the SasView project, http://www.sasview.org
6868

69-
On Ubuntu Linux, the required software can easily be installed using
70-
the system package manager::
69+
We recommend to use `Anaconda Python <https://www.continuum.io/downloads>`_
70+
as it allows to install all software dependencies together with
71+
diffpy.srfit. For other Python distributions it is necessary to
72+
install the required software separately. As an example, on Ubuntu
73+
Linux some of the required software can be installed using ::
7174

7275
sudo apt-get install \
7376
python-setuptools python-numpy python-scipy python-matplotlib
7477

75-
For Mac OS X systems with the MacPorts package manager, the required
76-
software can be installed with ::
77-
78-
sudo port install \
79-
python27 py27-setuptools py27-numpy py27-scipy py27-matplotlib
80-
81-
When installing for MacPorts, make sure the MacPorts bin directory is the first
82-
in the system PATH and that python27 is selected as the default Python version
83-
in MacPorts::
84-
85-
sudo port select --set python python27
86-
8778
For other required packages see their respective web pages for installation
8879
instructions.
8980

9081

9182
INSTALLATION
9283
------------------------------------------------------------------------
9384

94-
The easiest option is to use the latest DiffPy-CMI release bundle from
95-
http://www.diffpy.org, which comes with diffpy.srfit and all other
96-
recommended software included.
85+
The preferred method is to use Anaconda Python and install from the
86+
"diffpy" channel of Anaconda packages ::
87+
88+
conda config --add channels diffpy
89+
conda install diffpy.srfit
90+
91+
diffpy.srfit is also included in the "diffpy-cmi" collection
92+
of packages for structure analysis ::
93+
94+
conda install diffpy-cmi
9795

98-
Or, use ``easy_install`` to download and install the latest release from
99-
`Python Package Index <https://pypi.python.org>`_ ::
96+
Another option is to use ``easy_install`` to download and install the
97+
latest release from `Python Package Index <https://pypi.python.org>`_ ::
10098

101-
sudo easy_install diffpy.srfit
99+
easy_install diffpy.srfit
102100

103-
If you prefer to install from sources, make sure all required software packages
104-
are in place and then run ::
101+
If you prefer to install from sources, make sure all required software
102+
packages are in place and then run ::
105103

106-
sudo python setup.py install
104+
python setup.py install
107105

108-
This installs diffpy.srfit for all users in the default system location.
109-
If administrator (root) access is not available, see the usage info from
110-
``python setup.py install --help`` for options to install to user-writable
111-
directories. The installation integrity can be verified by changing to
112-
the HOME directory and running ::
106+
You may need to use ``sudo`` with system Python so the process is
107+
allowed to put files to the system directories. If administrator (root)
108+
access is not available, consult the output from
109+
``python setup.py install --help`` for options to install to a
110+
user-writable locations. The installation integrity can be verified by
111+
changing to the HOME directory and running ::
113112

114113
python -m diffpy.srfit.tests.run
115114

0 commit comments

Comments
 (0)