Skip to content

Commit

Permalink
DOC: update the installation section in the docs
Browse files Browse the repository at this point in the history
  • Loading branch information
mrakitin committed Aug 11, 2023
1 parent 565caf3 commit b49ce3e
Showing 1 changed file with 37 additions and 4 deletions.
41 changes: 37 additions & 4 deletions docs/source/installation.rst
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

0 comments on commit b49ce3e

Please sign in to comment.