ErgoPlanner

Appearance

Getting Started with ErgoPlanner ​

Welcome to ErgoPlanner, the comprehensive wastewater treatment plant simulation platform. This section will help you get up and running quickly.

What is ErgoPlanner? ​

ErgoPlanner is a modern, web-based simulation platform for wastewater treatment plants that combines:

  • Process Design: Drag-and-drop interface for building treatment plant diagrams
  • Advanced Simulation: Steady-state and dynamic simulation with multiple biokinetic models
  • Carbon Footprint: Comprehensive Scope 1/2/3 emissions tracking
  • Results Analysis: Interactive charts, tables, and data export capabilities

Quick Navigation ​

Essential First Steps ​

  1. Installation - Browser requirements and deployment options (5 min)
  2. First-Simulation - Complete your first simulation (15 min)
  3. Interface-Overview - Learn the UI layout and navigation (10 min)

Reference Materials ​

  1. Keyboard-Shortcuts - Productivity shortcuts reference
  2. Account-Setup - Preferences and settings configuration
  3. Finding-Things - What the top-bar search box searches, and what it does not

Learning Path ​

For New Users ​

  1. Start with Installation to ensure your environment is ready
  2. Follow First-Simulation step-by-step to understand the workflow
  3. Review Interface-Overview to learn where everything is located
  4. Explore User-Guide for detailed workflow documentation

For Experienced Engineers ​

  1. Skim Installation and Interface-Overview
  2. Jump directly to Creating-Projects
  3. Review Biokinetic-Models for advanced model configuration
  4. Check Model-Calibration for optimization techniques

What You'll Learn ​

Basic Skills (30 minutes) ​

  • Creating and managing projects
  • Building process diagrams using drag-and-drop
  • Running steady-state simulations
  • Viewing and interpreting results

Intermediate Skills (1-2 hours) ​

  • Configuring biokinetic models (ASM1, ASM2d, ASM3)
  • Setting up dynamic simulations with time-series data
  • Using controllers for automated process control
  • Exporting data and generating reports

Advanced Skills (2-4 hours) ​

  • Model calibration and parameter tuning
  • Multi-scenario sensitivity analysis
  • Carbon footprint analysis and optimization
  • Performance optimization for large models

System Requirements ​

Minimum Requirements ​

  • Modern web browser (Chrome 90+, Firefox 88+, Edge 90+, Safari 14+)
  • 4 GB RAM
  • 1280x720 screen resolution
  • Stable internet connection (for cloud deployment)
  • Chrome 120+ or Edge 120+ (best performance)
  • 8 GB RAM or more
  • 1920x1080 or higher resolution
  • Modern GPU for smooth canvas rendering

Browser Compatibility ​

BrowserMinimum VersionRecommendedNotes
Chrome90+120+Best performance and feature support
Firefox88+115+Full feature support
Edge90+120+Chromium-based, excellent support
Safari14+17+Limited testing, some features may vary

Getting Help ​

Documentation Resources ​

Support Channels ​

  • Technical Documentation: This wiki
  • API Reference: API-Reference for developers
  • Issue Tracker: Report bugs and request features
  • Community Forum: Ask questions and share knowledge

Common First-Time Questions ​

"Do I need to install anything?" ​

No! ErgoPlanner runs entirely in your web browser. Just navigate to the deployment URL and start working. See Installation for browser requirements.

"Can I try it without creating an account?" ​

Yes, you can explore demo projects and run simulations without an account. However, creating an account is recommended to save your work. See Account-Setup.

"What if I've never used simulation software before?" ​

Perfect! Start with First-Simulation which guides you through a complete example. No prior experience needed.

"How long does it take to learn?" ​

Most users can run their first simulation within 15 minutes. Building proficiency with advanced features typically takes 4-8 hours of practice.

"Can I import data from other software?" ​

ErgoPlanner supports various import formats including CSV for time-series data and JSON for project templates. See Exporting-Data for details.

Next Steps ​

Ready to get started? Choose your path:

Follow our complete getting started sequence:

  1. Installation - Set up your environment
  2. First-Simulation - Run your first simulation
  3. Interface-Overview - Learn the interface

Path 2: Jump Right In ​

For experienced users who want to start immediately:

  1. Check Installation requirements (2 min)
  2. Go to Creating-Projects (start building)
  3. Reference Keyboard-Shortcuts as needed

Path 3: Explore Examples ​

Want to see what's possible first?

  1. Browse Templates for pre-built examples
  2. Open a template project
  3. Explore the interface using Interface-Overview

Estimated Time to Complete This Section: 30-45 minutes

Difficulty Level: Beginner

Prerequisites: None - start here!

Last updated: December 2025