Several input files are mandatory for an ARCHIMED-φ simulation: the general configuration file (config.yml), the meteorology data (meteo.csv), the models configuration (e.g. plant_coffee.yml), and the scene (e.g. .ops and .opf files). There is also an input file for the physical constants (const.yml) that is optional because ARCHIMED defines default values if not provided.
It is recommended to follow along with the example files provided in the previous page opened in your preferred editor. We recommend Atom or VS Code. They are both open source and have packages to view and edit YAML (.yml), CSV (.csv) and XML files (.ops, .opf and .gwa).
Here is a tree view of the files and folders with a little description for each:
📦
├── 📜config.yml # -> Here is the general configuration file
├── 📜const.yml # -> constants used in the model
├── 📜meteo.csv # -> the meteorology file
├── 📂models # -> all the models configuration files are listed in this folder
│ ├── 📜plant_coffee.yml # An example config for a Coffea plant
│ └── 📜soil.yml # An example soil file
└── 📂scene # -> all the 3D scenes files are listed in this folder
├── 📜coffee.ops # An example scene with one coffee
└── 📂opf # The folder that list the available `.opf` files for the plant geometry
└── 📜coffee.opf # An example coffee plant geometry and topology file)Many input files use the YAML format. It is a data serialization language designed to be directly writable and readable by humans. There are tons of resources on the web (e.g. learnxinyminutes.com, Wikipedia, this blog post), but you should be fine just by seeing the files structure.
The names of the input files are not mandatory, but it is best to keep a rather standard naming nevertheless. For example soil.yml can become soil_1.yml or soil_montpellier.yml, but it is still recommended to keep “soil” in the name.