GEOS-Chem code development cycle

From Geos-chem

How GEOS-Chem Code Development works

The GEOS-Chem Steering Committee (GCSC) encourages updates to the GEOS-Chem model. Updates to the GEOS-Chem model benefit both the developer and the entire GEOS-Chem community. The developer benefits through coauthorship and citations. Priority development needs are identified at GEOS-Chem users' meetings with updates between meetings based on GCSC input through working groups.

When should you submit updates to the GEOS-Chem code? Bug fixes should be submitted as soon as possible and will trump all other priorities. Code related to model developments should be submitted when it is mature. Your working group chair can offer guidance on the timing of submitting code to the GCST.

The practical aspects of submitting updates to the GEOS-Chem Support Team are outlined below.

Submitting updates for inclusion into GEOS-Chem

1. First download the GEOS-Chem source code and run directories
2. Add your modifications into the code
3. Test your code thoroughly and make sure that it works
4. Contact the GEOS-Chem Support Team and request that your changes be included in the standard code.
   • We ask that you provide the Support Team with a Git Patch file with your revisions. This will minimize errors in the code transfer process.
   • Be sure to include the following:
     1. Source code
     2. Data files
     3. Documentation
5. The GEOS-Chem Support Team will add your changes to the standard code. Your updates will be included when the next version gets released.
   • Your update will be benchmarked with a 1-month full-chemistry simulation.
   • Upon completion of the 1-month full-chemistry benchmark, you will be asked to view the output from the simulation and fill in a Benchmark Assessment Form.
   • The 1-month full-chemistry benchmark results must be approved by Model Scientist Daniel Jacob and the GEOS-Chem Steering Committee before the benchmark simulation is approved.
6. If the update is for an offline chemistry simulation (e.g. CO2, CH4, Hg), then a further benchmark may be conducted by the appropriate Working Group.
7. 1-year full-chemistry benchmark simulations will be conducted by the GEOS-Chem Support Team before the version is officially released to the GEOS-Chem user community:
   • The GEOS-Chem Support Team One or more 1-year full-chemistry benchmarks (global 4° x 5° grid). The GEOS-Chem Steering Committee must approve the benchmark results before the version is released.
   • The Nested Model Working Group will performed a North-American Nested Grid benchmark simulation, in order to ensure that all software updates made for the forward model do not affect the nested model.

--Bob Y. 15:01, 15 February 2012 (EST)