Skip to content

Latest commit

 

History

History
43 lines (27 loc) · 1.7 KB

README.md

File metadata and controls

43 lines (27 loc) · 1.7 KB
Raw

Examples

This directory contains example notebooks and scripts demonstrating how to use PyBOP.

Directory Structure

  • notebooks/: Jupyter notebooks of example functionality with explanations
  • scripts/: Python scripts for quick reference and command-line usage
  • standalone/: Example scripts for using standalone classes

Notebooks

The notebooks/ directory contains Jupyter notebooks that provide detailed, interactive examples of various features and use cases. These notebooks include explanations, code snippets, and visualisations.

To view the notebooks with interactive figures without downloading the repository, please use nbviewer:

Scripts

The scripts/ directory contains standalone Python scripts that demonstrate specific tasks or workflows. These scripts are designed for quick reference and can be run directly from the command line.

Getting Started

  1. Clone the repository: git clone https://github.com/pybop-team/pybop.git

  2. Navigate to the examples directory: cd pybop/examples

  3. Explore the notebooks and scripts in their respective directories.

  4. To run the Jupyter notebooks locally:

    • Install Jupyter: pip install jupyter
    • Start Jupyter Notebook: jupyter notebook
    • Navigate to the notebooks/ directory and open the desired notebook

  5. To run the Python scripts:

    • Install PyBOP: pip install pybop
    • Run a script using Python: python scripts/script_name.py

Contributing

If you have additional examples or improvements to existing ones, please feel free to submit a pull request. We appreciate your contributions!