Sphinx docs: add pyblocxs-related modules

sherpa · Nov 8, 2018 · 7918553 · 7918553
1 parent 2d9335b
commit 7918553
Show file tree

Hide file tree

Showing 5 changed files with 143 additions and 3 deletions.
diff --git a/docs/mcmc/index.rst b/docs/mcmc/index.rst
@@ -74,8 +74,8 @@ Use an arcsinh transform to view the data, based on the work of
 ::
 
     >>> plt.imshow(np.arcsinh(msim), origin='lower', cmap='viridis',
-       ...:            extent=(x0low, x0high, x1low, x1high),
-       ...:            interpolation='nearest', aspect='auto')
+    ...            extent=(x0low, x0high, x1low, x1high),
+    ...            interpolation='nearest', aspect='auto')
     >>> plt.title('Simulated image')
 
 .. image:: ../_static/mcmc/mcmc_sim.png
@@ -218,7 +218,7 @@ Scatter plot
 ::
 
     >>> plt.scatter(pvals[0, :] - truth.r0.val,
-       ...:             pvals[4, :] - truth.alpha.val, alpha=0.3)
+    ...             pvals[4, :] - truth.alpha.val, alpha=0.3)
     >>> plt.xlabel(r'$\Delta r_0$', size=18)
     >>> plt.ylabel(r'$\Delta \alpha$', size=18)
 
@@ -237,3 +237,15 @@ This can be compared to the
     >>> plt.xlabel(r'$r_0$'); plt.ylabel(r'$\alpha$')
 
 .. image:: ../_static/mcmc/mcmc_scatter_r0_alpha_compare.png
+
+Reference/API
+=============
+
+.. toctree::
+   :maxdepth: 2
+
+   sim
+   mh
+   sample
+   simulate
+
diff --git a/docs/mcmc/mh.rst b/docs/mcmc/mh.rst
@@ -0,0 +1,33 @@
+************************
+The sherpa.sim.mh module
+************************
+
+.. currentmodule:: sherpa.sim.mh
+
+.. automodule:: sherpa.sim.mh
+
+   .. rubric:: Classes
+
+   .. autosummary::
+      :toctree: api
+
+      LimitError
+      MH
+      MetropolisMH
+      Sampler
+      Walk
+
+
+   .. rubric:: Functions
+
+   .. autosummary::
+      :toctree: api
+
+      dmvnorm
+      dmvt
+
+Class Inheritance Diagram
+=========================
+
+.. inheritance-diagram:: LimitError MetropolisMH MH Sampler Walk
+   :parts: 1
diff --git a/docs/mcmc/sample.rst b/docs/mcmc/sample.rst
@@ -0,0 +1,45 @@
+****************************
+The sherpa.sim.sample module
+****************************
+
+.. currentmodule:: sherpa.sim.sample
+
+.. automodule:: sherpa.sim.sample
+
+   .. rubric:: Classes
+
+   .. autosummary::
+      :toctree: api
+
+      NormalParameterSampleFromScaleMatrix
+      NormalParameterSampleFromScaleVector
+      NormalSampleFromScaleMatrix
+      NormalSampleFromScaleVector
+      ParameterSampleFromScaleMatrix
+      ParameterSampleFromScaleVector
+      ParameterScale
+      ParameterScaleMatrix
+      ParameterScaleVector
+      StudentTParameterSampleFromScaleMatrix
+      StudentTSampleFromScaleMatrix
+      UniformParameterSampleFromScaleVector
+      UniformSampleFromScaleVector
+
+   .. rubric:: Functions
+
+   .. autosummary::
+      :toctree: api
+
+      multivariate_t
+      multivariate_cauchy
+      normal_sample
+      uniform_sample
+      t_sample
+
+Class Inheritance Diagram
+=========================
+
+.. inheritance-diagram:: ParameterScale ParameterScaleVector ParameterScaleMatrix ParameterSampleFromScaleMatrix ParameterSampleFromScaleVector UniformParameterSampleFromScaleVector NormalParameterSampleFromScaleVector NormalParameterSampleFromScaleMatrix StudentTParameterSampleFromScaleMatrix NormalSampleFromScaleMatrix NormalSampleFromScaleVector UniformSampleFromScaleVector StudentTSampleFromScaleMatrix
+   :parts: 1
+
+
diff --git a/docs/mcmc/sim.rst b/docs/mcmc/sim.rst
@@ -0,0 +1,29 @@
+*********************
+The sherpa.sim module
+*********************
+
+.. currentmodule:: sherpa.sim
+
+.. automodule:: sherpa.sim
+
+   .. rubric:: Classes
+
+   .. autosummary::
+      :toctree: api
+
+      MCMC
+
+   .. rubric:: Functions
+
+   .. autosummary::
+      :toctree: api
+
+      flat
+      inverse
+      inverse2
+
+Class Inheritance Diagram
+=========================
+
+.. inheritance-diagram:: MCMC
+   :parts: 1
diff --git a/docs/mcmc/simulate.rst b/docs/mcmc/simulate.rst
@@ -0,0 +1,21 @@
+******************************
+The sherpa.sim.simulate module
+******************************
+
+.. currentmodule:: sherpa.sim.simulate
+
+.. automodule:: sherpa.sim.simulate
+
+   .. rubric:: Classes
+
+   .. autosummary::
+      :toctree: api
+
+      LikelihoodRatioResults
+      LikelihoodRatioTest
+
+Class Inheritance Diagram
+=========================
+
+.. inheritance-diagram:: LikelihoodRatioResults LikelihoodRatioTest
+   :parts: 1