Newer
Older
==============================
= GENERALITIES
==============================
ToyCTM is a free software distributed under the GNU general public licence v2.0 (see LICENCE file).
Users of this model are kindly requested to use the following doi to cite toyCTM:
https://doi.org/10.5281/zenodo.7786032
This software aims at providing an evolutive and modular python framework for idealized chemistry-transport
studies in a research or educational context. It is not aimed at providing a forecast or analysis tool,
neither at representing realistic cases.
Contact address: sylvain_mailler@lmd_ipsl_fr [replace all underscore by dots (.)]
==============================
= MODEL AVAILABILITY
==============================
The released versions are listed here:
https://gitlab.in2p3.fr/ipsl/lmd/intro/toyctm/-/releases
The latest development version can be downloaded at:
https://gitlab.in2p3.fr/ipsl/lmd/intro/toyctm/-/archive/master/toyctm-master.tar.gz
toyctm-master version should work at any time but the README is not necessarily up to date
and may not reflect the actual state of the model.
For such development version, the user should use the script examples in .gitlab-ci.yml
as working examples of model use.
Issues can be reported here:
https://gitlab.in2p3.fr/ipsl/lmd/intro/toyctm/-/issues
Users of this model are kindly requested to use the following doi to cite toyCTM:
https://doi.org/10.5281/zenodo.7786032
==============================
= GET STARTED
==============================
ToyCTM is designed for Python 3.x and depends only on numpy for the core of the model.
A few other modules (essentially matplotlib for graphic outputs) are requested for the test cases..
1. Download archive of the latest released version from:
https://gitlab.in2p3.fr/ipsl/lmd/intro/toyctm/-/releases
2. Uncompress the toyCTM archive and go into the directory into
which the archive has been deflated (normally toyctm-v1.0.1/)
3. Try some of the provided test cases. For example,
python CItest-leighton-radicals.py
and then have a look at artifacts/leighton-CO.png :
this should look like examples/leighton-CO.png
This represents the evolution of a simplified 0d stiff chemical system
with CO, NOx and radicals, in perpetual daylight, for 300.000 s
python CItest-xz.py --geometry flat --windfield Shearedflat --nx 40 --nz 24 --transport_scheme ppmSL --vtransport_scheme DL99 --target_CFL 0.5 --ini_type unifcolumn --label test3 --trapezSolution True --makeplots False
artifacts/TRCslice_172800_test3.png should be similar to Fig. 1d in Mailler et al. 2021
(https://gmd.copernicus.org/articles/14/2221/2021/gmd-14-2221-2021-f01-web.png)
artifacts/TRCslice_exact_172800_test3.png should be similar to Fig. 1e in Mailler et al. 2021 (same link)
The description of this case can be found in that article: https://doi.org/10.5194/gmd-14-2221-2021
More examples of test scripts can be found in .gitlab-ci.yml . The command lines to
run these scripts are found in each line after 'script:', e.g.
python CItest-MRconservation.py > artifacts/adv.log
python CItest-chem.py > artifacts/chemlog
etc. etc.
Do not hesitate to share comments, needs for improvements or questions with the authors of this software.
Contact address: sylvain_mailler@lmd_ipsl_fr [replace all underscore by dots (.)]