-
Notifications
You must be signed in to change notification settings - Fork 8
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
DOC: update the installation section in the docs
- Loading branch information
Showing
1 changed file
with
37 additions
and
4 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,7 +1,40 @@ | ||
============ | ||
========================= | ||
Installation instructions | ||
========================= | ||
|
||
Installation | ||
============ | ||
------------ | ||
|
||
The package works with Python 3.8+ and can be installed from both PyPI and conda-forge. | ||
|
||
To install the package using the ``pip`` package manager, run the following command:: | ||
|
||
.. code:: bash | ||
$ python3 -m pip install bloptools | ||
To install the package using the ``conda`` package manager, run the following command:: | ||
|
||
.. code:: bash | ||
$ conda install -c conda-forge bloptools | ||
If you'd like to use the Sirepo backend and ``sirepo-bluesky`` ophyd objects, please | ||
follow the installation instructions at | ||
`https://nsls-ii.github.io/sirepo-bluesky/installation.html <https://nsls-ii.github.io/sirepo-bluesky/installation.html>`_. | ||
|
||
|
||
Run tests | ||
--------- | ||
|
||
.. code:: bash | ||
$ pytest -vv -s -x --pdb | ||
Build documentation | ||
------------------- | ||
|
||
At the command line:: | ||
.. code:: bash | ||
$ pip install bloptools | ||
$ make -C docs/ html |