Audience Guide

The Equation platform serves a wide range of users across engineering, development, and operations. This guide will help you identify which sections of the documentation are most relevant to your needs.

👩‍🔧 Engineering Tool Users

Examples: Civil, water, or structural engineers using Equation clients like WaterFuser, Excel, or Grasshopper.

Goals:

• Run calculations via user-friendly interfaces
• Understand calculation outputs
• Integrate results into engineering workflows

Relevant Sections:

• Using the Clients
• WaterFuser Web Client
• Excel Client
• Grasshopper Plugin

👨‍💻 API Developers

Examples: Engineers or developers wrapping calculation logic in APIs.

Goals:

• Expose Python packages as APIs
• Configure OpenAPI specs and authentication
• Deploy and maintain APIs through the platform

Relevant Sections:

• Core Components
• For Developers
• Terraform for Deployment
• API Policies

🛠️ Operations & Platform Maintainers

Examples: Teams managing authentication, access, deployment, and governance.

Goals:

• Ensure platform-wide security and stability
• Support product teams with infrastructure and role setup
• Govern API deployment, usage, and compliance

Relevant Sections:

• Platform Architecture
• Access & Authentication
• Terraform for Deployment