.. _core-package-label:

************
Core package
************

The following pages document the MDTools Python **package** (also
referred to as "core package").  If you are only interested in
**running** the **scripts**, read the documentation of the
:ref:`scripts-label` instead.

.. todo::

    Revise and document all modules that are not already contained in
    this documentation.

.. contents:: Site contents
    :depth: 2
    :local:


Modules
=======

.. currentmodule:: mdtools

.. autosummary::
    :toctree: _sphinx_autosummary
    :template: custom-module-template.rst
    :recursive:
    :nosignatures:

    box
    check
    dtrj
    dynamics
    file_handler
    functions
    numpy_helper_functions
    parallel
    plot
    run_time_info
    scipy_helper_functions
    select
    statistics
    structure
    version