Skip to content

Commit

Permalink
Add a bare-bones README file. To be improved when the project is more…
Browse files Browse the repository at this point in the history
… mature.
  • Loading branch information
micaeljtoliveira committed Feb 28, 2024
1 parent 1f015c2 commit f345c85
Showing 1 changed file with 9 additions and 0 deletions.
9 changes: 9 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -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

0 comments on commit f345c85

Please sign in to comment.