This repository has been archived by the owner on May 6, 2024. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 8
Included contributing section into README: #13
Merged
Merged
Changes from 2 commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,10 @@ | ||
* [ ] Have you followed our guidelines in Section "Contributing" from README.md? | ||
* [ ] Have you checked already existing notebooks to get an idea about our tutorial style? | ||
* [ ] Have you extensively used markdown elements to structure and explain your notebook? | ||
* [ ] Have you self-reviewed your code / notebook and corrected any misspellings? | ||
* [ ] Have you uploaded your example data to [zenodo]( https://zenodo.org/ ) (see README) if needed? | ||
* [ ] Have you checked if your notebook is running in the recommended standard conda enviroment [see here]((docs/RunningTutorials.md) and updates the [list of required python packages](./requirements.txt) if needed? | ||
* [ ] Have you carefully checked that sphinx-based rendering is still working correctly? | ||
* [ ] Have you written descriptive commit messages? | ||
* [ ] Have you kept your pull request small and limited so that it is easy to review? | ||
* [ ] Have the newest changes been merged into this branch? |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,6 +1,6 @@ | ||
# tobac-tutorials | ||
|
||
Tobac tutorials show different application cases for the cloud and precipitation tracking software tobac using jupyter notebooks. Th rendered versions of our tutorials are provided at [https://fsenf-tobac-tutorials.readthedocs.io](https://fsenf-tobac-tutorials.readthedocs.io). Please have a look there, first! | ||
Tobac tutorials show different application cases for the cloud and precipitation tracking software tobac using jupyter notebooks. The rendered versions of our tutorials are provided at [https://fsenf-tobac-tutorials.readthedocs.io](https://fsenf-tobac-tutorials.readthedocs.io). Please have a look there, first! | ||
|
||
|
||
## Getting Started | ||
|
@@ -13,3 +13,38 @@ A step-by-step description to run the tutorials with jupyter is located [here](d | |
## Limitations | ||
|
||
If you are using tobac 1.x, the notebooks here won#t work because of changes in the code structure. The equivalent notebooks can be found in the [examples](https://github.com/climate-processes/tobac/tree/master/examples) folder in the [tobac master branch](https://github.com/climate-processes/tobac/tree/master/examples). | ||
|
||
|
||
## Contributing | ||
You contribution is welcome! | ||
|
||
Each additional tutorial notbeook helps new `tobac` users to understand the capability of the tracking software and supports creative use of feature identification and tracking in the atmospheric science context. | ||
|
||
|
||
### Pull Request Requirements | ||
|
||
Please provide a separate pull request: | ||
|
||
* **with your example notebook included** | ||
* please extensively use markdown elements to structure and explain your notebook | ||
* check already existing notebooks to get an idea about our tutorial style | ||
* please upload your example data to [zenodo]( https://zenodo.org/ ) (see next paragraph) | ||
* please check if your notebook is running in the recommended standard conda enviroment [see here]((docs/RunningTutorials.md) and update the [list of required python packages](./requirements.txt) if needed | ||
|
||
* **with your suggestions to change the documentation elements**, e.g. `index.rst` | ||
* please care that sphinx-based rendering is still working correctly | ||
|
||
* **or with combination of both** | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I think this line would slightly confuse me, should there be separate pull requests or is it OK to have the addition of the notebook and changes to |
||
|
||
|
||
### Example Data | ||
|
||
Our tutorials live from realistic examples and example data. | ||
|
||
We recommend: | ||
* to upload your example data (preferably as netcdf file) to [zenodo]( https://zenodo.org/ ) | ||
* to label the data such that "tobac" is included in the zenodo title | ||
|
||
Already existing `tobac` data can be found here: | ||
* [**tobac on zenodo**]( https://zenodo.org/search?page=1&size=20&q=tobac ) | ||
|
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Maybe provide a link on how to check this or in general how jupyter notebook works with Sphinx (e.g. https://docs.readthedocs.io/en/stable/guides/jupyter.html) ?