|
|
| Line 4: |
Line 4: |
| |DocumentationCategory=Model Documentation | | |DocumentationCategory=Model Documentation |
| }} | | }} |
|
| |
|
| |
| = Model presentations =
| |
| Some videos of live presentations of WITNESS model are available on [https://www.witness4climate.org/witness-presentations/ witness4climate.org] website.
| |
|
| |
| = Reference documentation =
| |
| WITNESS reference documentation is located directly in the [https://github.com/orgs/os-climate/repositories?q=witness source GitHub repositories], in a "documentation" folder next to the source code for each discipline.
| |
|
| |
| Let's for example, consider the [https://github.com/os-climate/witness-core/tree/main/climateeconomics/sos_wrapping/sos_wrapping_witness/population/ population model] folder in GitHub:
| |
|
| |
| [[File:Population github folder snapshot.png|alt=Population github folder snapshot|896x896px]]
| |
|
| |
| The documentation markup file can be displayed directly in the tool in the "Documentation tab" for each discipline:
| |
| [[File:Population documentation in GitHub.png|alt=Population documentation in GitHub|none|thumb|578x578px|Population documentation in GitHub]]
| |
| and will also be available in the tool in the "Documentation" tab for the discipline:
| |
| [[File:Population documentation in SoSTrades.png|alt=Population documentation in SoSTrades|none|thumb|752x752px|Population documentation in SoSTrades]]
| |
|
| |
|
| |
| References and links to academic papers / reference dataset used are listed at the end of these disciplines documentation pages.
| |
|
| |
| = Installation documentation =
| |
| Installation documentation for standalone laptop installation can be found [https:///sostrades-dev-tools.readthedocs.io/en/latest/installation.html here].
| |
|
| |
| Local classical installation or as a Docker component is available for Linux, Mac and Windows.
| |
|
| |
| For a full cloud installation with DevSecOps of models, please contact the project [mailto:contact@sostrades.org here] :-)
| |
|
| |
| = Developer's documentation =
| |
| A draft developer's documentation is available [https:///sostrades-core.readthedocs.io/en/integration/ here].
| |
|
| |
| User and developer's MOOC are planned to be developed and will be hosted by Linux Foundation.
| |
|
| |
| = Support =
| |
| Support sessions are organised for users ("Come as you are" sessions) and for developers ("Code as you are" sessions).
| |
|
| |
| Please check [https:///www.witness4climate.org/events/ here] for next sessions and registration.
| |
Note: The documentation of WITNESS is 'in preparation' and is not yet 'published'!
Note: The documentation of WITNESS is 'in preparation' and is not yet 'published'!