Skip to content

Commit c919b31

Browse files
committed
chore: update installation instructions in readme
1 parent 80783da commit c919b31

File tree

1 file changed

+24
-3
lines changed

1 file changed

+24
-3
lines changed

README.rst

Lines changed: 24 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -63,12 +63,33 @@ by citing the following paper in your publication:
6363
Installation
6464
------------
6565

66-
The preferred method is to be installed with `xpdfsuite` package or the wheel file.
66+
The preferred method is to use `Miniconda Python
67+
<https://docs.conda.io/projects/miniconda/en/latest/miniconda-install.html>`_
68+
and install from the "conda-forge" channel of Conda packages.
6769

68-
To install the package with the wheel file, you can first download the wheel file, then type
70+
To add "conda-forge" to the conda channels, run the following in a terminal. ::
6971

70-
`pip install /path/to/diffpy.srxplanar-X.Y.Z-py3-none-any.whl`.
72+
conda config --add channels conda-forge
7173

74+
We want to install our packages in a suitable conda environment.
75+
The following creates and activates a new environment named ``diffpy.srxplanar_env`` ::
76+
77+
conda create -n diffpy.srxplanar_env diffpy.srxplanar
78+
conda activate diffpy.srxplanar_env
79+
80+
The output should print the latest version displayed on the badges above.
81+
82+
If the above does not work, you can use ``pip`` to download and install the latest release from
83+
`Python Package Index <https://pypi.python.org>`_.
84+
To install using ``pip`` into your ``diffpy.srxplanar_env`` environment, type ::
85+
86+
pip install diffpy.srxplanar
87+
88+
If you prefer to install from sources, after installing the dependencies, obtain the source archive from
89+
`GitHub <https://github.com/diffpy/diffpy.srxplanar/>`_. Once installed, ``cd`` into your ``diffpy.srxplanar`` directory
90+
and run the following ::
91+
92+
pip install .
7293

7394
This package also provides command-line utilities. To check the software has been installed correctly, type ::
7495

0 commit comments

Comments
 (0)