First commit

docs/source/api/data.rst

@@ -0,0 +1,23 @@
+**************
+Data container
+**************
+
+.. automodule:: nmreval.data
+   :no-members:
+   :no-undoc-members:
+   
+
+.. contents:: Table of Contents
+   :depth: 3
+   :local:
+   :backlinks: entry
+
+
+.. autosummary::
+   :toctree: generated/
+   :template: autosummary.rst
+   :nosignatures:
+   
+   nmreval.data.Points
+   nmreval.data.Signal
+   nmreval.data.BDS

docs/source/api/distributions/index.rst

@@ -0,0 +1,29 @@
+*********************************
+Distribution of correlation times
+*********************************
+
+List of all implemented distributions and the associated correlation functions, spectral densities, susceptibilies
+
+.. contents:: Table of Contents
+   :depth: 3
+   :local:
+   :backlinks: entry
+
+Cole-Cole
+---------
+
+.. automodule:: nmreval.distributions.colecole
+   :members:
+
+
+Cole-Davidson
+-------------
+
+.. automodule:: nmreval.distributions.coledavidson
+   :members:
+
+Havriliak-Negami
+----------------
+
+.. automodule:: nmreval.distributions.havriliaknegami
+   :members:

docs/source/api/generated/nmreval.data.BDS.rst

@@ -0,0 +1,23 @@
+nmreval.data.BDS
+================
+
+
+.. currentmodule:: nmreval.data
+
+
+
+
+Inheritance diagram
+
+.. inheritance-diagram:: BDS
+    :parts: 1
+    
+class
+
+.. autoclass:: BDS
+    :special-members: __call__
+    :members:
+    :undoc-members:
+
+
+ 

docs/source/api/generated/nmreval.data.Points.rst

@@ -0,0 +1,23 @@
+nmreval.data.Points
+===================
+
+
+.. currentmodule:: nmreval.data
+
+
+
+
+Inheritance diagram
+
+.. inheritance-diagram:: Points
+    :parts: 1
+    
+class
+
+.. autoclass:: Points
+    :special-members: __call__
+    :members:
+    :undoc-members:
+
+
+ 

docs/source/api/generated/nmreval.data.Signal.rst

@@ -0,0 +1,23 @@
+nmreval.data.Signal
+===================
+
+
+.. currentmodule:: nmreval.data
+
+
+
+
+Inheritance diagram
+
+.. inheritance-diagram:: Signal
+    :parts: 1
+    
+class
+
+.. autoclass:: Signal
+    :special-members: __call__
+    :members:
+    :undoc-members:
+
+
+ 

docs/source/api/index.rst

@@ -0,0 +1,12 @@
+==========
+References
+==========
+
+.. toctree::
+   :caption: Table of contents
+   :maxdepth: 2
+   :glob:
+
+   data.rst
+   models/index.rst
+   distributions/index.rst

docs/source/api/models/basic.rst

@@ -0,0 +1,6 @@
+************************
+``nmreval.models.basic``
+************************
+
+.. automodule:: nmreval.models.basic
+   :members:

docs/source/api/models/index.rst

@@ -0,0 +1,31 @@
+**************
+Model function
+**************
+
+List of all implemented functions
+
+.. contents:: Table of Contents
+   :depth: 3
+   :local:
+   :backlinks: entry
+
+Basic functions
+---------------
+
+.. currentmodule:: nmreval
+
+.. autosummary::
+   :toctree:
+
+   nmreval.models.basic
+
+
+
+
+NMR relaxation functions
+------------------------
+
+.. automodule:: nmreval.models.relaxation
+   :members:
+
+

docs/source/api/models/nmreval.models.basic.rst

@@ -0,0 +1,37 @@
+nmreval.models.basic
+====================
+
+.. automodule:: nmreval.models.basic
+
+   
+   
+   
+
+   
+   
+   
+
+   
+   
+   .. rubric:: Classes
+
+   .. autosummary::
+   
+      Constant
+      ExpFunc
+      Linear
+      Log
+      MittagLeffler
+      Parabola
+      PowerLaw
+      PowerLawCross
+      Sine
+   
+   
+
+   
+   
+   
+
+
+