--- a +++ b/doc/api/python_reference.rst @@ -0,0 +1,48 @@ +.. _api_reference: + +==================== +Python API Reference +==================== + +This is the reference for classes (``CamelCase`` names) and functions +(``underscore_case`` names) of MNE-Python, grouped thematically by analysis +stage. Functions and classes that are not +below a module heading are found in the ``mne`` namespace. + +MNE-Python also provides multiple command-line scripts that can be called +directly from a terminal, see :ref:`python_commands`. + +.. container:: d-none + + :py:mod:`mne`: + + .. automodule:: mne + :no-members: + :no-inherited-members: + +.. toctree:: + :maxdepth: 2 + + most_used_classes + reading_raw_data + file_io + creating_from_arrays + export + datasets + visualization + preprocessing + events + sensor_space + covariance + mri + forward + inverse + source_space + time_frequency + connectivity + statistics + simulation + decoding + realtime + report + logging