From f345c850e12de9c79392f0af8cc25e6a780f82e8 Mon Sep 17 00:00:00 2001 From: Micael Oliveira Date: Wed, 28 Feb 2024 13:58:41 +1100 Subject: [PATCH] Add a bare-bones README file. To be improved when the project is more mature. --- README.md | 9 +++++++++ 1 file changed, 9 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..472929e --- /dev/null +++ b/README.md @@ -0,0 +1,9 @@ +# OM3Utils + +*A Python package of various utilities for the [ACCESS-OM3](https://github.com/COSIMA/access-om3) coupled ocean - sea ice - wave model.* + +![CI](https://github.com/COSIMA/om3-utils/actions/workflows/ci.yml/badge.svg) [![License](https://img.shields.io/badge/License-MPL2.0-a05a3f?style=flat-square)](https://opensource.org/licenses/MPL-2.0) [![codecov](https://codecov.io/gh/COSIMA/om3-utils/graph/badge.svg?token=gWLm5kXMcb)](https://codecov.io/gh/COSIMA/om3-utils) [![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black) + +Collection of utilities aimed at simplifying the creation and handling of ACCESS-OM3 runs. It currently includes: + - functions to read and write ACCESS-OM3 configuration files + - functions to read and process profiling data