OpenFlowsheet

An agent-native open process-engineering runtime, in which models, equations, numerical strategies, validity limits and evidence are explicit objects. Humans and coding agents work against the same scientific contracts. The project owns solver orchestration and process-specific numerical methods, and reuses established differentiation, linear-algebra and optimization infrastructure.

Status

Pre-release. Phase 0 is complete; no capability is released, and nothing here is validated against experiment or an independent process simulator.

What the project has and has not shown is recorded per package in evidence/<ID>/<commit>/manifest.json, and the current position is docs/progress.md.

Authorities

Read these before changing anything they cover.

Development

Requires Python 3.13.

make venv                                  # create .venv and install with dev extras
make check                                 # ruff, ruff format, mypy --strict, pytest
make lock                                  # regenerate requirements.lock from the environment

make check is the gate. It must be green before any merge, and a failed gate stays failed — it is never relaxed, narrowed or worked around to let a change through.

Third-party notices

This software uses CasADi 3.8.0, which is licensed under the GNU Lesser General Public License, version 3 or later (LGPL-3.0-or-later). CasADi is a separate work, obtained by the installer from PyPI as a pinned dependency; this project distributes none of its bytes. It is used through its Python API only — the interpreter loads the library at run time, nothing is compiled against its headers or linked against it at build time, and a user may substitute their own build of CasADi 3.8.0 by replacing the installed package.

The full licence text ships inside the CasADi distribution at casadi/LICENSE/LICENSE.txt in the installed package, together with notices for its bundled components at casadi/include/licenses/.

An exact inventory of what that distribution contains — every binary with its SHA-256, the bundled plugin inventory including the bytes that cannot run, and the notices — is docs/p03-binary-audit.md, with the machine-readable record in spikes/p03/results/. The terms on which this project may and may not redistribute any of it are docs/adr/0006-distribution-data-rights.md. Changing the CasADi pin re-runs that audit before the change merges.

Further attributions are in NOTICE.

Licence

The core licence is Apache-2.0, declared in pyproject.toml and stated in LICENSE and NOTICE. The maintainer confirmed the project's rights to distribute its contributions under it on 2026-09-23 (120acb4). Why Apache-2.0 rather than MIT is recorded in docs/decision-register.md R-005.