Breathe Simulate

A python based api wrapper for running the breathe simulate model.

Registration Required: To use the Breathe Simulate API, you must register for a free trial. You can sign up at https://breathebatteries.com/knowledge-hub/simulate-trial/.

Installation steps

In a new project or existing project

In the virtual environment in your new or existing project, simply install breathe_simulate with

pip install breathe_simulate

Using this repo

If you want to work with the examples in this repo, follow these steps...

• Open your terminal or command prompt.

• Navigate to the directory or create new one where you want to setup.

• Run the following command to clone our GitHub repository.

  git clone https://github.com/BreatheBatteries/breathe_simulate.git .
  

To set up everything in one go, just run .\setupEnvironment.ps1.

That will create a virtual environment and install the requirements.

Alternative manual setup

Alternatively, run following command to create the virtual environment:

python -m venv myvenv

Replace myvenv with the desired name for your virtual environment.

• Activate the virtual environment:

  • On Windows:

    myvenv\Scripts\activate
    

  • On macOS/Linux:

    source myvenv/bin/activate
    

  After activating the virtual environment, you'll see (myenv) in your terminal prompt to indicate that the environment is active.

• Install the breathe_simulate package in the virtual environment:

  pip install breathe_simulate
  

Examples

Check out the python notebooks in docs/examples for how to use the api.

Reporting Bugs

If you find a bug, or run into an error, please raise an issue on the GitHub account.