ErgoPlanner

Appearance

User Guide ​

Comprehensive documentation for common ErgoPlanner workflows and operations.

Overview ​

This User Guide covers the complete ErgoPlanner workflow from project creation through simulation execution and results analysis. Each guide provides step-by-step instructions with examples and best practices.

Quick Navigation ​

Project Setup ​

Simulation ​

AI Agents ​

  • Agent-Chat - Ask the agents; replies stream in and can be stopped

Analysis and Export ​

Workflow Overview ​

The typical ErgoPlanner workflow follows these stages:

1. Create Project → 2. Build Diagram → 3. Configure Units → 4. Run Simulation → 5. Analyze Results → 6. Export Data

Stage 1: Project Creation ​

Start by creating a new project from scratch or using a template. Projects organize your work and store all configurations, diagrams, and results.

Time Required: 2-5 minutes See: Creating-Projects

Stage 2: Diagram Building ​

Build your process diagram by dragging units onto the canvas and connecting them with streams. The diagram represents the physical layout of your treatment plant.

Time Required: 10-30 minutes (depending on complexity) See: Building-Process-Diagrams

Stage 3: Configuration ​

Configure each process unit with operating parameters, influent characteristics, and biokinetic model settings.

Time Required: 15-45 minutes See: Running-Simulations (Configuration section)

Stage 4: Simulation ​

Run steady-state or dynamic simulations to calculate process performance, mass balances, and effluent quality.

Time Required: 30 seconds to 10 minutes See: Running-Simulations, Dynamic-Simulation

Stage 5: Analysis ​

Review results, check mass balances, verify effluent compliance, and identify optimization opportunities.

Time Required: 10-30 minutes See: Analyzing-Results

Stage 6: Export ​

Export results as PDF reports, CSV data for external analysis, or JSON templates for reuse.

Time Required: 2-5 minutes See: Exporting-Data

Guide Descriptions ​

Creating Projects ​

Learn how to create new projects, select and use templates, configure project properties, and manage project organization. Covers both starting from scratch and using pre-built templates.

Key Topics:

  • New project wizard
  • Template selection and customization
  • Project properties and metadata
  • Project organization and folders
  • Importing existing projects

Difficulty: Beginner Estimated Time: 10 minutes

Building Process Diagrams ​

Master the drag-and-drop interface for creating process diagrams. Learn to add process units, create connections, organize layouts, and use the shapes library.

Key Topics:

  • Process units library navigation
  • Drag-and-drop unit placement
  • Stream connections and routing
  • Canvas navigation and zoom
  • Alignment and layout tools
  • Copy, paste, and duplicate
  • Grouping and naming

Difficulty: Beginner to Intermediate Estimated Time: 20 minutes

Running Simulations ​

Complete guide to setting up and executing steady-state simulations. Covers solver selection, convergence settings, parameter configuration, and troubleshooting failed simulations.

Key Topics:

  • Simulation type selection
  • Solver configuration (Newton-Raphson, Successive Substitution)
  • Convergence criteria and tolerance
  • Initial guess strategies
  • Monitoring simulation progress
  • Convergence troubleshooting
  • Saving simulation configurations

Difficulty: Intermediate Estimated Time: 30 minutes

Dynamic Simulation ​

Advanced guide for time-varying simulations. Learn to configure dynamic inputs, set simulation duration, use time-series data, and analyze temporal results.

Key Topics:

  • Dynamic vs steady-state comparison
  • Time-step selection
  • Dynamic influent configuration
  • Controller integration
  • Time-series data import
  • Temporal results visualization
  • Event-based scenarios (storms, upsets)

Difficulty: Advanced Estimated Time: 45 minutes

Analyzing Results ​

Comprehensive guide to interpreting simulation results. Learn to read charts, verify mass balances, check effluent compliance, and identify process issues.

Key Topics:

  • Results dashboard overview
  • Effluent quality assessment
  • Mass balance verification
  • Unit performance metrics
  • Chart and graph interpretation
  • Comparing scenarios
  • Identifying optimization opportunities
  • Results filtering and search

Difficulty: Intermediate Estimated Time: 25 minutes

Exporting Data ​

Learn all export options including PDF reports, CSV data files, JSON templates, and integration with external tools.

Key Topics:

  • PDF report generation and customization
  • CSV data export for Excel/Python
  • JSON template creation and sharing
  • Export configurations and presets
  • Batch export for multiple scenarios
  • Integration with BI tools
  • Automated reporting

Difficulty: Beginner to Intermediate Estimated Time: 20 minutes

Common Workflows ​

Workflow 1: Simple Plant Evaluation (30 min) ​

Evaluate treatment performance for a simple plant configuration.

  1. Creating-Projects - Create from "Basic AS" template (3 min)
  2. Running-Simulations - Configure and run steady-state (10 min)
  3. Analyzing-Results - Review effluent quality (10 min)
  4. Exporting-Data - Generate PDF report (5 min)

Workflow 2: Custom Plant Design (2 hours) ​

Design a new treatment plant from scratch.

  1. Creating-Projects - Create blank project (3 min)
  2. Building-Process-Diagrams - Build custom layout (45 min)
  3. Running-Simulations - Configure biokinetic models (30 min)
  4. Analyzing-Results - Optimize design (30 min)
  5. Exporting-Data - Document design (10 min)

Workflow 3: Storm Event Analysis (1 hour) ​

Analyze plant performance during wet weather.

  1. Creating-Projects - Start from existing project (2 min)
  2. Dynamic-Simulation - Configure storm hydrograph (20 min)
  3. Dynamic-Simulation - Run dynamic simulation (10 min)
  4. Analyzing-Results - Analyze temporal results (20 min)
  5. Exporting-Data - Export time-series data (5 min)

Workflow 4: Multi-Scenario Comparison (3 hours) ​

Compare multiple design alternatives or operating strategies.

  1. Creating-Projects - Create base project (5 min)
  2. Building-Process-Diagrams - Build base configuration (30 min)
  3. Running-Simulations - Run base case (10 min)
  4. Duplicate project for each scenario (15 min)
  5. Modify and run each scenario (60 min)
  6. Analyzing-Results - Compare all scenarios (45 min)
  7. Exporting-Data - Generate comparison report (15 min)

Tips for Efficient Use ​

Keyboard Shortcuts ​

Master keyboard shortcuts for faster workflow. See Keyboard-Shortcuts for complete reference.

Essential Shortcuts:

  • Ctrl+S - Save project
  • Ctrl+R - Run simulation
  • Ctrl+Z / Ctrl+Y - Undo/Redo
  • Ctrl+C / Ctrl+V - Copy/Paste units
  • Delete - Delete selected units
  • Ctrl+G - Toggle grid
  • Space+Drag - Pan canvas

Templates and Reuse ​

Create custom templates for frequently used configurations:

  1. Build and configure a project completely
  2. File → Save as Template
  3. Reuse the template for similar projects

Saves 30-60 minutes per project!

Batch Operations ​

When working with multiple scenarios:

  • Use project duplication instead of recreating
  • Configure export presets for consistent reporting
  • Use JSON templates for bulk configuration changes
  • Set up simulation configurations once, reuse across scenarios

Organization ​

Keep projects organized:

  • Use clear, descriptive project names
  • Add project descriptions and metadata
  • Organize projects into folders by client/plant
  • Tag projects for easy searching
  • Archive completed projects

Skill Progression ​

Beginner (0-5 hours experience) ​

Focus on these guides:

  1. Creating-Projects
  2. Building-Process-Diagrams (basics)
  3. Running-Simulations (basic steady-state)
  4. Analyzing-Results (effluent quality only)
  5. Exporting-Data (PDF reports)

Goal: Successfully run a steady-state simulation and generate a report.

Intermediate (5-20 hours experience) ​

Expand to:

  1. Building-Process-Diagrams (advanced layouts)
  2. Running-Simulations (solver tuning)
  3. Analyzing-Results (full analysis)
  4. Exporting-Data (CSV, templates)
  5. Biokinetic-Models
  6. Controller-Setup

Goal: Design custom plant configurations and optimize performance.

Advanced (20+ hours experience) ​

Master all features:

  1. Dynamic-Simulation
  2. Multi-Scenario
  3. Model-Calibration
  4. Carbon-Footprint
  5. Performance-Tips

Goal: Conduct comprehensive plant analysis with calibration and optimization.

Integration with Other Sections ​

Support and Resources ​

Getting Help ​

If you're stuck on any workflow:

  1. Check Troubleshooting for common issues
  2. Search this wiki for specific topics
  3. Review relevant Tutorials for detailed examples
  4. Consult API-Reference for advanced integration

Providing Feedback ​

Help improve these guides:

  • Report errors or unclear instructions
  • Suggest additional workflows
  • Request new examples
  • Share your use cases

Summary ​

This User Guide section provides comprehensive workflow documentation for:

  • 6 core workflows covering the complete ErgoPlanner process
  • Step-by-step instructions with examples and screenshots
  • Time estimates for planning your work
  • Difficulty levels for self-paced learning
  • Integration with tutorials and best practices

Estimated Time to Review All Guides: 2-3 hours

Recommended Approach: Read guides as-needed for specific tasks, not all at once.

Next Steps:

Last updated: December 2025User Guide Overview