Merge pull request #45 from quant-aq/dhhagan-feature-sc-2957

Re-write docs to use notebooks for guides [sc-2957]
quant-aq · Feb 19, 2022 · 972d6ac · 972d6ac
2 parents a222e28 + e37d21b
commit 972d6ac
Show file tree

Hide file tree

Showing 55 changed files with 4,335 additions and 340 deletions.
diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml
@@ -33,6 +33,7 @@ jobs:
                 source .venv/bin/activate 
                 cd docs
                 make clean
+                make guides
                 make html
                 cd ..
 

diff --git a/.gitignore b/.gitignore
@@ -1,3 +1,5 @@
+*.sav
+
 examples/ignore_this.ipynb
 examples/development_private.ipynb
 

diff --git a/README.md b/README.md
@@ -44,6 +44,7 @@ Documentation is available [here](https://quant-aq.github.io/py-smps/). Docs are
 ```sh
 $ cd docs/
 $ make clean
+$ make guides
 $ make html
 $ cd ..
 ```

diff --git a/docs/Makefile b/docs/Makefile
@@ -18,3 +18,7 @@ help:
 # "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
 %: Makefile
 	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: guides
+guides:
+	make -C guides/
diff --git a/docs/api/generated/smps.GenericParticleSizer.rst b/docs/api/generated/smps.GenericParticleSizer.rst
@@ -0,0 +1,45 @@
+smps.GenericParticleSizer
+=========================
+
+.. currentmodule:: smps
+
+.. autoclass:: GenericParticleSizer
+
+
+   .. automethod:: __init__
+
+
+   .. rubric:: Methods
+
+   .. autosummary::
+
+      ~GenericParticleSizer.__init__
+      ~GenericParticleSizer.copy
+      ~GenericParticleSizer.dump
+      ~GenericParticleSizer.integrate
+      ~GenericParticleSizer.resample
+      ~GenericParticleSizer.slice
+      ~GenericParticleSizer.stats
+
+
+
+
+
+   .. rubric:: Attributes
+
+   .. autosummary::
+
+      ~GenericParticleSizer.dddlogdp
+      ~GenericParticleSizer.dlogdp
+      ~GenericParticleSizer.dn
+      ~GenericParticleSizer.dndlogdp
+      ~GenericParticleSizer.ds
+      ~GenericParticleSizer.dsdlogdp
+      ~GenericParticleSizer.dv
+      ~GenericParticleSizer.dvdlogdp
+      ~GenericParticleSizer.midpoints
+      ~GenericParticleSizer.s_multiplier
+      ~GenericParticleSizer.scan_stats
+      ~GenericParticleSizer.v_multiplier
+
+
diff --git a/docs/api/generated/smps.fit.LogNormal.rst b/docs/api/generated/smps.fit.LogNormal.rst
@@ -0,0 +1,23 @@
+smps.fit.LogNormal
+==================
+
+.. currentmodule:: smps.fit
+
+.. autoclass:: LogNormal
+
+
+   .. automethod:: __init__
+
+
+   .. rubric:: Methods
+
+   .. autosummary::
+
+      ~LogNormal.__init__
+      ~LogNormal.fit
+
+
+
+
+
+
diff --git a/docs/api/generated/smps.fit.LogNormalFitResults.rst b/docs/api/generated/smps.fit.LogNormalFitResults.rst
@@ -0,0 +1,24 @@
+smps.fit.LogNormalFitResults
+============================
+
+.. currentmodule:: smps.fit
+
+.. autoclass:: LogNormalFitResults
+
+
+   .. automethod:: __init__
+
+
+   .. rubric:: Methods
+
+   .. autosummary::
+
+      ~LogNormalFitResults.__init__
+      ~LogNormalFitResults.predict
+      ~LogNormalFitResults.summary
+
+
+
+
+
+
diff --git a/docs/api/generated/smps.io.load_sample.rst b/docs/api/generated/smps.io.load_sample.rst
@@ -0,0 +1,6 @@
+smps.io.load\_sample
+====================
+
+.. currentmodule:: smps.io
+
+.. autofunction:: load_sample
diff --git a/docs/api/generated/smps.io.smps_from_txt.rst b/docs/api/generated/smps.io.smps_from_txt.rst
@@ -0,0 +1,6 @@
+smps.io.smps\_from\_txt
+=======================
+
+.. currentmodule:: smps.io
+
+.. autofunction:: smps_from_txt
diff --git a/docs/api/generated/smps.models.AlphasenseOPCN2.rst b/docs/api/generated/smps.models.AlphasenseOPCN2.rst
@@ -0,0 +1,45 @@
+smps.models.AlphasenseOPCN2
+===========================
+
+.. currentmodule:: smps.models
+
+.. autoclass:: AlphasenseOPCN2
+
+
+   .. automethod:: __init__
+
+
+   .. rubric:: Methods
+
+   .. autosummary::
+
+      ~AlphasenseOPCN2.__init__
+      ~AlphasenseOPCN2.copy
+      ~AlphasenseOPCN2.dump
+      ~AlphasenseOPCN2.integrate
+      ~AlphasenseOPCN2.resample
+      ~AlphasenseOPCN2.slice
+      ~AlphasenseOPCN2.stats
+
+
+
+
+
+   .. rubric:: Attributes
+
+   .. autosummary::
+
+      ~AlphasenseOPCN2.dddlogdp
+      ~AlphasenseOPCN2.dlogdp
+      ~AlphasenseOPCN2.dn
+      ~AlphasenseOPCN2.dndlogdp
+      ~AlphasenseOPCN2.ds
+      ~AlphasenseOPCN2.dsdlogdp
+      ~AlphasenseOPCN2.dv
+      ~AlphasenseOPCN2.dvdlogdp
+      ~AlphasenseOPCN2.midpoints
+      ~AlphasenseOPCN2.s_multiplier
+      ~AlphasenseOPCN2.scan_stats
+      ~AlphasenseOPCN2.v_multiplier
+
+
diff --git a/docs/api/generated/smps.models.AlphasenseOPCN3.rst b/docs/api/generated/smps.models.AlphasenseOPCN3.rst
@@ -0,0 +1,45 @@
+smps.models.AlphasenseOPCN3
+===========================
+
+.. currentmodule:: smps.models
+
+.. autoclass:: AlphasenseOPCN3
+
+
+   .. automethod:: __init__
+
+
+   .. rubric:: Methods
+
+   .. autosummary::
+
+      ~AlphasenseOPCN3.__init__
+      ~AlphasenseOPCN3.copy
+      ~AlphasenseOPCN3.dump
+      ~AlphasenseOPCN3.integrate
+      ~AlphasenseOPCN3.resample
+      ~AlphasenseOPCN3.slice
+      ~AlphasenseOPCN3.stats
+
+
+
+
+
+   .. rubric:: Attributes
+
+   .. autosummary::
+
+      ~AlphasenseOPCN3.dddlogdp
+      ~AlphasenseOPCN3.dlogdp
+      ~AlphasenseOPCN3.dn
+      ~AlphasenseOPCN3.dndlogdp
+      ~AlphasenseOPCN3.ds
+      ~AlphasenseOPCN3.dsdlogdp
+      ~AlphasenseOPCN3.dv
+      ~AlphasenseOPCN3.dvdlogdp
+      ~AlphasenseOPCN3.midpoints
+      ~AlphasenseOPCN3.s_multiplier
+      ~AlphasenseOPCN3.scan_stats
+      ~AlphasenseOPCN3.v_multiplier
+
+
diff --git a/docs/api/generated/smps.models.GenericParticleSizer.rst b/docs/api/generated/smps.models.GenericParticleSizer.rst
@@ -0,0 +1,45 @@
+smps.models.GenericParticleSizer
+================================
+
+.. currentmodule:: smps.models
+
+.. autoclass:: GenericParticleSizer
+
+
+   .. automethod:: __init__
+
+
+   .. rubric:: Methods
+
+   .. autosummary::
+
+      ~GenericParticleSizer.__init__
+      ~GenericParticleSizer.copy
+      ~GenericParticleSizer.dump
+      ~GenericParticleSizer.integrate
+      ~GenericParticleSizer.resample
+      ~GenericParticleSizer.slice
+      ~GenericParticleSizer.stats
+
+
+
+
+
+   .. rubric:: Attributes
+
+   .. autosummary::
+
+      ~GenericParticleSizer.dddlogdp
+      ~GenericParticleSizer.dlogdp
+      ~GenericParticleSizer.dn
+      ~GenericParticleSizer.dndlogdp
+      ~GenericParticleSizer.ds
+      ~GenericParticleSizer.dsdlogdp
+      ~GenericParticleSizer.dv
+      ~GenericParticleSizer.dvdlogdp
+      ~GenericParticleSizer.midpoints
+      ~GenericParticleSizer.s_multiplier
+      ~GenericParticleSizer.scan_stats
+      ~GenericParticleSizer.v_multiplier
+
+
diff --git a/docs/api/generated/smps.models.Grimm11D.rst b/docs/api/generated/smps.models.Grimm11D.rst
@@ -0,0 +1,45 @@
+smps.models.Grimm11D
+====================
+
+.. currentmodule:: smps.models
+
+.. autoclass:: Grimm11D
+
+
+   .. automethod:: __init__
+
+
+   .. rubric:: Methods
+
+   .. autosummary::
+
+      ~Grimm11D.__init__
+      ~Grimm11D.copy
+      ~Grimm11D.dump
+      ~Grimm11D.integrate
+      ~Grimm11D.resample
+      ~Grimm11D.slice
+      ~Grimm11D.stats
+
+
+
+
+
+   .. rubric:: Attributes
+
+   .. autosummary::
+
+      ~Grimm11D.dddlogdp
+      ~Grimm11D.dlogdp
+      ~Grimm11D.dn
+      ~Grimm11D.dndlogdp
+      ~Grimm11D.ds
+      ~Grimm11D.dsdlogdp
+      ~Grimm11D.dv
+      ~Grimm11D.dvdlogdp
+      ~Grimm11D.midpoints
+      ~Grimm11D.s_multiplier
+      ~Grimm11D.scan_stats
+      ~Grimm11D.v_multiplier
+
+
diff --git a/docs/api/generated/smps.models.Modulair.rst b/docs/api/generated/smps.models.Modulair.rst
@@ -0,0 +1,45 @@
+smps.models.Modulair
+====================
+
+.. currentmodule:: smps.models
+
+.. autoclass:: Modulair
+
+
+   .. automethod:: __init__
+
+
+   .. rubric:: Methods
+
+   .. autosummary::
+
+      ~Modulair.__init__
+      ~Modulair.copy
+      ~Modulair.dump
+      ~Modulair.integrate
+      ~Modulair.resample
+      ~Modulair.slice
+      ~Modulair.stats
+
+
+
+
+
+   .. rubric:: Attributes
+
+   .. autosummary::
+
+      ~Modulair.dddlogdp
+      ~Modulair.dlogdp
+      ~Modulair.dn
+      ~Modulair.dndlogdp
+      ~Modulair.ds
+      ~Modulair.dsdlogdp
+      ~Modulair.dv
+      ~Modulair.dvdlogdp
+      ~Modulair.midpoints
+      ~Modulair.s_multiplier
+      ~Modulair.scan_stats
+      ~Modulair.v_multiplier
+
+