ErgoPlanner

Appearance

Frequently Asked Questions ​

Common questions about ErgoPlanner

Getting Started ​

How do I create my first project? ​

  1. Click New Project on the dashboard
  2. Enter project name and settings
  3. Click Create
  4. Drag process units from the stencil panel onto the canvas
  5. Connect units with streams
  6. Run simulation

See Quick Start Guide for a detailed walkthrough.

What are the system requirements? ​

  • Browser: Chrome 90+, Firefox 88+, Safari 14+, Edge 90+
  • RAM: 8 GB minimum, 16 GB recommended
  • Display: 1280x720 minimum, 1920x1080 recommended
  • Internet: Required for cloud features

Can I work offline? ​

Currently, ErgoPlanner requires an internet connection. Offline mode is planned for future releases.

Simulation ​

Why isn't my simulation converging? ​

Common causes and solutions:

CauseSolution
Disconnected unitsVerify all streams connected
Unrealistic parametersCheck influent composition
Large recycle loopsProvide initial guesses
Stiff kineticsReduce time step (dynamic)

What's the difference between Basic and Advanced mode? ​

  • Basic: Fixed efficiency calculations, fast, suitable for preliminary design
  • Advanced: Full biokinetic models (ASM1/2d/3, ADM1), detailed simulation

See Calculation Modes.

How do I add controllers? ​

  1. Add the controlled unit to your diagram
  2. Go to Simulation > Controllers
  3. Click Add Controller
  4. Configure controller type, setpoint, and tuning
  5. Run simulation to verify

See Controllers Overview.

Why are my effluent results different from expected? ​

Check:

  1. Influent composition - all parameters defined?
  2. Calculation mode - Basic vs Advanced
  3. Temperature - affects kinetics significantly
  4. SRT - adequate for nitrification?
  5. Return rates - RAS, IRR configured correctly?

Process Design ​

How do I size a clarifier? ​

  1. Select clarifier unit
  2. Click Design Wizard
  3. Enter design flow and loading criteria
  4. Review calculated dimensions
  5. Accept or modify

See Design Calculations.

Which biokinetic model should I use? ​

ProcessRecommended Model
COD removal onlyASM1 or Basic
Nitrogen removalASM1
N + P removalASM2d
Storage kineticsASM3
Anaerobic digestionADM1

How do I model SBR cycles? ​

  1. Add SBR reactor unit
  2. Configure cycle phases (fill, react, settle, decant)
  3. Set phase durations and aeration patterns
  4. Use TimeOnOff controller for automation

Results and Reporting ​

How do I view mass balance? ​

  1. Run simulation
  2. Go to View > Mass Balance
  3. Select parameters to display
  4. Export as Excel or PDF

How do I export results? ​

  1. File > Export Results
  2. Select format (CSV, Excel, PDF)
  3. Choose data to include
  4. Click Export

Can I generate design reports? ​

Yes! Go to File > Generate Report and select:

  • Design Summary
  • Mass Balance Report
  • Equipment Schedule
  • Compliance Report

Data and Files ​

How do I save my project? ​

Projects save automatically to the cloud. You can also:

  • Press Ctrl + S for manual save
  • Export as .ergo file for backup
  • Export as JSON for external use

Can I import from other software? ​

Currently supported:

  • JSON configuration files
  • CSV data import
  • Template import

How do I share a project? ​

  1. Open project settings
  2. Go to Sharing tab
  3. Add collaborators by email
  4. Set permissions (View/Edit/Admin)

Account and Subscription ​

How do I change my password? ​

  1. Click your username in the header
  2. Select Account Settings
  3. Go to Security tab
  4. Click Change Password

What's included in the free tier? ​

  • Up to 3 projects
  • Basic calculation mode
  • Limited export options
  • Community support

How do I upgrade my plan? ​

  1. Go to Account Settings
  2. Select Subscription
  3. Choose your plan
  4. Complete payment

Technical Issues ​

The application is running slowly ​

Try:

  1. Close other browser tabs
  2. Clear browser cache
  3. Reduce canvas zoom level
  4. Simplify large diagrams
  5. Use a supported browser

I can't connect units ​

Check:

  • Port types match (liquid/sludge/gas)
  • Unit not locked
  • Canvas not in read-only mode

Simulation keeps stopping ​

Look for:

  • Error messages in console
  • Convergence issues
  • Invalid parameter values
  • Memory limitations

Getting Help ​

Where can I get support? ​

  • Documentation: This wiki
  • FAQ: You're reading it!
  • GitHub Issues: Bug reports and features
  • Community Forum: Discussion and tips

How do I report a bug? ​

  1. Go to GitHub Issues
  2. Click New Issue
  3. Select Bug Report template
  4. Provide:
    • Description of problem
    • Steps to reproduce
    • Expected vs actual behavior
    • Browser and OS info

How do I request a feature? ​

  1. Go to GitHub Issues
  2. Click New Issue
  3. Select Feature Request template
  4. Describe the feature and use case