Skip to content

Latest commit

 

History

History
115 lines (80 loc) · 3.23 KB

index.rst

File metadata and controls

115 lines (80 loc) · 3.23 KB
Raw
html_theme.sidebar_secondary.remove:

PyBaMM documentation

.. toctree::
   :maxdepth: 1
   :hidden:

   User Guide <source/user_guide/index>
   source/api/index
   source/examples/index
   Contributing <source/user_guide/contributing>

Version: |version|

Useful links: Project Home Page | Installation | Source Repository | Issue Tracker | Discussions

PyBaMM (Python Battery Mathematical Modelling) is an open-source battery simulation package written in Python. Our mission is to accelerate battery modelling research by providing open-source tools for multi-institutional, interdisciplinary collaboration. Broadly, PyBaMM consists of

  1. a framework for writing and solving systems of differential equations,
  2. a library of battery models and parameters, and
  3. specialized tools for simulating battery-specific experiments and visualizing the results.

Together, these enable flexible model definitions and fast battery simulations, allowing users to explore the effect of different battery designs and modeling assumptions under a variety of operating scenarios.

.. grid:: 2

   .. grid-item-card::
      :img-top: _static/index-images/getting_started.svg

      User Guide
      ^^^^^^^^^^

      The user guide is the best place to start learning PyBaMM. It contains an installation
      guide, an introduction to the main concepts and links to additional tutorials.

      +++

      .. button-ref:: source/user_guide/index
         :expand:
         :color: secondary
         :click-parent:

         To the user guide

   .. grid-item-card::
      :img-top: _static/index-images/examples.svg

      Examples
      ^^^^^^^^

      Examples and tutorials can be viewed on the GitHub examples page,
      which also provides a link to run them online through Google Colab.

      +++

      .. button-ref:: source/examples/index
         :expand:
         :color: secondary
         :click-parent:

         To the examples

   .. grid-item-card::
      :img-top: _static/index-images/api.svg

      API Documentation
      ^^^^^^^^^^^^^^^^^

      The reference guide contains a detailed description of the functions,
      modules, and objects included in PyBaMM. The reference describes how the
      methods work and which parameters can be used.

      +++

      .. button-ref:: source/api/index
         :expand:
         :color: secondary
         :click-parent:

         To the API documentation

   .. grid-item-card::
      :img-top: _static/index-images/contributor.svg

      Contributor's Guide
      ^^^^^^^^^^^^^^^^^^^

      Contributions to PyBaMM and its development are welcome! If you have ideas for
      features, bug fixes, models, spatial methods, or solvers, we would love to hear from you.

      +++

      .. button-link:: source/user_guide/contributing.html
         :expand:
         :color: secondary
         :click-parent:

         To the contributor's guide