Creating Projects

How to create and manage projects in ErgoPlanner

Project Types

ErgoPlanner supports several project types:

Type	Description	Use Case
New Project	Blank canvas to build from scratch	Custom plant design
From Template	Pre-built plant configuration	Quick start with standard designs
Import	Load from external file	Migrate existing designs
Clone	Copy existing project	Create variations

Creating a New Project

Step 1: Access New Project

From the Dashboard:

• Click New Project button, or
• Use keyboard shortcut Ctrl + N, or
• Go to File > New Project

Step 2: Enter Project Details

Field	Required	Description
Name	Yes	Project title (max 100 characters)
Description	No	Brief description of the project
Client	No	Client or organization name
Location	No	Plant location (affects ambient conditions)
Design Flow	No	Target design flow (m3/d or MGD)

Step 3: Configure Settings

Calculation Settings:

• Default Mode: Basic or Advanced calculations
• Units: Metric (SI) or Imperial
• Biokinetic Model: ASM1, ASM2d, ASM3, or None

Display Settings:

• Grid Size: Canvas grid spacing
• Snap to Grid: Enable/disable
• Show Labels: Default label visibility

Step 4: Create Project

Click Create Project to open the drawing canvas with your new project.

Creating from Template

Templates provide pre-built plant configurations:

Available Templates

Category	Templates
Tutorial	Simple AS, MLE, SBR basics
Nutrient Removal	MLE, A2O, Bardenpho, UCT
Biofilm Systems	MBBR, IFAS, Trickling Filter
Sludge Treatment	AD, Dewatering, Composting
Small Plants	Package plants, MBR

Using a Template

1. Click New from Template
2. Browse or search templates
3. Preview template details
4. Click Use Template
5. Modify project name and settings
6. Click Create

Templates are fully editable after creation.

Project Structure

Each project contains:

Project/
├── Drawings/
│   ├── Main Process Flow
│   ├── Sludge Treatment
│   └── Additional diagrams
├── Simulation Results/
│   ├── Steady-State
│   └── Dynamic runs
├── Reports/
│   ├── Mass Balance
│   ├── Equipment List
│   └── Custom reports
└── Settings/
    ├── Project settings
    └── Calculation parameters

Managing Projects

Project Dashboard

The dashboard shows all your projects with:

• Thumbnail preview
• Last modified date
• Project status
• Quick actions

The project page

A project opens on tabs (Overview, Engineering, Work items, Planning, Stage Gate, Design basis, Tags, Calculations, Carbon). The Project Assets rail beside them counts what the project holds (drawings, bills of materials, P&ID models, documents, issues and so on) and each row jumps to its tab. The Drawings count includes every drawing in the project, however large its content. The Stage Gate and Design basis tabs are described in A Revision Cycle.

Project Actions

Action	Description
Open	Open project in editor
Rename	Change project name
Duplicate	Create a copy
Archive	Move to archive
Delete	Permanently delete
Export	Download project file
Share	Share with team members

Organizing Projects

Folders:

• Create folders to organize projects
• Drag projects into folders
• Nest folders for hierarchy

Tags:

• Add tags to projects for filtering
• Filter by tag in dashboard
• Multiple tags per project

Favorites:

• Star frequently used projects
• Access from Quick Access panel

Project Settings

Access settings via File > Project Settings or Ctrl + ,

General Settings

Setting	Description
Name	Project display name
Description	Project notes
Client	Associated client
Location	Geographic location

Calculation Settings

Setting	Options	Default
Default Mode	Basic, Advanced	Basic
Biokinetic Model	None, ASM1, ASM2d, ASM3	ASM1
Temperature	5-35 °C	20 °C
Convergence Tolerance	0.001-0.1	0.01

Units

Category	Metric	Imperial
Flow	m³/d	MGD
Concentration	mg/L	mg/L
Volume	m³	ft³
Area	m²	ft²
Mass	kg	lb

Collaboration

For a full walkthrough of sharing, permission levels, live cursors, simultaneous editing, and offline sync see Real-time collaboration.

Sharing Projects

1. Open project settings
2. Go to Sharing tab
3. Add collaborators by email
4. Set permissions:
   • View: Read-only access
   • Edit: Can modify project
   • Admin: Full control

Real-time Collaboration

• Multiple users can edit simultaneously
• Changes sync automatically
• User cursors visible on canvas
• Chat panel for communication

Version History

• Automatic versioning on save
• Browse previous versions
• Restore any version
• Compare versions

Import and Export

Importing Projects

Supported formats:

• .ergo - ErgoPlanner native format
• .json - JSON export format
• .xml - XML configuration

Exporting Projects

1. Go to File > Export
2. Choose format:
   • ErgoPlanner (.ergo): Full project backup
   • JSON: Machine-readable format
   • PDF: Printable documentation
   • DXF: CAD compatible drawings
3. Select export options
4. Click Export

Best Practices

Naming Conventions

Use clear, descriptive names:

• ✅ "Springfield WWTP - Phase 2 Upgrade"
• ❌ "Project 1" or "Test"

Regular Saves

• Autosave is enabled by default
• Manual save with Ctrl + S
• Create checkpoints before major changes

Documentation

• Use project description for notes
• Add annotations to drawings
• Document assumptions in comments

Troubleshooting

Issue	Solution
Can't create project	Check storage quota, verify permissions
Template not loading	Check network connection, try again
Can't find project	Check archive, search all projects
Slow loading	Large project - consider splitting

Next Steps

• Building Process Diagrams - Add units to your project
• Running Simulations - Calculate results
• Templates Overview - Browse available templates