PyBaMM results

This repository provides a template for generating results (for example, for a paper) using PyBaMM

Installation

1. Install PyBaMM using a virtual environment: see instructions in README
2. Activate PyBaMM's virtual environment:

source path/to/pybamm/env/bin/activate

If you want to create the repository once and then forget about it, you can specify a particular PyBaMM version number or commit hash that the repository works with. For example, this repository currently works with PyBaMM commit 53fa5f55e20735dc2e.

Alternatively, you can set up Travis-CI to notify you if any changes to PyBaMM cause your repository to break, to make sure that your repository stays up to date with the latest improvements in PyBaMM.

Making your own repository

1. Make a new repository in your own GitHub account

2. Copy the contents of this repository into this new repository

3. In your copy, edit this README with information about your own paper

4. In your copy, replace files in the src folder with files that generate the plots in your paper

5. Either:

   • Set up Travis-CI to run CRON jobs to be notified if your repository stops working with the latest version of PyBaMM
   • or: Specify (in your README) the PyBaMM version number or commit hash with which your repository works