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:
- A question (via a new issue) about something that doesn't make sense to you.
- Reporting a bug 🐞, that is, something that doesn't seem to be working (again, via a new issue).
- An idea or suggestion for improvement (you can see examples of these on this repository's Issues).
- Code for something you feel it's useful but we don't have an example/tutorial yet.
- A new tool (like the python package to run regional configurations of mom6).
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:
- 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.
- 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.
- 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!
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.
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! ✨❤️🪅