freegs-plasma · bendudson · Mar 18, 2023 · Mar 17, 2023 · Mar 17, 2023 · Mar 17, 2023
diff --git a/.gitignore b/.gitignore
@@ -13,3 +13,4 @@ dist/
 venv
 freegs/_version.py
 asv_bench/.asv/
+docs/_build
diff --git a/docs/api/freegs.boundary.rst b/docs/api/freegs.boundary.rst
@@ -0,0 +1,7 @@
+freegs.boundary module
+======================
+
+.. automodule:: freegs.boundary
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/api/freegs.coil.rst b/docs/api/freegs.coil.rst
@@ -0,0 +1,7 @@
+freegs.coil module
+==================
+
+.. automodule:: freegs.coil
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/api/freegs.control.rst b/docs/api/freegs.control.rst
@@ -0,0 +1,7 @@
+freegs.control module
+=====================
+
+.. automodule:: freegs.control
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/api/freegs.critical.rst b/docs/api/freegs.critical.rst
@@ -0,0 +1,7 @@
+freegs.critical module
+======================
+
+.. automodule:: freegs.critical
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/api/freegs.divgeo.rst b/docs/api/freegs.divgeo.rst
@@ -0,0 +1,7 @@
+freegs.divgeo module
+====================
+
+.. automodule:: freegs.divgeo
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/api/freegs.dump.rst b/docs/api/freegs.dump.rst
@@ -0,0 +1,7 @@
+freegs.dump module
+==================
+
+.. automodule:: freegs.dump
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/api/freegs.equilibrium.rst b/docs/api/freegs.equilibrium.rst
@@ -0,0 +1,7 @@
+freegs.equilibrium module
+=========================
+
+.. automodule:: freegs.equilibrium
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/api/freegs.fieldtracer.rst b/docs/api/freegs.fieldtracer.rst
@@ -0,0 +1,7 @@
+freegs.fieldtracer module
+=========================
+
+.. automodule:: freegs.fieldtracer
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/api/freegs.filament_coil.rst b/docs/api/freegs.filament_coil.rst
@@ -0,0 +1,7 @@
+freegs.filament\_coil module
+============================
+
+.. automodule:: freegs.filament_coil
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/api/freegs.geqdsk.rst b/docs/api/freegs.geqdsk.rst
@@ -0,0 +1,7 @@
+freegs.geqdsk module
+====================
+
+.. automodule:: freegs.geqdsk
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/api/freegs.gradshafranov.rst b/docs/api/freegs.gradshafranov.rst
@@ -0,0 +1,7 @@
+freegs.gradshafranov module
+===========================
+
+.. automodule:: freegs.gradshafranov
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/api/freegs.jtor.rst b/docs/api/freegs.jtor.rst
@@ -0,0 +1,7 @@
+freegs.jtor module
+==================
+
+.. automodule:: freegs.jtor
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/api/freegs.machine.rst b/docs/api/freegs.machine.rst
@@ -0,0 +1,7 @@
+freegs.machine module
+=====================
+
+.. automodule:: freegs.machine
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/api/freegs.multi_coil.rst b/docs/api/freegs.multi_coil.rst
@@ -0,0 +1,7 @@
+freegs.multi\_coil module
+=========================
+
+.. automodule:: freegs.multi_coil
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/api/freegs.multigrid.rst b/docs/api/freegs.multigrid.rst
@@ -0,0 +1,7 @@
+freegs.multigrid module
+=======================
+
+.. automodule:: freegs.multigrid
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/api/freegs.optimise.rst b/docs/api/freegs.optimise.rst
@@ -0,0 +1,7 @@
+freegs.optimise module
+======================
+
+.. automodule:: freegs.optimise
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/api/freegs.optimiser.rst b/docs/api/freegs.optimiser.rst
@@ -0,0 +1,7 @@
+freegs.optimiser module
+=======================
+
+.. automodule:: freegs.optimiser
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/api/freegs.picard.rst b/docs/api/freegs.picard.rst
@@ -0,0 +1,7 @@
+freegs.picard module
+====================
+
+.. automodule:: freegs.picard
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/api/freegs.plotting.rst b/docs/api/freegs.plotting.rst
@@ -0,0 +1,7 @@
+freegs.plotting module
+======================
+
+.. automodule:: freegs.plotting
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/api/freegs.polygons.rst b/docs/api/freegs.polygons.rst
@@ -0,0 +1,7 @@
+freegs.polygons module
+======================
+
+.. automodule:: freegs.polygons
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/api/freegs.pre_calc_coil.rst b/docs/api/freegs.pre_calc_coil.rst
@@ -0,0 +1,7 @@
+freegs.pre\_calc\_coil module
+=============================
+
+.. automodule:: freegs.pre_calc_coil
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/api/freegs.quadrature.rst b/docs/api/freegs.quadrature.rst
@@ -0,0 +1,7 @@
+freegs.quadrature module
+========================
+
+.. automodule:: freegs.quadrature
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/api/freegs.rst b/docs/api/freegs.rst
@@ -0,0 +1,50 @@
+freegs package
+==============
+
+.. automodule:: freegs
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Submodules
+----------
+
+.. toctree::
+   :maxdepth: 4
+
+   freegs.boundary
+   freegs.coil
+   freegs.control
+   freegs.critical
+   freegs.divgeo
+   freegs.dump
+   freegs.equilibrium
+   freegs.fieldtracer
+   freegs.filament_coil
+   freegs.geqdsk
+   freegs.gradshafranov
+   freegs.jtor
+   freegs.machine
+   freegs.multi_coil
+   freegs.multigrid
+   freegs.optimise
+   freegs.optimiser
+   freegs.picard
+   freegs.plotting
+   freegs.polygons
+   freegs.pre_calc_coil
+   freegs.quadrature
+   freegs.shaped_coil
+   freegs.test_critical
+   freegs.test_equilibrium
+   freegs.test_filament_coil
+   freegs.test_jtor
+   freegs.test_linearsolve
+   freegs.test_machine
+   freegs.test_optimise
+   freegs.test_optimiser
+   freegs.test_polygons
+   freegs.test_quadrature
+   freegs.test_readwrite
+   freegs.test_sensors
+   freegs.test_shaped_coil
diff --git a/docs/api/freegs.shaped_coil.rst b/docs/api/freegs.shaped_coil.rst
@@ -0,0 +1,7 @@
+freegs.shaped\_coil module
+==========================
+
+.. automodule:: freegs.shaped_coil
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/api/freegs.test_critical.rst b/docs/api/freegs.test_critical.rst
@@ -0,0 +1,7 @@
+freegs.test\_critical module
+============================
+
+.. automodule:: freegs.test_critical
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/api/freegs.test_equilibrium.rst b/docs/api/freegs.test_equilibrium.rst
@@ -0,0 +1,7 @@
+freegs.test\_equilibrium module
+===============================
+
+.. automodule:: freegs.test_equilibrium
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/api/freegs.test_filament_coil.rst b/docs/api/freegs.test_filament_coil.rst
@@ -0,0 +1,7 @@
+freegs.test\_filament\_coil module
+==================================
+
+.. automodule:: freegs.test_filament_coil
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/api/freegs.test_jtor.rst b/docs/api/freegs.test_jtor.rst
@@ -0,0 +1,7 @@
+freegs.test\_jtor module
+========================
+
+.. automodule:: freegs.test_jtor
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/api/freegs.test_linearsolve.rst b/docs/api/freegs.test_linearsolve.rst
@@ -0,0 +1,7 @@
+freegs.test\_linearsolve module
+===============================
+
+.. automodule:: freegs.test_linearsolve
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/api/freegs.test_machine.rst b/docs/api/freegs.test_machine.rst
@@ -0,0 +1,7 @@
+freegs.test\_machine module
+===========================
+
+.. automodule:: freegs.test_machine
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/api/freegs.test_optimise.rst b/docs/api/freegs.test_optimise.rst
@@ -0,0 +1,7 @@
+freegs.test\_optimise module
+============================
+
+.. automodule:: freegs.test_optimise
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/api/freegs.test_optimiser.rst b/docs/api/freegs.test_optimiser.rst
@@ -0,0 +1,7 @@
+freegs.test\_optimiser module
+=============================
+
+.. automodule:: freegs.test_optimiser
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/api/freegs.test_polygons.rst b/docs/api/freegs.test_polygons.rst
@@ -0,0 +1,7 @@
+freegs.test\_polygons module
+============================
+
+.. automodule:: freegs.test_polygons
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/api/freegs.test_quadrature.rst b/docs/api/freegs.test_quadrature.rst
@@ -0,0 +1,7 @@
+freegs.test\_quadrature module
+==============================
+
+.. automodule:: freegs.test_quadrature
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/api/freegs.test_readwrite.rst b/docs/api/freegs.test_readwrite.rst
@@ -0,0 +1,7 @@
+freegs.test\_readwrite module
+=============================
+
+.. automodule:: freegs.test_readwrite
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/api/freegs.test_sensors.rst b/docs/api/freegs.test_sensors.rst
@@ -0,0 +1,7 @@
+freegs.test\_sensors module
+===========================
+
+.. automodule:: freegs.test_sensors
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/api/freegs.test_shaped_coil.rst b/docs/api/freegs.test_shaped_coil.rst
@@ -0,0 +1,7 @@
+freegs.test\_shaped\_coil module
+================================
+
+.. automodule:: freegs.test_shaped_coil
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/api/modules.rst b/docs/api/modules.rst
@@ -0,0 +1,7 @@
+freegs
+======
+
+.. toctree::
+   :maxdepth: 4
+
+   freegs