diff --git a/docs/source/installation.rst b/docs/source/installation.rst index 0c10185..4e25fcc 100644 --- a/docs/source/installation.rst +++ b/docs/source/installation.rst @@ -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 `_. + + +Run tests +--------- + +.. code:: bash + + $ pytest -vv -s -x --pdb + + +Build documentation +------------------- -At the command line:: +.. code:: bash - $ pip install bloptools + $ make -C docs/ html