Metadata-Version: 2.4
Name: breathe_simulate
Version: 2.0.2
Summary: A Python library for interacting with the Breathe Simulate api and analyzing and visualizing Breathe Simulate data
Requires-Python: >=3.9
Requires-Dist: ipykernel
Requires-Dist: nbformat>=4.2.0
Requires-Dist: numpy
Requires-Dist: pandas
Requires-Dist: plotly
Requires-Dist: pydantic
Requires-Dist: pydantic-settings
Requires-Dist: requests
Requires-Dist: scipy
Requires-Dist: tqdm
Provides-Extra: dev
Requires-Dist: httpx; extra == 'dev'
Requires-Dist: nbclient; extra == 'dev'
Requires-Dist: pytest; extra == 'dev'
Requires-Dist: pytest-cov; extra == 'dev'
Requires-Dist: ruff; extra == 'dev'
Provides-Extra: docs
Requires-Dist: mkdocs; extra == 'docs'
Requires-Dist: mkdocs-jupyter; extra == 'docs'
Requires-Dist: mkdocs-macros-plugin; extra == 'docs'
Requires-Dist: mkdocs-material; extra == 'docs'
Requires-Dist: mkdocstrings[python]; extra == 'docs'
Provides-Extra: test
Requires-Dist: httpx; extra == 'test'
Requires-Dist: nbclient; extra == 'test'
Requires-Dist: pytest; extra == 'test'
Requires-Dist: pytest-cov; extra == 'test'
Description-Content-Type: text/markdown

# 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/](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.

  ```bash
  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:

```bash
python -m venv myvenv
```

Replace `myvenv` with the desired name for your virtual environment.

- Activate the virtual environment:

  - On **Windows**:
    ```cmd
    myvenv\Scripts\activate
    ```
  - On **macOS/Linux**:
    ```bash
    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](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.
