2. User manual

• 2.1. Platform installation
  • 2.1.1. Prerequisites
  • 2.1.2. Local installation
    • 2.1.2.1. Full source
    • 2.1.2.2. Modules only
    • 2.1.2.3. Other recommended packages/softwares
  • 2.1.3. Test and examples
    • 2.1.3.1. Unit tests
    • 2.1.3.2. Running examples
  • 2.1.4. MuPIF Basic Infrastructure
    • 2.1.4.1. Wireguard VPN
    • 2.1.4.2. Nameserver
• 2.2. Example: model with inputs and outputs
• 2.3. Example: workflow with two models
• 2.4. Platform APIs
  • 2.4.1. Common API
    • 2.4.1.1. Metadata and metadata schemas
  • 2.4.2. Model class
  • 2.4.3. Workflow class
  • 2.4.4. Property class
  • 2.4.5. Field class
  • 2.4.6. Function class
  • 2.4.7. TimeStep class
  • 2.4.8. Mesh class
  • 2.4.9. Cell class
  • 2.4.10. Vertex class
  • 2.4.11. BoundingBox
  • 2.4.12. HeavyStruct
  • 2.4.13. APIError
• 2.5. Developing Application Program Interface (API)
• 2.6. Developing user workflows
  • 2.6.1. Workflow templates
    • 2.6.1.1. Sequential
    • 2.6.1.2. Loosely coupled
  • 2.6.2. Workflow example
  • 2.6.3. Workflow generator
• 2.7. Distributed Model
  • 2.7.1. Distributed aspects of the API
  • 2.7.2. Requirements for distributed computing
  • 2.7.3. Internal platform solution - ModelServer resource allocation
    • 2.7.3.1. Setting up a Model Server
  • 2.7.4. HPC integration
• 2.8. Using Virtual Private Network (VPN)
  • 2.8.1. Generalities
  • 2.8.2. VPN Set-up
  • 2.8.3. Example of simulation scenario using VPN
  • 2.8.4. Online Monitoring tool
• 2.9. MuPIF resources
• 2.10. References