assimfolder contains assimilation post-processingconfcontains configuration files for research toolsDATAcontains no code but files frequently usedevalscontains routines to extract data for further evaluations (which are not in this folder...)fortrancontains interpolation tools including tools for managing solar masksplotscontains a lot of useful classes for plottingscoresis a set of routines to compute scores both for deterministic or ensemble simulationsscriptsare a set of scripts to get simulation filestaskscontains the typical sequence of instructions necessary to run a full simulation, both in operational or research modetoolscontains all the classes and methods shared by the vortex project and standalone applications. It is all the physics and links between simulation elements.utilsis a set of technical tools to help manipulating simulation objects (read and convert files, sun trajectory, etc.). Please check the tool your need is not already in bronx.bronxis an external package that contains a lot of useful tools (this package is now an external package that have to be installed separately)
A folder tests contains the test suite of snowtools and the doc folder contains this documentation code.
Note that the different folder have close relationships:
- The contents of
utilsandbronxcan be imported in any other part of the project. - The contents of
toolsshould be imported only by modules oftasksor directly by Vortex - The contents of
tasksandplotsmust never be imported intoolsandutils. - The contents of
testsmust not be imported anywhere else in the project. bronxmust stay an independent module. It cannot import any other module of the project.- Vortex call only
toolsandutilstasks might call some Vortex facilities some day