text stringlengths 865 15.6k | source stringlengths 21 98 |
|---|---|
.. Root of all pybamm docs
.. Remove the right side-bar for the home page
:html_theme.sidebar_secondary.remove:
####################
PyBaMM documentation
####################
.. This TOC defines what goes in the top navbar
.. toctree::
:maxdepth: 1
:hidden:
User Guide <source/user_guide/index>
source/a... | PyBaMM/docs/index.rst |
# Getting Started
The easiest way to use PyBaMM is to run a 1C constant-current discharge with a model of your choice with all the default settings:
```python
import pybamm
model = pybamm.lithium_ion.DFN() # Doyle-Fuller-Newman model
sim = pybamm.Simulation(model)
sim.solve([0, 3600]) # solve for 1 hour
sim.plot()... | PyBaMM/docs/source/user_guide/getting_started.md |
Install from source (Windows Subsystem for Linux)
=================================================
To make it easier to install PyBaMM, we recommend using the Windows Subsystem for Linux (WSL) along with Visual Studio Code. This guide will walk you through the process.
Install WSL
-----------
Install Ubuntu 22.04 o... | PyBaMM/docs/source/user_guide/installation/windows-wsl.rst |
Install from source (GNU Linux and macOS)
=========================================
.. contents::
This page describes the build and installation of PyBaMM from the source code, available on GitHub. Note that this is **not the recommended approach for most users** and should be reserved to people wanting to participat... | PyBaMM/docs/source/user_guide/installation/install-from-source.rst |
Install from source (Docker)
============================
.. contents::
This page describes the build and installation of PyBaMM using a Dockerfile, available on GitHub. Note that this is **not the recommended approach for most users** and should be reserved to people wanting to participate in the development of PyBa... | PyBaMM/docs/source/user_guide/installation/install-from-docker.rst |
Installation
============
PyBaMM is available on GNU/Linux, MacOS and Windows.
It can be installed using ``pip`` or ``conda``, or from source.
.. tab:: GNU/Linux and Windows
.. tab:: pip
PyBaMM can be installed via pip from `PyPI <https://pypi.org/project/pybamm>`__.
.. code:: bash
pip ins... | PyBaMM/docs/source/user_guide/installation/index.rst |
Windows
=======
.. contents::
Prerequisites
-------------
To use PyBaMM, you must have Python 3.8, 3.9, 3.10, 3.11, or 3.12 installed.
To install Python 3 download the installation files from `Python’s
website <https://www.python.org/downloads/windows/>`__. Make sure to
tick the box on ``Add Python 3.X to PATH``. F... | PyBaMM/docs/source/user_guide/installation/windows.rst |
GNU/Linux & macOS
=================
.. contents::
Prerequisites
-------------
To use PyBaMM, you must have Python 3.8, 3.9, 3.10, 3.11, or 3.12 installed.
.. tab:: Debian-based distributions (Debian, Ubuntu, Linux Mint)
To install Python 3 on Debian-based distributions (Debian, Ubuntu, Linux Mint), open a termi... | PyBaMM/docs/source/user_guide/installation/gnu-linux-mac.rst |
# Fundamentals
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 ... | PyBaMM/docs/source/user_guide/fundamentals/index.md |
# Battery Models
References for the battery models used in PyBaMM simulations can be found calling
```python
pybamm.print_citations()
```
However, a few papers are provided in this section for anyone interested in reading the theory
behind the models before doing the tutorials.
## Review Articles
[Review of physics-... | PyBaMM/docs/source/user_guide/fundamentals/battery_models.md |
# Tutorial 9 - Changing the mesh
In [Tutorial 8](./tutorial-8-solver-options.ipynb) we saw how to change the solver options. In this tutorial we will change the mesh used in the simulation, and show how to investigate the influence of the mesh on the solution.
All models in PyBaMM have a default number of mesh points... | PyBaMM/docs/source/examples/notebooks/getting_started/tutorial-9-changing-the-mesh.ipynb |
# Tutorial 11 - Creating a submodel
In [Tutorial 10](./tutorial-10-creating-a-model.ipynb) we showed how to create a simple model from scratch in PyBaMM. In this tutorial we will solve the same problem, but using separate submodels for the linear diffusion problem and the model for the surface flux. In this simple exa... | PyBaMM/docs/source/examples/notebooks/getting_started/tutorial-11-creating-a-submodel.ipynb |
# Tutorial 10 - Creating a model
In [Tutorial 9](./tutorial-9-changing-the-mesh.ipynb) we showed how to change the mesh using on of the built-in battery models in PyBaMM. In this tutorial we show how to create a simple model from scratch in PyBaMM.
As simple example, we consider the problem of linear diffusion on a u... | PyBaMM/docs/source/examples/notebooks/getting_started/tutorial-10-creating-a-model.ipynb |
# Tutorial 3 - Basic plotting
In [Tutorial 2](./tutorial-2-compare-models.ipynb), we made use of PyBaMM's automatic plotting function when comparing models. This gave a good quick overview of many of the key variables in the model. However, by passing in just a few arguments it is easy to plot any of the many other va... | PyBaMM/docs/source/examples/notebooks/getting_started/tutorial-3-basic-plotting.ipynb |
# Tutorial 8 - Solver options
In [Tutorial 7](./tutorial-7-model-options.ipynb) we saw how to change the model options. In this tutorial we will show how to pass options to the solver.
All models in PyBaMM have a default solver which is typically different depending on whether the model results in a system of ordinar... | PyBaMM/docs/source/examples/notebooks/getting_started/tutorial-8-solver-options.ipynb |
# Tutorial 6 - Managing simulation outputs
In the previous tutorials we have interacted with the outputs of the simulation via the default dynamic plot. However, usually we need to access the output data to manipulate it or transfer to another software which is the topic of this notebook.
We start by building and sol... | PyBaMM/docs/source/examples/notebooks/getting_started/tutorial-6-managing-simulation-outputs.ipynb |
# Tutorial 5 - Run experiments
In [Tutorial 4](./tutorial-4-setting-parameter-values.ipynb) we saw how to change the parameters, including the applied current. However, in some cases we might want to prescribe a given voltage, a given power or switch between different conditions to simulate experimental setups. We can... | PyBaMM/docs/source/examples/notebooks/getting_started/tutorial-5-run-experiments.ipynb |
# Tutorial 2 - Compare models
In [Tutorial 1](./tutorial-1-how-to-run-a-model.ipynb), we saw how to run a PyBaMM simulation of the DFN model. However, PyBaMM includes other standard electrochemical models such as the Single Particle Model (SPM) and the Single Particle Model with electrolyte (SPMe). In this tutorial, w... | PyBaMM/docs/source/examples/notebooks/getting_started/tutorial-2-compare-models.ipynb |
# Tutorial 7 - Model options
In all of the previous tutorials, we have made use of the default forms of the inbuilt models in PyBaMM. However, PyBaMM provides a high-level interface for tweaking these models for your particular application.
```
%pip install "pybamm[plot,cite]" -q # install PyBaMM if it is not ins... | PyBaMM/docs/source/examples/notebooks/getting_started/tutorial-7-model-options.ipynb |
# Tutorial 1 - How to run a model
Welcome to PyBaMM! In this notebook, we will run your first PyBaMM model in just a few simple lines.
To run through this jupyter notebook simply shift-enter to run the cells. If you are unfamiliar with Jupyter notebooks we recommend checking out this [cheat sheet](https://www.cheato... | PyBaMM/docs/source/examples/notebooks/getting_started/tutorial-1-how-to-run-a-model.ipynb |
# Tutorial 4 - Setting parameter values
In [Tutorial 1](./tutorial-1-how-to-run-a-model.ipynb) and [Tutorial 2](./tutorial-2-compare-models.ipynb), we saw how to run a PyBaMM model with all the default settings. However, PyBaMM also allows you to tweak these settings for your application. In this tutorial, we will see... | PyBaMM/docs/source/examples/notebooks/getting_started/tutorial-4-setting-parameter-values.ipynb |
README.md exists but content is empty.
- Downloads last month
- 5