Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 6 additions & 3 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -68,16 +68,19 @@ The following creates and activates a new environment named ``pdfbl.sequential_e

The output should print the latest version displayed on the badges above.

If the above does not work, you can use ``pip`` to download and install the latest release from
`Python Package Index <https://pypi.python.org>`_.
To install using ``pip`` into your ``pdfbl.sequential_env`` environment, type ::
You can also use ``pip`` to download and install the latest release from
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Install diffpy.cmi dependency first.

`Python Package Index <https://pypi.python.org>`_ in your environment.
But you would still need to install the dependency ``diffpy.cmi`` using
``conda`` first ::

conda install diffpy.cmi
pip install pdfbl.sequential

If you prefer to install from sources, after installing the dependencies, obtain the source archive from
`GitHub <https://github.com/pdf-bl/pdfbl.sequential/>`_. Once installed, ``cd`` into your ``pdfbl.sequential`` directory
and run the following ::

conda install diffpy.cmi
pip install .

This package also provides command-line utilities. To check the software has been installed correctly, type ::
Expand Down
23 changes: 23 additions & 0 deletions news/installation-instruction.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
**Added:**

* Modify installation instruction for dependencies.

**Changed:**

* <news item>

**Deprecated:**

* <news item>

**Removed:**

* <news item>

**Fixed:**

* <news item>

**Security:**

* <news item>
6 changes: 5 additions & 1 deletion requirements/pip.txt
Original file line number Diff line number Diff line change
@@ -1,2 +1,6 @@
numpy
diffpy.cmi
scipy
prompt_toolkit
bg-mpl-stylesheets
psutil
matplotlib
Loading