Welcome to the wiki page for the Ocean Dynamics research group at the University of St Andrews. This page serves as a lab manual for the group, as well as a general landing point for a variety of guides and resources. In that respect it is hoped that it will also prove useful for the wider ocean and climate science community.
This is a living document, edited by members of the group. The content is subject to regular updates and changes as additional and new information is collected.
How to contribute¶
Fork the source repository on Github.
Clone your forked repository to a local machine.
Create a new branch in which to make your edits.
Make updates and changes on your new branch.
Push your changes back to Github.
Submit a pull request to the main repository.
Guidelines for contributions¶
Edits and additions to this wiki are warmly encouraged. Here are a few principles to keep in mind when writing or editing a page:
📖 Avoid repetition of information that exists elsewhere. This wiki is not designed to be a one-stop-shop for everything. First and foremost, it should serve as a launching pad from which to access information, examples, and guidance relevant to our research. If good examples, insight, or documentation exists elsewhere, simply use this wiki to highlight and signpost this.
🎤 Be clear and concise. Say just what needs to be said, and no more. Think about exactly what a future reader would need to hear to get the main point you are trying to explain.Be accurate and exact, and if you find yourself delving into long-winded explanations, pause and reflect on what is actually necessary.
👩💻 Be consistent. Take a look at other, similar pages on the wiki, and try to mirror their style - both in language and in structure.
✍️ Use Markdown to its full advantage. Give structure to your page or notebook by using all that Markdown has to offer (link to Markdown guide). Order headers with # keys; indent or highlight text to add emphasis; enclose computer language within code blocks; construct tables; and plenty more.