BayesicFitting

Model Fitting and Evidence Calculation

View project on GitHub

 

Reference Manual

The reference manual for BayesicFitting contains documentation on all classes and on the methods pertaining to the clases. Almost all software of BayesicFitting is in the form of classes: Models, Fitters etc.

All classes are listed under the dropdown button "Contents". Selecting one presents a reference manual page for that class.

Each reference page contains pink headers for the class and its constructor and subsequently light-green header lines for all its public methods. At the end, the inherited methods are presented, headed by a pink line with the class they are defined in.

In a Python session they are called as:

## import some class
from BayesicFitting import SomeClass
## construct an instantiation of SomeClass
sc = SomeClass( some, arguments )
## assign an attribute of the class
a = sc.someAttribute
## run a method of the class
r = sc.someMethod( more, arguments )

Documentation on classes, methods, arguments and attributes are found in this reference manual.