tcbbcc / geos-chem

Source code repository for the GEOS-Chem model of atmospheric chemistry and composition.

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

README for the GEOS-Chem Source code repository

This repository (https://github.com/gcst/geos-chem) contains the source code for the GEOS-Chem model of atmospheric chemistry and composition.




Important notes

We have migrated from Bitbucket to Github!

As of June 2018, we have migrated the GEOS-Chem source code repository to back Github. Going forward, please make sure to clone or pull code updates ONLY from this repository.

The GEOS-Chem version numbering scheme is changing!

We are migrating to a purely numeric versioning system in order to adhere more closely to software development best practices. In order to facilitate the switchover between versioning systems, the GEOS-Chem v11-02-final version will also carry the designation GEOS-Chem 12.0.0.

For a complete description of the new versioning system, please see our GEOS-Chem version numbering system wiki page: http://wiki.geos-chem.org/GEOS-Chem_version_numbering_system




GEOS-Chem Development

Branches

This repository contains several branches, each of which contains several code updates belonging to a particular line of development. In particular you will see:

  • The master branch always contains the last benchmarked version. You should never add new code directly into this branch. Instead, open a new branch off of master and add your code there.

  • The Dev branch always contains in-development code for the next version to be benchmarked. Code in Dev is very much "work in progress" and should not relied upon until it has been debugged and benchmarked.

  • The GEOS branch contains updates that are specific to the interface between GEOS-Chem and the NASA GEOS-DAS Earth System Model. Most GEOS-Chem users can simply ignore this branch.

  • From time to time, you will see other branches pertaining to new lines of development being created. Once the code in these branches has been sufficiently validated, these branches will be merged back into the master branch.

Versions

GEOS-Chem versions correspond to those points in the code development history where benchmark simulations were performed in order to validate the scientific output of GEOS-Chem. All versions are benchmarked with a 1-month simulation; some versions are benchmarked with both 1-month and 1-year simulations. To learn more about GEOS-Chem versions and the features and/or bug fixes they contained, please visit the GEOS-Chem wiki pages listed below.

For versions GEOS-Chem v11-02a through GEOS-Chem v11-02-release-candidate, see:

For GEOS-Chem 12.*.* versions, see:

All benchmarked GEOS-Chem versions are tagged in the Git history. Use git tag in your terminal to see a list of available tags. Tags will also be highlighted in the gitk browser window.

Special version names to note

A couple of special version names are noted below:

  • The v11-02-release-candidate version is tagged as v11-02-rc. Users are encouraged to download and test this version and to report any bugs or issues to the GEOS-Chem Support Team. These issues will be fixed beforethe final v11-02 / 12.0.0 release.

  • As described above, the version v11-02-final will also carry the designation 12.0.0 simultaneously. This allows us to reference the version in both the old and the new version numbering systems.

Documentation

Web site

The GEOS-Chem web site is a good place to get started. It will point you to many important GEOS-Chem resources.

Online user's manual

You can find the The GEOS-Chem User's Guide online here:

Wiki

The most up-to-date information about GEOS-Chem is posted on the GEOS-Chem wiki. Here you will find information about technical issues, bug fixes, and other pertinent topics.

GEOS-Chem run directories

To generate GEOS-Chem run directories, please clone the geos-chem-unittest repository and follow the instructions as listed in the GEOS-Chem wiki pags listed below.

Support

We encourage GEOS-Chem users to use the Github issue tracker attached to this repository to report bugs or technical issues with the GEOS-Chem code.

You are also invited to direct GEOS-Chem support requests to the GEOS-Chem Support Team at geos-chem-support@as.harvard.edu.

20 Jun 2018 GEOS-Chem Support Team geos-chem-support@as.harvard.edu

About

Source code repository for the GEOS-Chem model of atmospheric chemistry and composition.

License:Other


Languages

Language:Fortran 98.5%Language:Makefile 0.9%Language:Perl 0.5%Language:C++ 0.1%Language:Shell 0.0%Language:C 0.0%