instructions for including optional packages with pip installation, i…

…ssue #14
PFPE · Oct 31, 2024 · cfe9dcf · cfe9dcf
1 parent ccee7f7
commit cfe9dcf
Showing 1 changed file with 2 additions and 0 deletions.
diff --git a/shipgrav/__init__.py b/shipgrav/__init__.py
@@ -27,6 +27,8 @@
 * matplotlib (optional, needed to run some of the example scripts)
 * geographiclib (optional, needed to run one of the example scripts)
 
+If you install shipgrav with ``pip``, it will also install any of the required dependencies that are missing. To make ``pip`` include the optional dependencies, run ``pip install shipgrav[examples]``.
+
 The example scripts are `available on github <https://github.com/PFPE/shipgrav>`_. They are not packaged with the PyPI package and must be downloaded separately.
 
 Modules and files