Method
How the app works, in its own documentation.
These are the pages the app shows its own users: how each engine computes, what each result means, how the data is kept, and what the model leaves out. Each page says how far it has been checked against the code.
The steps of a result
How a result is made, and where each step is explained
-
A design and its assumption book
The sizes you set, and one row per parameter with its unit, range and source.
-
The engines
A closed form, simple hourly rules, the rule-based engine and the LP solver.
-
The results
The cost of each product, what limits output, the year hour by hour.
-
Documents and history
Every export stamped with what made it; snapshots of results; versions of inputs.
And what the model leaves out, said plainly: the model’s limits.
Every page
Overview
- Application overview What Hyprisma is, who it's for, and the shape of the whole system in one read. verified
- Reading guide How this documentation is layered, and where to start depending on who you are. verified
- Glossary Domain and technical terms used across the app and this documentation. verified
- What the model leaves out What no stage of the app models, with either engine, and how large the gap is — today, process heat. partial
- What's new What changed in each release of the app, newest first. verified
Architecture
- System architecture The major parts of the app, how they communicate, and the runtime model. partial
- Repository map An annotated tour of the repository — where everything lives and what it owns. partial
- Data model What the app stores and where — the SQLite tables, the Parquet timeseries, and how a project's inputs and results are kept. partial
- Request lifecycle — a solve from click to chart Follow one recalculation end to end — from moving a slider in the cockpit to the numbers tweening on screen. verified
- Feasibility solve flow — async job + poll How the ~13-second hourly LP runs in the background, is polled to completion, and is read back as charts without ever shipping 8,760 raw rows. verified
Features
- Feature index — the rooms The map of every screen ("room") in the app, what it's for, and where its code lives. partial
- Prefeasibility cockpit The hero room — edit a sizing on the left, read the levelized cost, binding constraint, and flow diagram on the right, recalculated live. partial
- Feasibility suite The bankable stage — an hourly rule-based engine and a PyPSA + HiGHS linear program, read across the feasibility cockpit's tabs. partial
- Assumptions (the assumption book) The per-project book of every technical & financial number — canonical, versioned, provenance-carrying — and where it's heading (robust, sourced, multi-source). partial
- Snapshots & gap analysis Named results-history — capture a full solved scenario, compare two, and see exactly which inputs moved the levelized cost. verified
- Derivatives & topology The products a project makes, the components each one implies, and the value-chain graph that assembles them. verified
- Sizing a project — the method How to arrive at a project configuration you can defend — size the plant step by step, read one clear takeaway at each step, and compare the honest base case against the optimistic ideal. partial
- How prefeasibility works — the screening What the two prefeasibility modes compute, how the numbers are costed, and how the right-size optimizer finds the cheapest design. partial
- How feasibility works — the hourly model The two feasibility engines on one hourly year — coded rules and a linear program — the operating limits, the plant's lifetime, storage value, and how far to trust each number. partial
- How it runs — the feasibility run settings The five choices under How it runs in the feasibility design panel — engine, battery, H₂ buffer, promised output, horizon — what each option does, the rule the engine follows, the trade-off, and when to choose it. partial
- How to read the Operations tab What the feasibility Operations tab shows — the year profile, the week zoom, the stores, the duration curve, curtailment by cause — and what to do about each. partial
- Documents — what each file contains Every file the app exports or reads back — what is inside, which stage it describes, its formats, who it is for, the stamp it carries, what is held back on confidential data, and where to find each one. verified
- Emissions — the RFNBO screen per product The Emissions tool, in both stages — each product's carbon intensity against the RFNBO limit, the grid's emissions by source, the most grid energy each product can take, the renewable share of the hydrogen, and what the screen leaves out. A screen, not certification. verified
- Activity log — who did what, when Every change, export and sign-in in a workspace, one plain sentence each — what is recorded and what never is, who can read it, the CSV, and how long entries are kept. verified
- Example projects — start from a copy The example projects shipped with the app — an ammonia export plant and a multi-product plant — each opened as a copy your workspace owns, built on public data only. verified
Frontend
Backend
Development
- Getting started — run it locally Install, run the backend and frontend, and know the quality gates — the zero-to-running path for a developer. verified
- Environment variables Every variable the code reads, its default, and the precedence — shell export, then .env, then the default. One module (backend/core/paths.py) answers every path question. verified
- Run with Docker One image for the whole app — on a server behind Caddy (HTTPS from Let's Encrypt), or on your own computer with your data in a folder of yours; what the image holds, how the server runs in it, back up and update. partial
Operations
What the statuses mean
- verified
- checked against the code · 14 pages
- partial
- some parts checked against the code, others not yet · 18 pages
- inferred
- written from how the app behaves, not yet checked against the code · no page
- incomplete
- parts are missing · no page
- outdated
- known to lag behind the app · no page
32 pages from the documentation of Hyprisma 1.0.5, copied on 12 November 2026.