Installation

pulpo is available as Python software package installable via pip.

Note

pulpo supports both Brightway2 (bw2) and Brightway25 (bw25). However, these dependencies must be installed in separate environments to avoid conflicts. You can use either conda or venv to manage your environments.

Linux, Windows, or macOS (x64)

1. Create a new environment:

   • Using conda:

     conda create -n pulpo_env python=3.10
     conda activate pulpo_env
     

   • Using venv:

     python -m venv pulpo_env
     source pulpo_env/bin/activate  # On Windows: pulpo_env\Scripts\activate
     

2. Install pulpo with the appropriate dependencies:

   • For Brightway2-compatible environments:

     pip install pulpo-dev[bw2]
     

   • For Brightway25-compatible environments:

     pip install pulpo-dev[bw25]
     

3. Verify installation: Ensure that pulpo and its dependencies are correctly installed by running:

   pip list
   

macOS (Apple Silicon/ARM)

Note

Currently we can’t guarantee that pulpo will work on Apple Silicon/ARM. You may try to follow the steps outlined in here to work with brightway25_nosolver instead of brightway25.

Updating pulpo

pulpo is actively developed, with frequent new releases. To update pulpo, follow these steps:

1. Activate your environment:

   conda activate pulpo_env  # For conda
   source pulpo_env/bin/activate  # For venv
   

2. Update pulpo with the appropriate dependencies:

   • For Brightway2-compatible environments:

     pip install --upgrade pulpo-dev[bw2]
     

   • For Brightway25-compatible environments:

     pip install --upgrade pulpo-dev[bw25]
     

Warning

Newer versions of pulpo can introduce breaking changes. We recommend creating a new environment for each project and only updating pulpo when you are ready to update your project.