Skip to main content

Welcome to InForm Documentation

Welcome to the comprehensive documentation for the InForm parametric design exploration platform. This documentation serves both platform users who explore designs and engineers/developers who create and deploy parametric models.

What is InForm?​

InForm is Arup's web-based parametric design exploration platform that bridges the gap between computational design and interactive exploration. The platform enables:

  • Real-time 3D Visualization: Interactive Unity WebGL-based 3D models
  • Parametric Exploration: Adjust design parameters and see immediate results
  • Performance Analysis: Integrated analysis and optimization tools
  • Collaborative Design: Team-based exploration and decision-making
  • Cloud-Based Computation: Scalable RhinoCompute backend processing

Platform Architecture​

InForm consists of several integrated components:

  • Frontend Application: React-based web interface with Unity WebGL visualization
  • Grasshopper Integration: Parametric models created in Grasshopper and deployed to the cloud
  • RhinoCompute Backend: Server-side computational engine for model evaluation
  • Azure Functions: API services and business logic
  • Collaborative Tools: Real-time sharing, commenting, and variant management

Who This Documentation Is For​

👥 Platform Users​

For designers, engineers, and stakeholders who explore parametric designs:

  • Getting Started: Learn to navigate and use the InForm interface
  • Design Exploration: Master techniques for effective parametric exploration
  • Analysis Tools: Understand visualization, comparison, and analysis features
  • Collaboration: Work effectively with teams on design projects

Start here: User Getting Started Guide

🔧 Engineers & Developers​

For computational designers and developers who create InForm experiences:

  • Model Development: Build parametric models in Grasshopper for InForm
  • Script Deployment: Upload and configure models for web-based exploration
  • Performance Optimization: Ensure fast, responsive user experiences
  • API Integration: Extend InForm functionality with custom integrations

Start here: Developer Overview

Quick Start Paths​

For First-Time Users​

  1. Sign in and explore a sample project
  2. Learn the interface and basic navigation
  3. Try parameter exploration techniques
  4. Compare design variants effectively

For Model Creators​

  1. Set up your development environment
  2. Create your first parametric model
  3. Deploy and test your model
  4. Optimize performance for users

For Technical Integration​

  1. Understand the API structure and capabilities
  2. Review authentication requirements
  3. Explore component documentation for UI integration
  4. Study the architecture for advanced customization

Key Features and Capabilities​

Real-Time Parametric Exploration​

  • Interactive 3D Models: Navigate and examine designs in 3D space
  • Dynamic Parameters: Adjust sliders and see immediate geometric updates
  • Performance Feedback: Real-time analysis results and constraint validation
  • Visual Feedback: Color coding, heat maps, and data visualization

Advanced Analysis Tools​

  • Parameter Space Analysis: Visualize the full design space
  • Multi-Objective Optimization: Balance competing design goals
  • Sensitivity Analysis: Understand parameter importance and relationships
  • Constraint Visualization: See feasible and infeasible design regions

Collaboration and Sharing​

  • Real-Time Collaboration: Multiple users exploring simultaneously
  • Variant Management: Save, organize, and share interesting designs
  • Structured Reviews: Formal evaluation and feedback processes
  • Project Sharing: Control access and permissions for team members

Integration Capabilities​

  • Grasshopper Models: Direct deployment from Grasshopper definitions
  • External Analysis: Integration with structural, environmental, and cost analysis
  • Data Export: Extract results for further analysis or reporting
  • API Access: Programmatic access for custom applications

Platform Components​

Core Components​

This documentation includes interactive examples and API references for InForm's component library:

API Reference​

Comprehensive API documentation for developers:

Repository Integration​

This documentation is directly connected to the inform-frontend repository and automatically imports components for interactive examples. The documentation stays synchronized with the latest component implementations, ensuring accuracy and relevance.

Live Examples​

Throughout this documentation, you'll find:

  • Interactive component examples: Test components with real data
  • Live code samples: See implementation details and usage patterns
  • API demonstrations: Test API endpoints and see responses
  • Configuration examples: Real-world setup and deployment scenarios

Getting Help and Support​

Documentation Resources​

Community and Support​

  • Community Forums: Connect with other InForm users and developers
  • Training Sessions: Regular workshops and guided learning
  • Expert Consultation: Access to the InForm development team
  • Support Channels: Direct technical support for complex issues

Contributing to Documentation​

This documentation is continuously improved based on user feedback and platform evolution:

  • Report Issues: Identify unclear or outdated content
  • Suggest Improvements: Recommend additional topics or examples
  • Share Use Cases: Contribute real-world examples and best practices
  • Community Contributions: Help improve documentation for everyone

What's Next?​

Choose Your Path​

Stay Updated​

  • Platform Updates: New features and improvements
  • Best Practices: Evolving techniques and approaches
  • Community Insights: Learn from other users and developers
  • Training Opportunities: Skill development and certification

Welcome to InForm! Whether you're exploring designs or creating them, this documentation will help you make the most of the platform's powerful capabilities.

If you're using the InForm application:

  1. Explore the Compare View features to understand available options
  2. Learn about plugin configurations to customize your experience

Interactive Examples​

Each component documentation includes:

  • Live Preview: See the component in action
  • Configuration Editor: Modify JSON configuration in real-time
  • API Documentation: Complete type definitions and usage examples

Contributing​

This documentation is automatically generated from the main InForm repository. To contribute:

  1. Make changes to components in the main repository
  2. Update documentation files in this repository
  3. Submit pull requests to both repositories

Support​

For questions or issues:

  • Check the GitHub repository
  • Review existing issues and discussions
  • Create a new issue with detailed information