Comments in __init__.py

PolarWandering · Oct 18, 2023 · 646b0a9 · 646b0a9
1 parent c0703e0
commit 646b0a9
Showing 1 changed file with 6 additions and 3 deletions.
diff --git a/smpsite/smpsite/__init__.py b/smpsite/smpsite/__init__.py
@@ -1,12 +1,15 @@
 """
 Set of tools for the sampling of paleomagnetic data
 
-This includes:
-    - 
+This includes the following modules:
+    - .kappa       : Calculation of parameters of the Fisher distribution
+    - .sampling    : Random sampling of paleopoles and samples in the sphere simulating a paleomagnetic study
+    - .estimate    : Estimation of paleopole using Fisher means and secular variation
+    - .theoretical : Theoretical calculations based on (Sapienza et al 2023)
 """
 
 __version__ = "1.0.0"
-__all__ = ["estimate", "sampling", "kappa"]
+__all__ = ["estimate", "sampling", "kappa", "theoretical"]
 
 from .kappa import *
 from .sampling import *