Quick Start#

Welcome to the Quick Start Guide for PyBOP. This guide will help you get up and running with PyBOP. If you’re new to PyBOP, we recommend you start here to learn the basics and get a feel for the package.

Getting Started with PyBOP#

For detailed installation instructions, including how to install specific versions or from source, see the Installation section. Here we give the simplest method.

To begin using PyBOP:

  1. Install the package using pip:

    pip install pybop

  2. Once PyBOP is installed, you can import it in your Python scripts or Jupyter notebooks:

    import pybop

    Now you’re ready to utilise PyBOP’s functionality in your projects!

Exploring Examples#

PyBOP is equipped with a tools for optimising various parameters within your battery models to better match empirical data or to explore the effects of different parameters on battery behaviour.

To help you get acquainted with PyBOP’s capabilities, we provide a collection of examples that demonstrate common use cases and features of the package:

  • Jupyter Notebooks: Interactive notebooks that include detailed explanations alongside the live code, visualisations, and results. These are an excellent resource for learning and can be easily modified and executed to suit your needs.

  • Python Scripts: For those who prefer working in a text editor, IDE, or for integrating into larger projects, we provide equivalent examples in plain Python script format.

You can find these resources in the examples folder of the PyBOP repository. To access the examples, navigate to the following path after cloning or downloading the repository:

path/to/pybop/examples

These examples are also available on our GitHub repository.

Next Steps#

Once you’re comfortable with the basics demonstrated in the examples, check out the different Optimisers available in PyBOP.

You can also dive deeper into the functionality of PyBOP by delving into the API Reference for detailed API documentation.

Support and Contributions#

If you encounter any issues or have questions as you start using PyBOP, don’t hesitate to reach out to our community:

  • GitHub Issues: Report bugs or request new features by opening an Issue

  • GitHub Discussions: Post your questions or feedback on our GitHub Discussions

  • Contributions: Interested in contributing to PyBOP? Check out our Contributing Guide for guidelines.