Skip to content

Commit 59d4849

Browse files
committed
Update installation instructions in README file.
Recommend installation with conda. Mention diffpy-cmi. Remove Mac Ports instructions.
1 parent 11d52b5 commit 59d4849

File tree

1 file changed

+31
-34
lines changed

1 file changed

+31
-34
lines changed

README.rst

Lines changed: 31 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -19,10 +19,8 @@ symmetry expansion from asymmetric unit and generation of symmetry
1919
constraints for atom positions and displacement parameters. diffpy.Structure
2020
includes definitions of all space groups in over 500 symmetry settings.
2121

22-
To learn more about diffpy.Structure library, see the
23-
`examples <https://github.com/diffpy/diffpy.Structure/tree/master/examples>`__
24-
in the source repository and the user manual at
25-
http://diffpy.github.io/diffpy.Structure.
22+
To learn more about diffpy.Structure library see the
23+
user manual at http://diffpy.github.io/diffpy.Structure.
2624

2725

2826
REQUIREMENTS
@@ -33,51 +31,50 @@ The diffpy.Structure requires Python 2.6 or 2.7 and the following software:
3331
* ``setuptools`` - software distribution tools for Python
3432
* ``NumPy`` - numerical mathematics and fast array operations for Python
3533

36-
On Ubuntu Linux the required software can be easily installed using
37-
the system package manager::
34+
We recommend to use `Anaconda Python <https://www.continuum.io/downloads>`_
35+
as it allows to install all software dependencies together with
36+
diffpy.Structure. For other Python distributions it is necessary to
37+
install the required software separately. As an example on Ubuntu
38+
Linux the required software can be installed with ::
3839

3940
sudo aptitude install python-setuptools python-numpy
4041

41-
For Mac OS X machine with the MacPorts package manager the installation
42-
command is ::
42+
diffpy.Structure also uses the
43+
`PyCifRW <https://bitbucket.org/jamesrhester/pycifrw>`_
44+
library, which is automatically deployed during the
45+
installation process.
4346

44-
sudo port install python27 py27-setuptools py27-numpy
4547

46-
When installing with MacPorts, make sure the MacPorts bin directory is the
47-
first in the system PATH and that python27 is selected as the default
48-
Python version in MacPorts::
48+
INSTALLATION
49+
------------------------------------------------------------------------
4950

50-
sudo port select --set python python27
51+
The preferred method is to use Anaconda Python and install from the
52+
"diffpy" channel of Anaconda packages ::
5153

52-
For other Linux distributions use their respective package manager; note
53-
the packages may have slightly different names. diffpy.Structure depends
54-
also on the `PyCifRW <http://pycifrw.berlios.de>`_ library, which should
55-
get automatically deployed as a part of the installation process.
54+
conda config --add channels diffpy
55+
conda install diffpy.structure
5656

57+
diffpy.Structure is also included in the "diffpy-cmi" collection
58+
of packages for structure analysis ::
5759

58-
INSTALLATION
59-
------------------------------------------------------------------------
60+
conda install diffpy-cmi
6061

61-
Use ``easy_install`` to download and install the latest release from
62+
Another installation option is to use ``easy_install`` to download and
63+
install the latest release from
6264
`Python Package Index <https://pypi.python.org>`_ ::
6365

64-
sudo easy_install diffpy.Structure
65-
66-
diffpy.Structure is also included in the DiffPy-CMI release bundle of
67-
Python libraries for structure analysis at http://www.diffpy.org.
66+
easy_install diffpy.Structure
6867

69-
If you prefer to install from sources, make sure all required software
70-
packages are in place and then run ::
68+
If you prefer to install from sources, navigate to the source archive
69+
directory and run ::
7170

72-
sudo python setup.py install
71+
python setup.py install
7372

74-
By default the files are installed in the system directories, which are
75-
only writeable by the root user. See the usage info from
76-
``./setup.py install --help`` for options to install as a normal user under
77-
different location. Note that installation to non-standard directories may
78-
require adjustments to the PATH and PYTHONPATH environment variables.
79-
The installation integrity can be verified by changing to the HOME
80-
directory and running ::
73+
You may need to use ``sudo`` with system Python so it is allowed to
74+
copy files to system directories. If sudo is not available, check
75+
the usage info from ``python setup.py install --help`` for options to
76+
install to user-writable locations. The installation integrity can be
77+
verified by changing to the HOME directory and running ::
8178

8279
python -m diffpy.Structure.tests.run
8380

0 commit comments

Comments
 (0)