Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
duncanwp committed Aug 5, 2021
1 parent 66e9b47 commit 98db962
Showing 1 changed file with 26 additions and 2 deletions.
28 changes: 26 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,33 @@ Earth System Emulator (ESEm)
[![codecov](https://codecov.io/gh/duncanwp/ESEm/branch/master/graph/badge.svg?token=4QI2G22Q3M)](https://codecov.io/gh/duncanwp/ESEm)
[![readthedocs](https://readthedocs.org/projects/pip/badge/?version=latest&style=plastic)](https://esem.readthedocs.io/en/latest/)

A tool for emulating geophysical models including (but not limited to!) Earth System Models.
A tool for emulating geophysical datasets including (but not limited to!) Earth System Models.

Why ESEm?
---------

While excellent tools exist for regression and emulation, and similarly for efficient calibration, there isn't a single package that makes it easy for Earth scientists to emulate and calibrate their models. ESEm provides a simple interface to do so, with a thin wrapper around familiar emulation engines and efficient sampling tools.

ESEm uses [Iris](https://scitools-iris.readthedocs.io/en/stable/) Cubes to retain useful geophysical information about the data being emulated and also streamlines the typical task of co-locating models and observations for comparison using [CIS](https://cis.readthedocs.io/).

These tasks aren't just restricted to emulating and calibrating models though and can be used in any situation where regression of Earth system data is needed.

Documentation
-------------

Detailed instructions and example notebooks can be found in our official doccumentation at https://xarray.pydata.org/

Contributing
------------

Contributions to ESEm of any size are very welcome, please see our [Contributing] page for more details.


Get in touch
------------
- Ask general installation and usage questions ("How do I?") in our [Discussions](https://github.com/duncanwp/ESEm/discussions) tab.
- Report bugs and suggest features in the [Issues](https://github.com/duncanwp/ESEm/issues) tab

This project is still a work in progress and documentation will be coming shortly, in the meantime some example notebooks which demonstrate the basic usage can be found [here](docs/examples).

License
-------
Expand Down

0 comments on commit 98db962

Please sign in to comment.