Changelog of DINO-Documentation¶
All notable changes to this project will be documented in this file. The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.
[v10.0.0] - 2025-12-XX¶
Added¶
-
Getting started:
- detailed information on requirements and dependencies
- detailed installation procedure that should be applicable to any HPC system (local installation of dependencies without preinstalled modules)
- a first test simulation of an autoignition with some exemplary post processing in python
-
User Guide:
- code structure overview
- parallelisation Strategy description
- Structure of a DINO simulation including:
- the main input file and all input flag blocks with a detailed description
- the mechanism files containing chemical kinetics
- A short description of IBM geometry input
- initial and restart file description
- a brief description of the output folder and file structure of a DINO simulation
- Tutorials:
- TBD
- Contributing:
- Coding Guidelines: TBD
- Contribute to docs:
- documentation structure
- A detailed description on how to install documentation tools and libraries
- Instructions on how to edit and add documentation pages, style rules, validation before submitting
- License: general DINO license the simple DINO documenter as well as any user or advanced developer agrees to comply to
- Changelog:
- DINO changelog: TBD
- Documentation changelog: a changelog for the DINO documentation has been started and will be kept up to date with the most important contributions
- About:
- An About section, containing short information on the team that is developing DINO
- License: general DINO license the simple DINO user or advanced developer agrees to comply to