Skip to content

Commit

Permalink
Update README.md after deleting contributed examples (#408)
Browse files Browse the repository at this point in the history
* Update README.md after deleting contributed examples

* documented examples -> examples
  • Loading branch information
navidcy committed Jul 5, 2024
1 parent dd5083c commit 7f46784
Show file tree
Hide file tree
Showing 4 changed files with 6 additions and 7 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,15 +18,15 @@ To make a contribution follow the steps laid out in the [beginner's guide on how
https://cosima-recipes.readthedocs.io/en/latest/contributing.html). If they sound intimidating then don't worry!
Just raise [an issue](https://github.com/COSIMA/cosima-recipes/issues) explaining briefly what the contribution you want to make is and we'll help out with the process!

## Repository contents
## Contents

### [Tutorials](https://cosima-recipes.readthedocs.io/en/latest/tutorials.html)

The notebook `ACCESS-NRI_Intake_Catalog.ipynb` outlines the basic philosophy of the Intake catalog. This is the best place to start if you are not familiar with the Intake catalog. Also included here are some other tutorials, either related to the cookbook (e.g., `Make_Your_Own_Database.ipynb`) or more general (`Making_Maps_with_Cartopy.ipynb`).

Don't miss out the <a href="https://nbviewer.jupyter.org/github/COSIMA/cosima-recipes/blob/master/Tutorials/Using_Explorer_tools.ipynb" target="_blank">tutorial</a> about using `cosima-cookbook`'s `explore` submodule to find out about available experiments and variables in a database. (The `explorer` tutorial is better viewed either via nbviewer or by running the jupyter notebook yourself.)

### [Documented Examples](https://cosima-recipes.readthedocs.io/en/latest/documented_examples.html)
### [Examples](https://cosima-recipes.readthedocs.io/en/latest/examples.html)
Νotebooks for simple and not-so-simple diagnostics which are well-documented and explained. If you can find an example that suits your purpose, this is the best place to start.

### ACCESS-OM2-GMD-Paper-Figs
Expand Down
2 changes: 1 addition & 1 deletion docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@
# -- Project information -----------------------------------------------------

project = 'COSIMA Recipes'
copyright = '2023, COSIMA'
copyright = '2024, COSIMA'
author = 'COSIMA'


Expand Down
File renamed without changes.
7 changes: 3 additions & 4 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,19 +9,18 @@ COSIMA Recipes documentation
Welcome to the COSIMA Recipes documentation!

To get started have a look at the tutorials_ and then browse through the
available `documented examples`_ to find something the better suits
your needs!
available examples_ to find something the better suits your needs!


.. _tutorials: tutorials.html
.. _documented examples: documented_examples.html
.. _documented examples: examples.html

.. toctree::
:maxdepth: 1
:caption: Contents:

tutorials
documented_examples
examples
guidelines
contributing

Expand Down

0 comments on commit 7f46784

Please sign in to comment.