Skip to content

Commit 86994f4

Browse files
authored
Merge pull request #67 from Tieqiong/readme
README requirement
2 parents 3a8ab08 + 5635ff4 commit 86994f4

File tree

2 files changed

+22
-19
lines changed

2 files changed

+22
-19
lines changed

.github/workflows/pre-commit.yml

Lines changed: 0 additions & 19 deletions
This file was deleted.

README.rst

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -63,6 +63,28 @@ by citing the following paper in your publication:
6363
<http://dx.doi.org/10.1107/S2053273315014473>`__,
6464
*Acta Crystallogr. A* **71**, 562-568 (2015).
6565

66+
Requirements
67+
------------------------------------------------------------------------
68+
69+
The diffpy.structure package requires Python 3.7 or later or 2.7 and
70+
the following software:
71+
72+
* ``setuptools`` - software distribution tools for Python
73+
* ``NumPy`` - numerical mathematics and fast array operations for Python
74+
75+
We recommend to use `Anaconda Python <https://www.anaconda.com/download>`_
76+
as it allows to install all software dependencies together with
77+
diffpy.structure. For other Python distributions it is necessary to
78+
install the required software separately. As an example on Ubuntu
79+
Linux the required software can be installed with ::
80+
81+
sudo aptitude install python3-setuptools python3-numpy
82+
83+
diffpy.structure also uses the
84+
`PyCifRW <https://bitbucket.org/jamesrhester/pycifrw>`_
85+
library, which is automatically deployed during the
86+
installation process.
87+
6688
Installation
6789
------------
6890

0 commit comments

Comments
 (0)