Merge pull request #33 from martinvonk/object

Create Standardized Index class
martinvonk · Mar 13, 2024 · ef05194 · ef05194
2 parents 59e6667 + b4f2bf4
commit ef05194
Show file tree

Hide file tree

Showing 10 changed files with 900 additions and 1,056 deletions.
diff --git a/doc/examples/example01_indices.ipynb b/doc/examples/example01_indices.ipynb
diff --git a/doc/examples/example02_distributions.ipynb b/doc/examples/example02_distributions.ipynb
diff --git a/doc/examples/example03_drought_NL.ipynb b/doc/examples/example03_drought_NL.ipynb
diff --git a/doc/examples/example04_package_comparison.ipynb b/doc/examples/example04_package_comparison.ipynb
@@ -28,7 +28,9 @@
     "import pastas as ps\n",
     "import pandas as pd\n",
     "import scipy.stats as scs\n",
-    "import matplotlib.pyplot as plt"
+    "import matplotlib.pyplot as plt\n",
+    "\n",
+    "print(si.show_versions())"
    ]
   },
   {
@@ -128,7 +130,7 @@
     }
    ],
    "source": [
-    "spi = si.spi(prec_rsum, dist=scs.gamma, prob_zero=True, freq=\"ME\")\n",
+    "spi = si.spi(prec_rsum, dist=scs.gamma, prob_zero=True, fit_freq=\"ME\")\n",
     "spi  # pandas Series"
    ]
   },
@@ -449,7 +451,7 @@
     "    parse_dates=True,\n",
     ").squeeze()\n",
     "\n",
-    "sgi = si.sgi(head, freq=\"ME\")\n",
+    "sgi = si.sgi(head, fit_freq=\"ME\")\n",
     "sgi_pastas = ps.stats.sgi(head)"
    ]
   },

diff --git a/src/spei/__init__.py b/src/spei/__init__.py
@@ -1,4 +1,4 @@
 # flake8: noqa
 from . import climdex, dist, plot, si, utils
 from ._version import __version__, show_versions
-from .si import sgi, spei, spi, ssfi
+from .si import SI, sgi, spei, spi, ssfi
diff --git a/src/spei/_version.py b/src/spei/_version.py
@@ -4,7 +4,7 @@
 __version__ = "0.4.0"
 
 
-def show_versions() -> None:
+def show_versions() -> str:
     msg = f"Versions\npython: {python_version()}\nspei: {__version__}\n"
 
     requirements = metadata.requires("spei")