feat: plotting

licences/BoundClass.txt

@@ -0,0 +1,29 @@
+BSD 3-Clause License
+
+Copyright (c) 2022, Nathaniel Starkman
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this
+   list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice,
+   this list of conditions and the following disclaimer in the documentation
+   and/or other materials provided with the distribution.
+
+3. Neither the name of the copyright holder nor the names of its
+   contributors may be used to endorse or promote products derived from
+   this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

pyproject.toml

@@ -50,7 +50,7 @@ requires-python = ">=3.11"
 
 [project.optional-dependencies]
 # All runtime dependencies
-all = ["galax[interop-all]"]
+all = ["galax[interop-all,plot-all]"]
 # Interoperability dependencies
 interop-all = ["galax[interop-astropy]", "galax[interop-gala]", "galax[interop-galpy]"]
 interop-astropy = [
@@ -68,6 +68,8 @@ interop-galpy = [
   "galpy >= 1.8",
 ]
 # TODO: agama
+plot-all = ["galax[plot-matplotlib]"]
+plot-matplotlib = ["matplotlib"]
 # Documentation dependencies
 docs = [
   "sphinx>=7.0",

src/galax/__init__.py

@@ -21,11 +21,26 @@
 )
 from ._version import version as __version__, version_tuple as __version_tuple__
 
+# ---------------------------
+# Optional dependencies
+# The act of importing registers in the functionality
+
 if utils._optional_deps.HAS_ASTROPY:  # noqa: SLF001
-    from ._interop import galax_interop_astropy  # noqa: F401
+    from ._interop import galax_interop_astropy
+
+    del galax_interop_astropy
 
 if utils._optional_deps.HAS_GALA:  # noqa: SLF001
-    from ._interop import galax_interop_gala  # noqa: F401
+    from ._interop import galax_interop_gala
+
+    del galax_interop_gala
 
 if utils._optional_deps.HAS_GALPY:  # noqa: SLF001
-    from ._interop import galax_interop_galpy  # noqa: F401
+    from ._interop import galax_interop_galpy
+
+    del galax_interop_galpy
+
+if utils._optional_deps.HAS_MATPLOTLIB:  # noqa: SLF001
+    from ._interop import matplotlib
+
+    del matplotlib

src/galax/_interop/matplotlib/__init__.py

@@ -0,0 +1,6 @@
+"""Matplotlib extension for :mod:`galax`."""
+
+__all__ = ["plot_potential_contours", "plot_density_contours", "plot_rotation_curve"]
+
+from .contours import plot_density_contours, plot_potential_contours
+from .rotcurve import plot_rotation_curve