.. Root of all pybamm docs

.. _GitHub: https://github.com/pybamm-team/PyBaMM

Welcome to PyBaMM's documentation!
==================================

Python Battery Mathematical Modelling (**PyBAMM**) solves continuum models for
batteries, using both numerical methods and asymptotic analysis.

PyBaMM is hosted on GitHub_. This page provides the *API*, or *developer
documentation* for ``pybamm``.

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`

Contents
========

.. module:: pybamm

.. toctree::
    :maxdepth: 2

    source/expression_tree/index
    source/models/index
    source/parameters/index
    source/geometry/index
    source/meshes/index
    source/spatial_methods/index
    source/solvers/index
    source/experiments/index
    source/processed_variable
    source/util
    source/simulation
    source/citations
    source/parameters_cli

Examples
========

Detailed examples can be viewed on the
`GitHub examples page <https://github.com/pybamm-team/PyBaMM/tree/master/examples/notebooks>`_,
and run locally using ``jupyter notebook``, or online through
`Binder <https://mybinder.org/v2/gh/pybamm-team/PyBaMM/master?filepath=examples%2Fnotebooks>`_.

Contributing
============

There are many ways to contribute to PyBaMM:

.. toctree::
    :maxdepth: 1

    tutorials/add-parameter-values
    tutorials/add-model
    tutorials/add-spatial-method
    tutorials/add-solver

Before contributing, please read the `Contribution Guidelines <https://github.com/pybamm-team/PyBaMM/blob/master/CONTRIBUTING.md>`_.