Update README.md to standalone without the cookbook #424
Conversation
README.md
Outdated
|
|
||
| To **Get Started** with the `cosima-cookbook`, clone this repository locally, probably best in your local space on one of the NCI HPC machines so you can have access to model output. The repository includes a bunch of examples with which you can begin to construct your own analysis code. | ||
| To **get started** with `cosima-recipes`, clone this repository in your local space on one of the NCI HPC machines so you can have access to model output. You should then be able to run these recipes through an [Australian Research Environment (ARE)](https://are.nci.org.au/) JupyterLab session running python. You need to join projects _hh5, xp65, ik11, cj50_ and _ol01_ to run the recipes and acccess the data analysed. |
There was a problem hiding this comment.
| To **get started** with `cosima-recipes`, clone this repository in your local space on one of the NCI HPC machines so you can have access to model output. You should then be able to run these recipes through an [Australian Research Environment (ARE)](https://are.nci.org.au/) JupyterLab session running python. You need to join projects _hh5, xp65, ik11, cj50_ and _ol01_ to run the recipes and acccess the data analysed. | |
| To **get started** with `cosima-recipes`, clone this repository in your local space on one of the NCI HPC machines so you can have access to model output. You should then be able to run these recipes through an [Australian Research Environment (ARE)](https://are.nci.org.au/) JupyterLab session running python. You need to join projects `hh5`, `xp65`, `ik11`, `cj50` and `ol01` to run the recipes and acccess the data. |
There was a problem hiding this comment.
what if I italicise each project name individually? is that better
There was a problem hiding this comment.
You prefer italics? Go for it! I actually thought it was a mistaken rst syntax...
There was a problem hiding this comment.
Perhaps we can add a link to https://my.nci.org.au/ where we say "You need to join projects...."?
README.md
Outdated
| @@ -20,14 +24,20 @@ Just raise [an issue](https://github.com/COSIMA/cosima-recipes/issues) explainin | |||
|
|
|||
| ## Contents | |||
|
|
|||
| ### [Tutorials](https://cosima-recipes.readthedocs.io/en/latest/tutorials.html) | |||
| We are in the process of transition these recipes from using [cosima-cookbook](https://github.com/COSIMA/cosima-cookbook) infrastructure to an _intake catalogue_, so you will find recipes may use either method to access model data. If you are halfway through a project using the cosima-cookbook and looking for resources, this [tag](https://github.com/COSIMA/cosima-recipes/tree/cosima_cookbook) marks the repository before most recipes were transitioned. | |||
There was a problem hiding this comment.
let's just remove any references to cookbook... whoever uses cookbook they know, else they should just go to Intake
There was a problem hiding this comment.
I think it's better to describe where we are at ... there's lots of unresolved references to the cookbook in docs and notebooks that will take some time to work through
There was a problem hiding this comment.
I prefer we have a clean tutorial for the Intake and how people should open datasets and don't mention cookbook at all. It creates confusion.
There was a problem hiding this comment.
I opened an issue to discuss this: #425
README.md
Outdated
| To **Get Started** with the `cosima-cookbook`, clone this repository locally, probably best in your local space on one of the NCI HPC machines so you can have access to model output. The repository includes a bunch of examples with which you can begin to construct your own analysis code. | ||
| To **get started** with `cosima-recipes`, clone this repository in your local space on one of the NCI HPC machines so you can have access to model output. You should then be able to run these recipes through an [Australian Research Environment (ARE)](https://are.nci.org.au/) JupyterLab session running python. You need to join projects _hh5, xp65, ik11, cj50_ and _ol01_ to run the recipes and acccess the data analysed. | ||
|
|
||
| When starting ARE, include the projects in the _Storage_ line: _gdata/xp65+gdata/ik11+gdata/cj50+gdata/hh5+gdata/oi10_ as well as your own project. In _Module directories_, set _/g/data/hh5/public/modules_ and in _Modules_ set _conda/analysis3_. |
There was a problem hiding this comment.
Add note about instance size
There was a problem hiding this comment.
Shouldn't we use this format for input the users should put enter?
There was a problem hiding this comment.
Good point - yes :)
Co-authored-by: Navid C. Constantinou <[email protected]>
|
I haven't updated to the new wiki, but otherwise i addressed the review comments |
|
No worries -- merge if you like and we'll update links to new wiki in a different PR |
I attempted to update the readme to standalone better and make sense without the cookbook.
I didn't make any changes to the
contributing.rstwhich needs some similar changes.Contributes to #419