Skip to content

Commit ec32483

Browse files
authored
Optional dependencies in README (#330)
1 parent 30548c4 commit ec32483

File tree

1 file changed

+9
-0
lines changed

1 file changed

+9
-0
lines changed

README.rst

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -56,6 +56,14 @@ The SkyPy library can then be imported from python:
5656
>>> import skypy
5757
>>> help(skypy)
5858
59+
SkyPy has a number of optional dependencies which can be installed separately.
60+
One of these is `skypy-data`_ which contains data such as photometric bandpasses
61+
required for some calculations in SkyPy. This can be installed with:
62+
63+
.. code:: bash
64+
65+
pip install skypy-data@https://github.com/skypyproject/skypy-data/archive/master.tar.gz
66+
5967
SkyPy also has a driver script that can run simulation pipelines from the
6068
command line. The `skypyproject/examples`_ repository contains sample
6169
configuration files that you can clone and run:
@@ -72,6 +80,7 @@ configuration files that you can clone and run:
7280
.. _conda: https://docs.conda.io/en/latest/
7381
.. _pytest: https://docs.pytest.org/en/stable/
7482
.. _skypyproject/examples: https://github.com/skypyproject/examples
83+
.. _skypy-data: https://github.com/skypyproject/skypy-data
7584

7685

7786
Contributing

0 commit comments

Comments
 (0)