bipass 1.0.2.post0
Balloon Instrumentation Power system Analysis and Simulation Software
License: BSD-3-Clause-Clear
Requires Python: >=3.13

# Balloon Instrumentation Power system Analysis Simulation Framework (BI-PASS)

This software package provides a framework for design and simulation of Long Duration Balloon payloads. BIPASS is now available on PyPi and can be found here: https://pypi.org/project/bipass/

### Documentation Link:

Documentation on BIPASS can be found on the gitlab pages here: https://power-system-analysis-group.gitlab.io/power-system-simulation-framework/

### To install via PyPi:

1. Open a terminal in the place you would like to install BIPASS

2. Set up the conda environment:
   1. Download python via miniconda using ```https://docs.anaconda.com/miniconda/```
   2. Source the .bashrc via ```source ~/.bashrc```
   3. Check that the conda install has worked via ```conda --version```
   4. Once you have installed conda open the PASS package in the terminal and enter
        ```conda create --name [environment name] python=3.13 or (3.14)```

3. Enter your conda environment by running ``` conda activate [environment name]```

4. In the terminal run ```pip install bipass```

5. To check BIPASS was install run ``` pass --help```

Add run, status, and plots folders for outputs:
   1. ```mkdir run```
   This is the folder in which you will build the config files for different power system configurations.
   2. ```cd run```

   3. ```mkdir status```
   This is the folder where status files for simulated trajectories will be stored.

   4. ```mkdir plots```
   This is the folder where all of your plots will go.  To change the name of the plot, go into the config file and edit the plot name for that script.

### To install this software package via Gitlab:

1. Download the Git repository:

    ```git clone https://gitlab.com/power-system-analysis-group/power-system-simulation-framework.git```

2. Set up the conda environment:
   1. Download python via miniconda using ```https://docs.anaconda.com/miniconda/```
   2. Source the .bashrc via ```source ~/.bashrc```
   3. Check that the conda install has worked via ```conda --version```
   4. Once you have installed conda open the PASS package in the terminal and enter
        ```conda create --name [environment name] python=3.13 (or 3.14)```


3. Install the package with pip:
   1. Enter the conda environment via ```conda activate [environment name]```
   2. Pip install BIPASS via the two commands below:

   For use only:

    ```pip install .```

    For code development:

    ```pip install -e .```

4. Add run, status, and plots folders for outputs:
   1. ```mkdir run```
   This is the folder in which you will build the config files for different power system configurations.
   2. ```cd run```

   3. ```mkdir status```
   This is the folder where status files for simulated trajectories will be stored.

   4. ```mkdir plots```
   This is the folder where all of your plots will go.  To change the name of the plot, go into the config file and edit the plot name for that script.






 ### To run the software:

 1. Open the package in the terminal

 2. Enter the pass environment via ```conda activate pass```

 3. Enter into the run folder via ```cd run```

 4. Generate a default config file via ```pass make-config config_name.toml```

 5. Reference all the possible functions via ```pass --help```

 6. Run a command via ```pass command-name config_name.toml```