diff --git a/README.md b/README.md new file mode 100644 index 0000000000000000000000000000000000000000..2804a6c78d8e9f72dc4185dbe24f7c0f7ced273b --- /dev/null +++ b/README.md @@ -0,0 +1,32 @@ +# ERA5 Tables + +This repository aims to create CMOR tables for ERA5 and ERA5Land. Is based on the +[table created to "pseudo-cmorize" ERA5 variables](https://gitlab.dkrz.de/bm1159/cosodax/getera5/-/blob/era5.1/src/ct_ecmwf.rc?ref_type=heads), but it heavily relies on the suggestions changes by +Angelika Heil (heil@dkrz.de, in charge of the [ERA5/ERA5Land data streams](https://docs.dkrz.de/doc/dataservices/finding_and_accessing_data/era_data/index.html#the-era5-climate-reanalyses) +at `/pool/data`. + +In this version, it tries to approach more closely to [obs4MIPS](https://github.com/PCMDI/obs4MIPs-cmor-tables) tables whenever possible. + +## Cloning and installing the repository + +The repository recursively clones [CMIP6](https://github.com/WCRP-CMIP/CMIP6_CVs) +and [Obs4mips](https://github.com/PCMDI/obs4MIPs-cmor-tables) git repositories in +`./Tables/source_tables/`. You will need to: + +```shell +git clone --recursive <your-repo-url> +``` + +to check for changes in the submodules: + +```shell +git submodule update --init --recursive +``` + +For the installation, simply run: + +```shell +make install +``` + +It will create a conda env `era5-tables` and pip install the necessary libraries.