ErgoPlanner

Appearance

Tutorials ​

Step-by-step tutorials covering ErgoPlanner end to end — the core design flow first, then specialized simulation features.

Overview ​

This section provides detailed, hands-on tutorials. The first two are the core product flow and the place to start: they take you from an empty account to a Bill of Materials you can export. The remaining four cover process-simulation techniques and assume you already know the User Guide.

Start here — the core flow ​

Two tutorials, one for each way a project begins. Pick the one that matches your situation.

A Greenfield Project, End to End ​

Greenfield-Project — Start with nothing and finish with an exported Bill of Materials

Create a project, open a drawing, place a template, let the AI compose a process train from your template library, see what the agents contribute, then generate and export the BoM.

Topics covered:

  • Creating a project (project number, client, location)
  • Creating a drawing and its title-block metadata
  • Finding, configuring and placing drawing templates
  • Describing a process to the AI Assistant and working the composition plan it returns
  • The four dispatchable agents, and the validation pass
  • Generating, filtering and exporting the Bill of Materials

Difficulty: Beginner to intermediate Time: 45–60 minutes Prerequisites: An account with the Engineer role or higher

Brownfield — Starting From CAD Drawings You Already Have ​

Brownfield-CAD-Import — Bring DXF and DWG files in, map their blocks, build on them

Import an existing CAD P&ID, map its blocks to your symbol library, separate existing plant from new work, add the new areas, and end at the BoM.

Topics covered:

  • Block-mapping tables: glob rules, layer rules, export and import
  • Importing DWG (server-side, native) and DXF (in-browser, per-layer)
  • Auto-detect: scoring your saved mapping tables against the drawing in front of you
  • Reading the import result — mapped, unmapped, traced, not placed
  • Marking existing plant apart from new work, and what the BoM can and cannot split
  • Generating and exporting the BoM over a mixed drawing

Difficulty: Intermediate Time: 45–60 minutes Prerequisites: A DXF or DWG P&ID, and an account with the Engineer role or higher

Guided courses inside the app ​

Learn-Courses — The coach-marked courses under Learn, including Draw with a sentence and Review a drawing

Simulation tutorials ​

Biokinetic Models Configuration ​

Biokinetic-Models - Master ASM1, ASM2d, and ASM3 biokinetic models

Configure and optimize activated sludge models for accurate biological treatment simulation.

Topics Covered:

  • ASM1 configuration for conventional treatment
  • ASM2d for enhanced biological phosphorus removal
  • ASM3 for advanced modeling scenarios
  • Parameter calibration and sensitivity
  • Model selection criteria

Difficulty: Advanced Time: 60 minutes Prerequisites: Running-Simulations, First-Simulation

Controller Setup and Tuning ​

Controller-Setup - Implement automated process control with PID controllers

Set up PID controllers for DO, WAS, chemical dosing, and other process variables.

Topics Covered:

  • PID controller fundamentals
  • DO control configuration
  • Cascade control systems
  • Auto-tuning procedures
  • Control loop troubleshooting

Difficulty: Advanced Time: 60 minutes Prerequisites: Dynamic-Simulation, understanding of control theory

Carbon Footprint Analysis ​

Carbon-Footprint - Calculate and optimize greenhouse gas emissions

Configure Scope 1, 2, and 3 emissions calculations and identify reduction opportunities.

Topics Covered:

  • Emission factor configuration
  • Scope 1: Direct emissions (N₂O, CH₄)
  • Scope 2: Electricity consumption
  • Scope 3: Chemicals, biosolids transport
  • Optimization strategies
  • Reporting and documentation

Difficulty: Intermediate to Advanced Time: 45 minutes Prerequisites: Running-Simulations, basic carbon accounting knowledge

Multi-Scenario Comparison ​

Multi-Scenario - Sensitivity analysis and design alternative evaluation

Compare multiple design alternatives or operating conditions systematically.

Topics Covered:

  • Scenario definition and setup
  • Sensitivity analysis techniques
  • Parameter sweeps and optimization
  • Statistical comparison methods
  • Decision matrices
  • Presentation of results

Difficulty: Advanced Time: 75 minutes Prerequisites: Creating-Projects, Analyzing-Results

Tutorial Structure ​

Each tutorial follows a consistent structure:

1. Overview ​

  • Learning objectives
  • Time estimate
  • Difficulty level
  • Prerequisites

2. Theoretical Background ​

  • Concepts and principles
  • When to use the technique
  • Key considerations

3. Step-by-Step Implementation ​

  • Detailed configuration steps
  • Screenshots and examples
  • Tips and best practices
  • Common pitfalls to avoid

4. Analysis and Interpretation ​

  • How to evaluate results
  • Key metrics and indicators
  • Troubleshooting guidance

5. Real-World Examples ​

  • Case studies
  • Typical results
  • Industry applications

6. Summary and Next Steps ​

  • Key takeaways
  • Related tutorials
  • Further reading

Learning Paths ​

Path 0: The Core Design Flow ​

For anyone new to ErgoPlanner, whatever their discipline. Do this before any other path.

  1. Greenfield-Project - Project → drawing → templates → agents → BoM (45-60 min)
  2. Brownfield-CAD-Import - The same destination, starting from your own CAD files (45-60 min)
  3. Issuing-a-Drawing - Freeze a revision and send a transmittal (20 min)
  4. Running-a-Design-Review - Comments and the review lifecycle (20 min)
  5. Revision-Cycle - Rev A → Rev B, and the project stage gate (20 min)

Total Time: 2.5-3 hours Outcome: Able to take a project from creation to an issued drawing with a BoM

Path 1: Process Optimization ​

For engineers focused on improving existing plant performance.

  1. Biokinetic-Models - Understand process kinetics (60 min)
  2. Controller-Setup - Implement control strategies (60 min)
  3. Multi-Scenario - Evaluate alternatives (75 min)
  4. Model-Calibration - Match plant data (60 min)

Total Time: 4-5 hours Outcome: Ability to optimize plant operations using simulation

Path 2: Sustainability Engineering ​

For professionals focused on environmental impact reduction.

  1. Carbon-Footprint - Quantify emissions (45 min)
  2. Biokinetic-Models - Optimize biological processes (60 min)
  3. Multi-Scenario - Compare green alternatives (75 min)
  4. Controller-Setup - Energy-efficient control (60 min)

Total Time: 4-5 hours Outcome: Comprehensive sustainability assessment and optimization

Path 3: Design Engineering ​

For consultants and design engineers evaluating new plants or expansions.

  1. Multi-Scenario - Design alternatives comparison (75 min)
  2. Biokinetic-Models - Process selection (60 min)
  3. Carbon-Footprint - Sustainability evaluation (45 min)
  4. Performance-Tips - Large model optimization (30 min)

Total Time: 3.5-4 hours Outcome: Complete design evaluation methodology

Path 4: Operations Engineering ​

For plant operators and operational engineers.

  1. Controller-Setup - Automated control (60 min)
  2. Dynamic-Simulation - Upset response (45 min)
  3. Biokinetic-Models - Process understanding (60 min)
  4. Troubleshooting - Problem solving (45 min)

Total Time: 3.5-4 hours Outcome: Operational troubleshooting and optimization skills

Tutorial Quick Reference ​

By Difficulty ​

Beginner to intermediate:

Intermediate:

Advanced:

By Time Commitment ​

30-45 minutes:

45-60 minutes:

60-75 minutes:

By Application Area ​

Biological Treatment:

Process Control:

Sustainability:

Design and Planning:

Prerequisites Checklist ​

Before starting tutorials, ensure you can:

Not ready yet? Complete the User Guide first, then return to Tutorials.

Tutorial Data Files ​

Some tutorials include example data files:

Biokinetic Models Tutorial ​

  • asm1_calibration_data.csv - Calibration dataset
  • asm2d_ebpr_config.json - EBPR template
  • asm3_parameters.json - Advanced parameter set

Controller Setup Tutorial ​

  • do_control_tuning.csv - DO control test data
  • cascade_control_config.json - Cascade controller template
  • pid_tuning_worksheet.xlsx - Tuning helper spreadsheet

Carbon Footprint Tutorial ​

  • emission_factors_regional.csv - Regional emission factors
  • carbon_report_template.json - Report configuration
  • scope3_calculator.xlsx - Scope 3 worksheet

Multi-Scenario Tutorial ​

  • sensitivity_analysis_template.json - Scenario template
  • scenario_comparison.xlsx - Comparison worksheet

Download Location: Available in ErgoPlanner under Help → Tutorial Resources

Tips for Success ​

1. Follow Sequentially ​

Complete tutorials in order within each learning path. Later tutorials build on earlier concepts.

2. Hands-On Practice ​

Don't just read - actually perform each step in ErgoPlanner. Active learning is most effective.

3. Experiment ​

After completing a tutorial, try variations:

  • Change parameters and observe effects
  • Apply techniques to your own projects
  • Combine methods from multiple tutorials

4. Take Notes ​

Document your learning:

  • What worked well
  • Challenges encountered
  • Questions for further study
  • Applications to your projects

5. Revisit as Needed ​

Tutorials are references. Return to specific sections when implementing features in real projects.

Support and Community ​

Getting Help ​

If you encounter issues:

  1. Check Troubleshooting for common problems
  2. Review User-Guide for fundamental concepts
  3. Search this wiki for specific topics
  4. Consult API-Reference for technical details

Sharing Knowledge ​

After mastering tutorials:

  • Share your experiences with colleagues
  • Contribute case studies or examples
  • Suggest tutorial improvements
  • Help others in the community forum

Advanced Topics Beyond Tutorials ​

After completing all tutorials, explore:

Technical Documentation ​

  • API-Reference - Programmatic access for automation
  • Process-Units - Detailed unit operation models
  • Advanced-Solvers - Numerical methods

Specialized Topics ​

  • Design-Calculations - SUMO and design standards
  • Clarifier-Models - Advanced settling models
  • Advanced-Control - MPC and adaptive control

Research and Development ​

  • Biokinetic model development
  • Custom controller algorithms
  • Integration with plant SCADA
  • Machine learning applications

Summary ​

The Tutorials section provides:

  • 2 core-flow tutorials — greenfield and brownfield, project through to an exported BoM
  • 4 simulation tutorials covering advanced process-modelling features
  • Step-by-step instructions with screenshots and examples
  • Multiple learning paths for different professional focuses
  • Real-world examples and case studies
  • Downloadable resources for hands-on practice (simulation tutorials)

Total Tutorial Time: 1.5-2 hours for the core flow; 4-5 hours for a full simulation path

Recommended Approach:

  • Choose a learning path aligned with your work
  • Complete tutorials over several sessions
  • Practice with your own projects between tutorials
  • Return to reference specific techniques as needed

Ready to Start?

Choose your first tutorial:

Or select a learning path above based on your professional role.

Last updated: December 2025Tutorials Overview