initial commit

jgieseler · Jul 26, 2023 · 243e063 · 243e063
1 parent 000f391
commit 243e063
Show file tree

Hide file tree

Showing 9 changed files with 73 additions and 0 deletions.
diff --git a/docs/api/solarmach.SolarMACH.rst b/docs/api/solarmach.SolarMACH.rst
@@ -0,0 +1,25 @@
+SolarMACH
+=========
+
+.. currentmodule:: solarmach
+
+.. autoclass:: SolarMACH
+   :show-inheritance:
+
+   .. rubric:: Methods Summary
+
+   .. autosummary::
+
+      ~SolarMACH.backmapping
+      ~SolarMACH.pfss_3d
+      ~SolarMACH.plot
+      ~SolarMACH.plot_pfss
+      ~SolarMACH.solar_diff_rot
+
+   .. rubric:: Methods Documentation
+
+   .. automethod:: backmapping
+   .. automethod:: pfss_3d
+   .. automethod:: plot
+   .. automethod:: plot_pfss
+   .. automethod:: solar_diff_rot
diff --git a/docs/api/solarmach.calculate_pfss_solution.rst b/docs/api/solarmach.calculate_pfss_solution.rst
@@ -0,0 +1,6 @@
+calculate_pfss_solution
+=======================
+
+.. currentmodule:: solarmach
+
+.. autofunction:: calculate_pfss_solution
diff --git a/docs/api/solarmach.get_field_line_coords.rst b/docs/api/solarmach.get_field_line_coords.rst
@@ -0,0 +1,6 @@
+get_field_line_coords
+=====================
+
+.. currentmodule:: solarmach
+
+.. autofunction:: get_field_line_coords
diff --git a/docs/api/solarmach.get_gong_map.rst b/docs/api/solarmach.get_gong_map.rst
@@ -0,0 +1,6 @@
+get_gong_map
+============
+
+.. currentmodule:: solarmach
+
+.. autofunction:: get_gong_map
diff --git a/docs/api/solarmach.multicolorline.rst b/docs/api/solarmach.multicolorline.rst
@@ -0,0 +1,6 @@
+multicolorline
+==============
+
+.. currentmodule:: solarmach
+
+.. autofunction:: multicolorline
diff --git a/docs/api/solarmach.print_body_list.rst b/docs/api/solarmach.print_body_list.rst
@@ -0,0 +1,6 @@
+print_body_list
+===============
+
+.. currentmodule:: solarmach
+
+.. autofunction:: print_body_list
diff --git a/docs/api/solarmach.sphere.rst b/docs/api/solarmach.sphere.rst
@@ -0,0 +1,6 @@
+sphere
+======
+
+.. currentmodule:: solarmach
+
+.. autofunction:: sphere
diff --git a/docs/api/solarmach.spheric2cartesian.rst b/docs/api/solarmach.spheric2cartesian.rst
@@ -0,0 +1,6 @@
+spheric2cartesian
+=================
+
+.. currentmodule:: solarmach
+
+.. autofunction:: spheric2cartesian
diff --git a/docs/api/solarmach.vary_flines.rst b/docs/api/solarmach.vary_flines.rst
@@ -0,0 +1,6 @@
+vary_flines
+===========
+
+.. currentmodule:: solarmach
+
+.. autofunction:: vary_flines