add documents

Analyser/FitAnalyser.py

@@ -475,6 +475,9 @@ lmfit_models = {'Constant': ConstantModel,
                 'Expansion':ExpansionModel,
                 'Damping Oscillation Model':DampingOscillationModel,
                 'Two Gaussian-2D':TwoGaussian2dModel,
+                'Thomas Fermi-2D': ThomasFermi2dModel,
+                'Density Profile of BEC-2D': DensityProfileBEC2dModel,
+                'Polylog2-2D': polylog2_2d, 
                 }
 
 

docs/HowTo.rst

@@ -0,0 +1,10 @@
+How to 
+=========================================
+
+.. toctree::
+    :maxdepth: 2
+    
+    HowToReadHDF5
+    HowToCalculateAbsorptionImaging
+    HowToSelectData
+    HowToFit

docs/HowToCalculateAbsorptionImaging.nblink

@@ -0,0 +1,3 @@
+{
+    "path": "../Example/CalculateAbsorptionImaging.ipynb"
+}

docs/HowToFit.nblink

@@ -0,0 +1,3 @@
+{
+    "path": "../Example/FitData.ipynb"
+}

docs/HowToReadHDF5.nblink

@@ -0,0 +1,3 @@
+{
+    "path": "../Example/ReadHDF5.ipynb"
+}

docs/HowToSelectData.nblink

@@ -0,0 +1,3 @@
+{
+    "path": "../Example/IndexSliceData.ipynb"
+}

docs/conf.py

@@ -7,6 +7,7 @@
 import os
 import sys
 sys.path.insert(0, os.path.abspath('..'))
+sys.path.insert(0, os.path.abspath('../Example'))
 
 # -- Project information -----------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
@@ -20,7 +21,7 @@ release = '0.5'
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
 
 extensions = ['sphinx.ext.autodoc', 'sphinx.ext.coverage', 'sphinx.ext.napoleon',
-              'nbsphinx']
+              'nbsphinx', 'nbsphinx_link']
 
 templates_path = ['_templates']
 exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']

docs/index.rst

@@ -9,6 +9,7 @@ Welcome to DyLab Data Cruncher's documentation!
 .. toctree::
    :maxdepth: 2
 
+   HowTo.rst
    API.rst
 
 Indices and tables