2. How to Extend

Our software is designed to be modular and extensible. As an open-source project, we are happy to welcome contributions from the community.

If you would like to contribute, checkout our GitHub repositories at |GitHub| and familiarize yourself with the below resources:

• 2.1. Software Architecture
  • 2.1.1. R2D Workflows
    • 2.1.1.1. Choosing Component Applications
• 2.2. C4 Model of the SimCenter Ecosystem
  • 2.2.1. Level 1: Context Diagram
  • 2.2.2. Level 2: Container Diagram
  • 2.2.3. Level 3: Component Diagram
  • 2.2.4. Level 4: Code Diagram
  • 2.2.5. UML EE-UQ
  • 2.2.6. UML WE-UQ
  • 2.2.7. UML HydroUQ
  • 2.2.8. UML PBE
  • 2.2.9. UML EarthquakeEvents
  • 2.2.10. UML WindEvents
  • 2.2.11. UML HydroEvents
  • 2.2.12. UML SimCenterCommon
  • 2.2.13. UML SimCenterBackendApplications
• 2.3. Backend Applications
• 2.4. Creating Workflows
  • 2.4.1. Workflow Structure
  • 2.4.2. Reading the Log File
  • 2.4.3. Choosing Component Applications
• 2.5. Running Manually
  • 2.5.1. Run Locally on Your Desktop
  • 2.5.2. Run Remotely on DesignSafe
    • 2.5.2.1. Prepare Input Files
    • 2.5.2.2. Run Job Through Jupyter
    • 2.5.2.3. Submit Job Through Tapis
  • 2.5.3. Troubleshooting Errors
• 2.6. File Types and Schemas
  • 2.6.1. Inputs
    • 2.6.1.1. Configuration File
    • 2.6.1.2. Building Source File
    • 2.6.1.3. Transportation Network Source File Option 1
    • 2.6.1.4. Model File
    • 2.6.1.5. EDP specifications file
    • 2.6.1.6. Event Files
  • 2.6.2. Outputs
    • 2.6.2.1. EDP Output File
    • 2.6.2.2. DM Output File
    • 2.6.2.3. DV Output File
• 2.7. Coding Style
  • 2.7.1. Python Style
  • 2.7.2. C/C++ Style
  • 2.7.3. Comments
  • 2.7.4. Naming Conventions
  • 2.7.5. Files and Interfaces
  • 2.7.6. Variable