emgfit API docs
===============

emgfit.ame\_funcs module
------------------------
Module for importing and handling of literature mass values from the Atomic Mass
Evaluation (AME2020 or AME2016).

.. automodule:: emgfit.ame_funcs
   :members:
   :undoc-members:
   :show-inheritance:

emgfit.config module
--------------------
Configuration file with general settings for emgfit package.

.. automodule:: emgfit.config
   :members:
   :undoc-members:
   :show-inheritance:

emgfit.emg\_funcs module
------------------------
Module with numerically robust implementation of the hyper-exponentially-
modified Gaussian probability density function.

.. automodule:: emgfit.emg_funcs
   :members:
   :undoc-members:
   :show-inheritance:

emgfit.fit\_models module
-------------------------
Module with fit models for single peaks with Gaussian or various
hyper-exponentially-modified Gaussian line shapes.

.. automodule:: emgfit.fit_models
   :members:
   :undoc-members:
   :show-inheritance:

emgfit.model module
-------------------
Module with custom model interface based on :mod:`lmfit.model` module.

.. automodule:: emgfit.model
   :members:
   :undoc-members:
   :show-inheritance:

emgfit.sample module
--------------------
Module for creating simulated time-of-flight mass spectra with Gaussian and
hyper-exponentially-modified line shapes.

.. automodule:: emgfit.sample
   :members:
   :undoc-members:
   :show-inheritance:


emgfit.spectrum module
----------------------
Module for fitting time-of-flight mass spectra.

.. automodule:: emgfit.spectrum
   :members:
   :undoc-members:
   :private-members: spectrum._eval_peakshape_errors, spectrum.get_MC_peakshape_errors, spectrum._eval_MC_peakshape_errors, spectrum._get_MCMC_par_samples
   :show-inheritance:

emgfit.hypothesis\_tests module
-------------------------------
Module with routines for hypothesis tests allowing to assess the significance 
of potential peaks in the data. 

.. automodule:: emgfit.hypothesis_tests
   :members:
   :undoc-members:
   :show-inheritance: