Skip to content

Installation

ProcessPI is a Python toolkit for process modeling, simulation, and analysis.
It allows engineers to design and simulate pipelines, equipment, and networks with real-world accuracy.

We recommend Google Colab for new users because it provides a zero-setup environment, comes pre-installed with common Python packages, and allows you to run simulations instantly without installing anything locally.


  • Google Colab (Recommended)
    Google Colab provides a cloud-based Python environment. You can try ProcessPI without worrying about local installations or dependencies.
    Install and import in Colab:

    !pip install processpi
    from processpi.components import Water
    print(Water().density())
    
    Recommended for beginners, testing examples, and sharing notebooks easily.

  • Install from PyPI
    Quickest method for installing ProcessPI in your local Python environment. Works for most users:

    pip install processpi
    
    Best for running scripts locally without cloning the source.

  • Development Setup
    If you want to contribute or customize ProcessPI, clone the repository and install in editable mode:

    git clone https://github.com/varma666/ProcessPi.git
    cd ProcessPi
    pip install -e .
    
    Allows live editing of code and testing changes immediately.

  • Using a Virtual Environment (Recommended for Local Setup)
    Protect your system Python and avoid dependency conflicts:

    python -m venv .venv
    # Linux / macOS
    source .venv/bin/activate
    # Windows
    .venv\Scripts\activate
    pip install processpi
    
    Recommended for stable development and isolating projects.

  • Using in Jupyter Notebook
    Jupyter Notebook allows interactive simulations. Install Jupyter if not available:

    pip install jupyter
    jupyter notebook
    
    Then import ProcessPI:
    from processpi.units import Length, Pressure
    print(Length(1, "m").to("ft"))
    
    Ideal for step-by-step examples, tutorials, and exploring features.

  • Verification
    Ensure ProcessPI is installed correctly:

    import processpi
    print("ProcessPI version:", processpi.__version__)
    
    Confirms your environment is ready to run simulations.