Skip to content

EPFL-ENAC/UrbanTethysChloris.jl

UrbanTethysChloris

In development documentation Build Status Test workflow status Lint workflow Status Docs workflow Status Coverage DOI Contributor Covenant All Contributors BestieTemplate

How to Cite

If you use UrbanTethysChloris.jl in your work, please cite using the reference given in CITATION.cff.

Contributing

If you want to make contributions of any kind, please first that a look into our contributing guide directly on GitHub or the contributing page on the website

Example

8 examples across the globe are provided alongside this package, in /examples. Before running the scripts, the Julia environments for the examples must be instantiated with

julia --project=examples -e 'using Pkg; Pkg.instantiate();'

For each example, two scripts are provided: create_<location_name>_data.jl and <location_name>_example.jl.

The first script will create the NetCDF and YAML files containing the parameters and forcing inputs necessary to run the simulation. The first script of a given location can be run from the command line as

julia --project=examples examples/<location_name>/create_<location_name>_data.jl

Subsequent scripts can be run in a similar fashion, by changing the script name.

The second script shows how to run the simulation, given the parameters and forcing inputs, as well as visualizing the results. This last script is best run interactively in the Julia REPL to interact with the results.


Contributors

Son Pham-Ba
Son Pham-Ba

📆 👀
H Solleder
H Solleder

💻 📖 👀