Processforge

processforge-logo

A lightweight Python framework for process simulation, coupling hydraulic, thermal, and reactor workflows.

Install

Install the pf command-line tool with uv:

uv tool install processforge

For CoolProp-backed units:

uv tool install "processforge[coolprop]"

Optional solver backends:

uv tool install "processforge[eo]"
uv tool install "processforge[eo-casadi]"
uv tool install "processforge[modelica]"

Quick start

  1. Install the tool

    uv tool install processforge

  2. Download an example flowsheet

    curl -O https://raw.githubusercontent.com/urjanova/processforge/master/flowsheets/hydraulic-chain.json

  3. Initialize, plan, and apply

    pf init
pf plan hydraulic-chain.json
pf apply hydraulic-chain.json

    plan validates the flowsheet (schema, DOF, units) without running the solver; apply solves it and stores a snapshot.

  4. Look at the output

    pf apply writes results under outputs/:

    • *_results.zarr — simulation results store (per-variable arrays, composition flattened)
    • *_results.zarr.schema.json — schema file describing streams, variables, dtypes, units, shapes, and run provenance
    • *_validation.xlsx — validation report
    • *.pfstate/ — versioned snapshot store with a latest pointer

    For flowsheets with Tank units (dynamic), use pf run instead of pf apply to solve with the SM solver.

Python API

from processforge import EOFlowsheet, validate_flowsheet
config = validate_flowsheet("flowsheets/hydraulic-chain.json")
fs = EOFlowsheet(config, backend="scipy")
results = fs.run()

Usage

See the usage guide for CLI commands and workflows.

Individual providers (e.g. FESTIM, OpenMC) can be run via Docker images using the provider image contract.

Flowsheets

The core of Processforge is the flowsheet JSON format, which defines materials, units, and recycle rules. See below for more information on the formats and example flowsheets.

License

BSD 3-Clause License

Project links

Key dates

PyPI data
Data sourced directly from PyPI's database.
  • Released:
Newer release available (0.6.0)

1 maintainer

PyPI data
Data sourced directly from PyPI's database.
Avatar for hrishiballal from gravatar.com hrishiballal

Credits

Author: Processforge Team

License expression

BSD-3-Clause
View SPDX License List

Requires

Python >=3.12

Provides Extra

eo eo-casadi fmu modelica cantera coolprop pcl dev docs

Tags

process simulation chemical engineering flowsheet

Classifiers

Report project as malware

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

processforge-0.3.1.tar.gz (154.9 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

processforge-0.3.1-py3-none-any.whl (177.6 kB view details)

Uploaded Python 3

File details

Details for the file processforge-0.3.1.tar.gz.

File metadata

  • Download URL: processforge-0.3.1.tar.gz
  • Upload date:
  • Size: 154.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.10

File hashes

Hashes for processforge-0.3.1.tar.gz
Algorithm Hash digest
SHA256 0498ad67ea7fce14436f9e79ee932ba74d6b8f4528d44664f48c0d727aa9cd21
MD5 67884c3022f0ae4ed431a7af506922a1
BLAKE2b-256 6767559fc90b6a68fd4f7572321a58569188f529807b9da2c4b2af732d1c09a3

See more details on using hashes here.

File details

Details for the file processforge-0.3.1-py3-none-any.whl.

File metadata

  • Download URL: processforge-0.3.1-py3-none-any.whl
  • Upload date:
  • Size: 177.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.10

File hashes

Hashes for processforge-0.3.1-py3-none-any.whl
Algorithm Hash digest
SHA256 d4e9c945b4f097828e3ecd99d50b89e2aa5c6bb2c3c10dc0800a5b9f06c873e0
MD5 e1a47eda42aa9fbe67352ad3e4b3616c
BLAKE2b-256 1ed68fd4c42dfdfc5edfa7cb66d50db0ddfd4dd4964e65d90b4eaf94df488ff9

See more details on using hashes here.

Release history Release notifications | RSS feed

0.6.0

2 files

0.5.1

2 files

0.5.0

2 files

0.4.3

2 files

0.4.1

2 files

0.3.26

2 files

0.3.25

2 files

0.3.23

2 files

0.3.21

2 files

0.3.20

2 files

0.3.19

2 files

0.3.17

2 files

0.3.16

2 files

0.3.15

2 files

0.3.14

2 files

0.3.13

2 files

0.3.12

2 files

0.3.11

2 files

0.3.10

2 files

0.3.9

2 files

0.3.8

2 files

0.3.5

2 files

0.3.4

2 files

0.3.3

2 files

0.3.2

2 files

This release

0.3.1 This release

2 files

0.2.40

2 files

0.2.38

2 files

0.2.34

2 files

0.2.30

2 files

0.2.24

2 files

0.2.22

2 files

0.2.20

2 files

0.2.15

2 files

0.2.14

2 files

0.2.13

2 files

0.2.12

2 files

0.2.11

2 files

0.2.10

2 files

0.2.8

2 files

0.2.7

2 files

0.2.5

2 files

0.2.4

2 files

0.2.3

2 files

0.2.1

2 files

0.2.0

2 files

0.1.0

2 files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page