Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
jimmielin committed Aug 12, 2022
1 parent 70f036b commit 2102881
Showing 1 changed file with 12 additions and 42 deletions.
54 changes: 12 additions & 42 deletions README.md
@@ -1,55 +1,25 @@
# WRF-GC | A two-way coupled meteo/chem model
## WRF-GC

This repository (`wrf-gc`) holds the `chem` directory for the WRF-GC model, which contains all the custom code necessary to run WRF-GC under a WRF installation
and a built-in version of GEOS-Chem (currently `12.8.2` official version)
This is the official release repository for the **WRF-GC** model, an online two-way coupling of the Weather Research and Forecasting (WRF) model and the [GEOS-Chem](https://geos-chem.seas.harvard.edu/) atmospheric chemistry model.

**[Read the new WRF-GC documentation at wrfgc.readthedocs.io](https://wrfgc.readthedocs.io)**
:bulb: User's Guide: https://wrfgc.readthedocs.io

**This version of WRF-GC is version:** `2.0.1-release` (2021/09/17)
:book: References: [Lin et al., 2020](https://gmd.copernicus.org/articles/13/3241/2020/gmd-13-3241-2020.html), [Feng et al., 2021](https://gmd.copernicus.org/articles/14/3741/2021/)

(c) 2017-2022 Haipeng Lin <hplin@seas.harvard.edu>, Xu Feng <fengx7@pku.edu.cn>, Tzung-May Fu <fuzm@sustech.edu.cn>
## About WRF-GC

(c) 2017-2022 Atmospheric Chemistry & Climate Group, SUSTech
[WRF-GC](https://fugroup.org/index.php/WRF-GC) is an online two-way coupled meteorology-chemistry model using WRF to drive GEOS-Chem chemistry. It is developed by [Haipeng Lin](https://jimmielin.me/), [Xu Feng](https://www.researchgate.net/profile/Xu-Feng-11), and [Tzung-May Fu](https://fugroup.org) and based at the [Atmospheric Chemistry & Climate Group at SUSTech](https://fugroup.org).

GEOS-Chem, GEOS-Chem High Performance, HEMCO, ESMF/MAPL Frameworks are (c) their original authors.
The WRF-GC model includes a versatile coupler coupling GEOS-Chem to WRF in a manner similar to WRF-Chem, making it seamless for WRF-Chem users to use WRF-GC and allowing GEOS-Chem users access to WRF-simulated online weather, with the capability for hindcasts and forecasts.

## Maintainers
Correspondence To: Tzung-May Fu (`fuzm at sustech.edu.cn`)

Atmospheric Chemistry & Climate Group, SUSTech

### Two-way coupled version (`2.0`)
* Xu Feng (`fengx7 at pku.edu.cn`) - Two-way architecture design and lead development
* Haipeng Lin (`hplin at seas.harvard.edu`) - Nested-grid model development, code maintenance

### One-way coupled version (`0.1` - `1.2`)
* Haipeng Lin (`hplin at seas.harvard.edu`) - Code Architectural Design & Maintenance, lead development
* Xu Feng (`fengx7 at pku.edu.cn`) - Scientific programming

## Primary Components for Coupling

### One-way coupled version, two-way coupled version
* WRF-to-Chemistry Abstraction Layer (Codename "Pumpkin") - `wrf-gchp-pumpkin` Project
* WRF-Grid-Independent-GEOS-Chem ("GIGC") Chemistry Driver - `chemics_init` & `chem_driver`
* Stateful Conversion Module - `WRFGC_Convert_State_Mod` (formerly `GIGC_Convert_State_Mod`)

### Nested model
* State management module - `GC_Stateful_Mod`

## Support Components
The below support components are based off GEOS-Chem High Performance ("GCHP") technology.

* GEOS-Chem Column Code - `GIGC_Chunk_Mod`, based off GCHP's original column code
* GEOS-Chem Stateful Variables Container - `GC_Stateful_Mod`, redesigned to support multiple domains within the same CPU in GEOS-Chem

## License
### License
```
(c) 2017-2020 Haipeng Lin <hplin@seas.harvard.edu>, Xu Feng <fengx7@pku.edu.cn>, Tzung-May Fu <tmfu@pku.edu.cn>
(c) 2017-2022 Haipeng Lin <hplin@seas.harvard.edu>, Xu Feng <fengx7@pku.edu.cn>, Tzung-May Fu <tmfu@pku.edu.cn>
(c) 2017-2018 Atmospheric Chemistry & Climate Group, Peking University
(c) 2018-2021 Atmospheric Chemistry & Climate Group, SUSTech
(c) 2018-2022 Atmospheric Chemistry & Climate Group, SUSTech
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to
of this software and associated documentation files (the "Software"), to
use, copy, modify the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
Expand All @@ -70,4 +40,4 @@ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
```
```

0 comments on commit 2102881

Please sign in to comment.