Appearance
All sections
The complete table of contents. If you are new, the guide overview is a better starting point — it has the three pages to read first and a route by task.
Quick start
| I want to… | Go to |
|---|---|
| Install ErgoPlanner | Installation |
| Create my first project and run a result | Quick Start Guide |
| Learn the interface | Interface Overview |
| Draw a P&ID | Drawing |
| Bring an existing CAD drawing in | Importing a P&ID |
| Find a process unit | Process Units |
| Understand the biokinetic models | ASM1, ASM2d, ASM3, ADM1 |
| Set up process control | Controllers |
| Calculate a carbon footprint | Carbon Footprint |
| Run a safety study | Safety Analysis |
| Solve a piping network | Hydraulic Network Analysis |
| Route a drawing for approval | Starting a Workflow |
| See what is and is not documented | Documentation coverage |
Drawing and templates
- Drawing — the P&ID editor. Creating a drawing · drawing and connecting · client standards · comments and markers · server-side validation · continuation states · background images · touch and pen · tips and troubleshooting
- Bringing drawings in — importing a P&ID, reviewing recognition results, identifying hotspots. CAD import is deterministic — blocks and layers map to symbols through a mapping table you control. Recognition of a scanned drawing is assisted, not automatic: it proposes symbols for you to confirm, and the review pages above are part of the job rather than an optional check.
- Drawing Templates — parametric, code-described P&ID building blocks. Overview · pumping stations · instrumentation arrangements · intermediate pumping station worked example · template language reference · engine internals
- Plant Templates — the library of pre-built plant configurations (a separate thing from drawing templates above).
Simulation
- Simulation overview · building a flowsheet · calculation modes · steady-state · dynamic · model selection · controllers in a flowsheet · biogas production
- Biokinetic models — ASM1, ASM2d, ASM3, ADM1, Sumo2N
- Mass balance — COD fractionation, nitrogen, phosphorus
- Settling — Takács settling model
Process units
Every documented unit, by category. The two naming schemes below are a known duplication in this tree — see documentation coverage.
| Category | Pages |
|---|---|
| Preliminary treatment | 9 units — screens, grit, grease · also screens, grit removal, flow measurement |
| Primary treatment | circular, rectangular, lamella · also primary clarifier, CEPT |
| Biological treatment | activated sludge, biofilm systems, anaerobic, zones — 24 pages |
| Secondary treatment | clarification · also activated sludge, MBR, MBBR, SBR, trickling filter |
| Tertiary treatment | filtration, disinfection, membranes |
| Sludge treatment | thickening, digestion, dewatering — 16 pages |
| Chemical dosing | no pages yet — see coverage |
Design and engineering
- Design Calculations — flow and load · primary tanks · biofilters · humus tanks · sludge production · chemical dosing · alkalinity balance · parameter help
- Controllers — control types (cascade, ratio, deadband, switch, time on/off, continuous P, feedforward) and the loops they serve (aeration, DO, RAS/WAS, SRT, pH and alkalinity)
- Hydraulics — steady-state pipe-network solution with Hazen-Williams or Darcy-Weisbach head loss, drawn back onto the drawing
- Safety Analysis — HAZOP (guideword deviations, with a deterministic Auto-analyze) · FMEA (live RPN and AIAG-VDA action priority) · SIL (PFDavg per voting architecture) · LOPA (independent protection layers and required SIL) · DSEAR (hazardous-area zones and ATEX category)
Delivery and commercial
- Bill of Materials — how the BOM stays in sync with the drawing, the detail view, statuses, export
- Planning — the Gantt and critical path, levelling, baselines, earned value · schedules
- Carbon Footprint — using the Carbon tab · GHG emissions · Scope 1/2/3 · biogas production · energy recovery · reporting
- Collaboration — live editing and offline sync · notifications
- Workflows — routing work for review · building a template
Learning paths
New to the product — Getting Started → Quick Start Guide → Interface Overview → Tutorials
Process engineers — Process Units → Design Calculations → Plant Templates → Best Practices
Going deeper — biokinetic models → Controllers → Carbon Footprint → Safety Analysis → Hydraulics → Platform API
Administration
- AI provider setup — bring-your-own-key, self-hosted, and managed modes; per-agent model overrides; what happens when AI is unavailable
Help and reference
- Common Issues and FAQ
- Best Practices — model calibration · performance tips · troubleshooting
- Glossary · design standards · units and conversions
- Platform API and API reference pages
- What is documented, and what is not — all 112 product screens mapped against this guide