User/Application guide

[DaJansenGit]

How to run a project (as guide)

Implementation?

• maybe as juypter nodebook?
• do for every plugin, some parts can be done for the base plugin

Content

• How to install?
• How to make sure my environment runs?
• How to create a project directory?
• How to set config.toml?
• How to load an IFC?
• How to select a certain Plugin?
• How to set different sim_setting?
• How to set templates (use conditions etc.)?
• How to run the project?
• How to run the simulation?
• How to analyze the results?
  • what kind of results exist?
  • what programs/tools to use for further analysis? (e.g. boundary conditions for EP)

What is the tool capable of?

• What kind of simulations are covered?
• For each simulation, what are the caveats?
• What is important when analyzing simulation results?

data flow between the different tasks

• what is the input, output of every tasks
• what are the requirements for each task

project structure

• tree of all python files, what is the purpose of each file?
• Input files and settings and what they mean

Target doc structure

├── Big Picture
│   ├── Introduction with picture (Input, Output, Process) very rough
│   ├── How does bim2sim work? (update names of components, link all 
components correctly, workflow -> sim_setting)
│   ├── Simulation types (shorten a bit, copy to ...)
│   ├── Which plugins exist (and what do they do roughly?) (take some parts from current Plugins docs)

├── User Guide
│   ├── Base Plugin
│   │   ├── How to install?
│   │   │   ├── How to make sure my environment runs?
│   │   ├── How to create a project? (take parts from previous first steps)
│   │   ├── How to load an IFC?
│   │   ├── What possibilities to configure a project?
│   │   │   ├── simulation settings
│   │   │   ├── config.toml
│   │   │   ├── default_tasks
│   │   │   ├── additional templates (use conditions)
│   │   │   ├── How to run the project?
│   │   │   ├── How to run the simulation?
│   │   │   ├── How to analyze the results? 
│   │   │   │   ├── what kind of results exist?
│   │   │   │   ├── what programs/tools to use for further analysis? (might not exist for base) 
│   ├── PluginTEASER
│   │   ├── How to install?
│   │   │   ├── How to make sure my environment runs?
│   │   ├── How to create a project? (take parts from previous first steps)
│   │   ├── How to load an IFC?
│   │   ├── What possibilities to configure a project?
│   │   │   ├── simulation settings
│   │   │   ├── config.toml
│   │   │   ├── default_tasks (roughly what is a task, what tasks for this plugin?)
│   │   │   ├── additional templates (use conditions)
│   │   │   ├── How to run the project?
│   │   │   ├── How to run the simulation?
│   │   │   ├── How to analyze the results? 
│   │   │   │   ├── what kind of results exist?
│   │   │   │   ├── what programs/tools to use for further analysis? 
│   ├── PluginEnergyPlus
│   │   ├── How to install?
│   │   │   ├── How to make sure my environment runs?
│   │   ├── How to create a project? (take parts from previous first steps)
│   │   ├── How to load an IFC?
│   │   ├── What possibilities to configure a project?
│   │   │   ├── simulation settings
│   │   │   ├── config.toml
│   │   │   ├── default_tasks
│   │   │   ├── additional templates (use conditions)
│   │   │   ├── How to run the project?
│   │   │   ├── How to run the simulation?
│   │   │   ├── How to analyze the results? 
│   │   │   │   ├── what kind of results exist?
│   │   │   │   ├── what programs/tools to use for further analysis? (e.g. boundary conditions for EP?
│   ├── PluginAixLib
│   │   ├── How to install?
│   │   │   ├── How to make sure my environment runs?
│   │   ├── How to create a project? (take parts from previous first steps)
│   │   ├── How to load an IFC?
│   │   ├── What possibilities to configure a project?
│   │   │   ├── simulation settings
│   │   │   ├── config.toml
│   │   │   ├── default_tasks
│   │   │   ├── additional templates (use conditions)
│   │   │   ├── How to run the project?
│   │   │   ├── How to run the simulation?
│   │   │   ├── How to analyze the results? 
│   │   │   │   ├── what kind of results exist?
│   │   │   │   ├── what programs/tools to use for further analysis? 

├── Simulation Guide
│   ├── What kind of simulations are covered? (extend from big picture)
│   ├── For each simulation, what are the caveats? 
│   ├──  What is important when analyzing simulation results?

├── Advanced User Guide
│   ├── Concepts Guide
│   │   ├── Data flow during a project run
│   │   ├── Every Concepts explained
│   ├── project tree structure (where are these files?
│   │── How to create own plugin? (with initial/starting template) (take from plugins/writing your own bim2sim plugin)

├── Developer Guide
│   ├── How to contribute?
│   ├──Testing
│   ├── Docker image structure (maybe move to user as well)
├── bim2sim (sphinx-api docs) (Code documentation)

Current doc structure

├── Big Picture
├── Installation 
├── First steps
├── Plugins
├── Concepts
├── Testing
├── Docker image structure
├── bim2sim (sphinx-api docs)

[Cudok]

Plugins:

1. The whole installation (including base/core bim2sim) should be part of the installation guide of the specific plugin?
   • I think: only the plugin specific part should be in the plugin part
   • but a link to the base/core installation should be included.
   • the base/core installation is explained in the pluginBASE

[Cudok]

General Question:

1. Is Bim2Sim a framework ?

   • or a Library?
   • How do we want to call it in the documentation?
   • I use framework, for now. I can change it later, if needed.

2. syle of bim2sim, always bim2sim (is always highlighted)

   • i will do it for now. (change it if needed)

[DaJansenGit]

General Question:

1. Is Bim2Sim a framework ?

• or a Library?
• How do we want to call it in the documentation?
• I use framework, for now. I can change it later, if needed.

2. syle of bim2sim, always bim2sim (is always highlighted)

• i will do it for now. (change it if needed)

I agree to both. bim2sim is a framework. In our paper, we are currently working on, we call bim2sim a framework as well.