pyfstat package
===============

These pages document the full API and set of classes provided by PyFstat.

See :doc:`here <readme>` for installation instructions and
other general information.


Subpackages
-----------

.. toctree::
   :maxdepth: 4

   pyfstat.utils

Submodules
----------

pyfstat.core module
-------------------

.. automodule:: pyfstat.core
   :members:
   :undoc-members:
   :show-inheritance:

pyfstat.grid\_based\_searches module
------------------------------------

.. automodule:: pyfstat.grid_based_searches
   :members:
   :undoc-members:
   :show-inheritance:

pyfstat.gridcorner module
-------------------------

.. automodule:: pyfstat.gridcorner
   :members:
   :undoc-members:
   :show-inheritance:

pyfstat.injection\_parameters module
------------------------------------

.. automodule:: pyfstat.injection_parameters
   :members:
   :undoc-members:
   :show-inheritance:

pyfstat.logging module
----------------------

.. automodule:: pyfstat.logging
   :members:
   :undoc-members:
   :show-inheritance:

pyfstat.make\_sfts module
-------------------------

.. automodule:: pyfstat.make_sfts
   :members:
   :undoc-members:
   :show-inheritance:

pyfstat.mcmc\_based\_searches module
------------------------------------

.. automodule:: pyfstat.mcmc_based_searches
   :members:
   :undoc-members:
   :show-inheritance:

pyfstat.optimal\_setup\_functions module
----------------------------------------

.. automodule:: pyfstat.optimal_setup_functions
   :members:
   :undoc-members:
   :show-inheritance:

pyfstat.snr module
------------------

.. automodule:: pyfstat.snr
   :members:
   :undoc-members:
   :show-inheritance:

pyfstat.tcw\_fstat\_map\_funcs module
-------------------------------------

.. automodule:: pyfstat.tcw_fstat_map_funcs
   :members:
   :undoc-members:
   :show-inheritance:

Module contents
---------------

.. automodule:: pyfstat
   :members:
   :undoc-members:
   :show-inheritance: