1
0
forked from IPKM/nmreval

doc added; reading of isochronal bds

This commit is contained in:
dominik
2022-03-22 20:07:59 +01:00
parent a222072b28
commit 6cd630245c
89 changed files with 41178 additions and 973 deletions

5
doc/source/api/data.rst Normal file
View File

@ -0,0 +1,5 @@
.. automodule:: nmreval.data
:no-members:
:no-inherited-members:
:no-special-members:

View File

@ -0,0 +1,4 @@
.. automodule:: nmreval.distributions
:no-members:
:no-inherited-members:
:no-special-members:

View File

@ -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:

13
doc/source/api/index.rst Normal file
View File

@ -0,0 +1,13 @@
=========
Reference
=========
.. toctree::
:caption: Table of contents
:maxdepth: 1
:glob:
data
models
distributions
nmr

View File

@ -0,0 +1,4 @@
.. automodule:: nmreval.models
:no-members:
:no-inherited-members:
:no-special-members:

View File

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

View File

@ -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:

View File

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

4
doc/source/api/nmr.rst Normal file
View File

@ -0,0 +1,4 @@
.. automodule:: nmreval.nmr
:no-members:
:no-inherited-members:
:no-special-members: