Home

Welcome to the cosima-recipes wiki!

"COSIMA exists to reap the benefits of collaboration". We welcome and encourage contributions from everyone, be that contribution in the form of:

• Code (like what you can find in this recipes repository)
• A new tool (like the python package to run regional configurations of mom6)
• An idea or suggestion for improvement (you can see examples of these on this repository's Issues)

If you are new to the community, before contributing, there are some things you should do to set up your own "version" of the recipes to work from. For steps on how to set up this workflow, check out 0. Prerequisites to contributing.

In this wiki you can learn how to contribute to the recipes in three different ways:

1. You have code to do something that has not yet been documented in the existing examples, or you think an existing example can be improved/built upon. See 1. Working on a recipe.
2. You want to review contributions someone else has done, that is in the "waiting list" (also known as pull request), and needs approval before merging to the main branch of the recipes. See 2. Reviewing pull requests.
3. You have an idea/suggestion but you'd like input before acting on it, or you found a bug in a recipe, etc. Create an Issue!

Workflow diagram

The steps outlined in 0. Prerequisites to contributing are represented by the blue arrows; the steps in 1. Working on a recipe by the orange arrows; and the steps in 2. Reviewing pull requests by the green arrows.

Have a question?

You can reach out to the broader COSIMA community by creating a post (or search for an existing one) in the ACCESS-Hive. Don't be shy! ✨❤️🪅