MethodFeatures
partial some parts checked against the code, others not yet · what the statuses mean
Feature index — the rooms
In simple terms
The app is organised as rooms — one screen per job. You move Portfolio → Project → Room. This page lists every room, what it answers, and where its code lives, so you can jump straight to the right place.
The information architecture
- Portfolio (
/projects) — all your projects; create a new one here. - Project (
/projects/:projectId/…) — one project, seen through stages and tool rooms. Stages are views over one shared state, freely navigable — never a one-way wizard. - Two loops: the inner loop is one analysis inside a room (edit → solve → read → tweak); the outer loop is the project evolving across stages and snapshots.
The rooms
Each stage is one cockpit: its rooms are tabs in the left sidebar, and so
are the tools every stage carries (Assumptions, Snapshots, Derivatives,
Emissions; Scenarios and Settings marked partial until built), each opened inside it. The tables below are generated from the
code (frontend/src/shell/shellNav.ts, shell/FeasibilityShell.tsx, App.tsx),
so they cannot drift from it.
Prefeasibility — /projects/:id/prefeasibility/<tab>, opens on cockpit.
| Group | Tab | Address | What it answers |
|---|---|---|---|
| Design | Cockpit | prefeasibility/cockpit |
Size the plant and read its cost, output and energy balance — live as you edit. |
| Reference | How it works | prefeasibility/method |
The annual and hourly prefeasibility engines, and what to trust. |
| Tools | Assumptions | prefeasibility/assumptions |
This stage’s assumption book: every value, its source and its range. |
| Tools | Snapshots | prefeasibility/snapshots |
Save this stage’s design and results, and restore one. |
| Tools | Derivatives | prefeasibility/derivatives |
The value chain this stage solves: the products and the units each needs. |
| Tools | Emissions | prefeasibility/emissions |
Carbon intensity per product against the RFNBO limit — a screen, not a certificate. |
| Tools | Scenarios (partial) | prefeasibility/scenarios |
Compare two to four snapshots, designs or versions side by side. Partial here: Two snapshots compare inside Snapshots today; two to four side by side come with this tool. |
| Tools | Settings (partial) | prefeasibility/settings |
This project’s name, location, units and bundle. Partial here: Rename, duplicate, export and delete are in the project’s ⋯ menu in the sidebar; this page — place, units, the default book — is not built yet. |
Feasibility — /projects/:id/feasibility/<tab>, opens on overview.
| Group | Tab | Address | What it answers |
|---|---|---|---|
| Site | Resources | feasibility/resources |
What the site’s wind and sun give you, before any design. |
| Design | Design lab | feasibility/lab |
Vary the design: find a configuration, or size it at least cost. |
| Check the design | Overview | feasibility/overview |
The verdict and the cost of each product. |
| Check the design | Operations | feasibility/operations |
How the plant runs, hour by hour. |
| Check the design | Reliability | feasibility/reliability |
Delivered against promised; where it falls short, by cause, and what cures it. |
| Check the design | Storage | feasibility/storage |
The battery and hydrogen store: state of charge and value. |
| Check the design | Grid | feasibility/grid |
Grid draw, its cost, and the RFNBO screen. |
| Reference | How it works | feasibility/method |
How the feasibility engines work, and what this run consumed. |
| Tools | Assumptions | feasibility/assumptions |
This stage’s assumption book: every value, its source and its range. |
| Tools | Snapshots | feasibility/snapshots |
Save this stage’s design and results, and restore one. |
| Tools | Derivatives | feasibility/derivatives |
The value chain this stage solves: the products and the units each needs. |
| Tools | Emissions | feasibility/emissions |
Carbon intensity per product against the RFNBO limit — a screen, not a certificate. |
| Tools | Scenarios (partial) | feasibility/scenarios |
Compare two to four snapshots, designs or versions side by side. Partial here: Two snapshots compare inside Snapshots today; two to four side by side, and the four engines on one design, come with this tool. |
| Tools | Settings (partial) | feasibility/settings |
This project’s name, location, units and bundle. Partial here: Rename, duplicate, export and delete are in the project’s ⋯ menu in the sidebar; this page — place, units, the default book — is not built yet. |
Design lab views — feasibility/lab?mode=<view>; the first view opens when no mode is given (old modes kept as aliases: explore → one, storage → one).
| View | mode= |
What it does |
|---|---|---|
| One component | one |
Move one size — or two together — across a range; cost, output and reliability at each. |
| Try every combination | every |
A range and a step per component; every combination solved; the cheapest all-green design. |
| Scale the plant | scale |
Grow or shrink everything but storage together; cost and output per product. |
| Find a design | search |
Sample whole designs on the rule-based engine and explain the best one. |
| Least cost (LP) | optimizer |
The solver sizes the free components at least annual cost to make what you ask of each product. |
Outside the two cockpits:
| Page | Route | What it answers | Code |
|---|---|---|---|
| Portfolio | /projects |
Which projects exist? Create or import one. | pages/PortfolioLanding.tsx |
| Examples | /projects (an empty workspace), the New project panel |
Start from a copy of an example project shipped with the app. | pages/home/ExampleList.tsx |
| Snapshots | /projects/:id/snapshots |
Named results-history + gap analysis between two. | rooms/snapshots/ |
| Derivatives | /projects/:id/derivatives |
The value-chain topology graph. | rooms/derivatives/ |
| Settings / DAB | /settings/dab |
Edit + version the default assumption book. | pages/SettingsDab.tsx |
| Activity log | /settings/workspace (admins), /settings/workspaces (the super admin) |
Who did what, when: every change, export and sign-in, as one sentence each; filters and a CSV. | pages/ActivityLog.tsx |
| Docs | /docs, /docs/:slug |
This documentation. | pages/DocsRoute.tsx |
The classic room addresses are redirects since the cockpit became the only layout; the query string is kept.
| Old address | Opens |
|---|---|
/projects/:id/prefeasibility |
/projects/:id/prefeasibility/cockpit |
/projects/:id/methods |
/projects/:id/prefeasibility/method |
/projects/:id/feasibility |
/projects/:id/feasibility/operations |
/projects/:id/resources |
/projects/:id/feasibility/resources |
/projects/:id/feasibility-results |
/projects/:id/feasibility/overview |
/projects/:id/feasibility-inputs |
/projects/:id/feasibility/method?view=inputs |
/projects/:id/feasibility-methods |
/projects/:id/feasibility/method |
/projects/:id/reliability |
/projects/:id/feasibility/reliability |
/projects/:id/storage-lab |
/projects/:id/feasibility/storage |
/projects/:id/grid |
/projects/:id/feasibility/grid |
/projects/:id/finder |
/projects/:id/feasibility/lab?mode=search |
/projects/:id/optimizer |
/projects/:id/feasibility/lab?mode=optimizer |
/projects/:id/assumptions |
the Assumptions tab of the stage you were last in |
/projects/:id/snapshots |
the Snapshots tab of the stage you were last in |
/projects/:id/derivatives |
the Derivatives tab of the stage you were last in |
/projects/:id/emissions |
the Emissions tab of the stage you were last in |
/projects/:id/scenarios |
the Scenarios tab of the stage you were last in |
/projects/:id/settings |
the Settings tab of the stage you were last in |
Not live yet — the :room catch-all renders a placeholder page for: Pre-FEED · FEED · Financing · Financials.
The two live stages
- Prefeasibility (fast screening) — closed-form Mode A (annual) and greedy Mode B (timeseries). The cockpit is the hero room.
- Feasibility (bankable) — an hourly rule-based engine (the default
feas_mode) and an hourly PyPSA + HiGHS linear program. A suite of rooms — the feasibility tabs listed above.
A run with no look-ahead and the LP with perfect foresight bracket how the plant really runs; the annual screen rests on an assumed curtailment floor and can land on either side. See How prefeasibility works and System architecture.
The persistent project chrome
One left sidebar on every page (shell/Sidebar.tsx, in layouts/AppLayout.tsx):
- New project, Search (⌘K), the projects — the open one first, expanded into its
stage switch, rooms and tools, then the pinned ones and the five last edited, each
with a ⋯ menu (rename · pin · export bundle · duplicate · delete), and All
projects (N) for the rest (⌘K finds every project) — and an account menu (docs,
theme, app settings, shortcuts). It folds to an icon rail (⌘B) and becomes a drawer
at 900 px and below. The one top bar carries the breadcrumb and, on every tab of
both stages, that stage’s Export ▾ and Snapshot (
shell/StageActions.tsx; a viewer sees Export only).
Two version bars sit where their editing happens:
- Book version bar (the Assumptions tab’s header) — the assumption-set axis (save / save-as / switch), with the book’s Excel export and import.
- Sizing version line (the top of the design panel, in both stages) — the capacities + CFs + derivatives axis.
Both use the same working/active/dirty lifecycle. A full scenario across both axes plus results is a snapshot. See data model.
Related topics
- Application overview
- The How it works tabs, as pages: How prefeasibility works · How feasibility works · What the model leaves out
- Documents — what each file contains
- Example projects — start from a copy
- Emissions — the RFNBO screen per product
- Prefeasibility cockpit
- System architecture
- Repository map
From the app’s documentation, docs/02-features/feature-index.md · Hyprisma 1.0.5