Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Reintegration of tobac-tutorials into main repository #282

Closed
lettlini opened this issue May 17, 2023 · 5 comments
Closed

Reintegration of tobac-tutorials into main repository #282

lettlini opened this issue May 17, 2023 · 5 comments
Labels
xarray transition Part of the transition to xarray support
Milestone

Comments

@lettlini
Copy link
Collaborator

I think we have come to the consensus to reintegrate the tobac-tutorials into the main repository. I would like to use this issue to track progress and discuss details if necessary.

There is already a big overlap between tobac/examples and tobac-tutorials:

exists in both repositories:

  • Example_OLR_Tracking_model
  • Example_OLR_Tracking_satellite
  • Example_Precip_Tracking
  • Example_Updraft_Tracking

currently only exists in tobac/tobac-tutorials:

  • Basics
  • Example_VIS_Tracking_Satellite
  • Example_Updraft_Tracking

I think it would be a good idea to start with the examples provided in Basics/ as these notebooks are a great resource for getting started with tobac.

@snilsn
Copy link
Collaborator

snilsn commented May 17, 2023

I think the first step should be to process the PRs in the tutorial repository. I will start by reviewing PR 27

@freemansw1 freemansw1 added this to the Version 1.6 milestone May 18, 2023
@lettlini
Copy link
Collaborator Author

Yes, that makes perfect sense. Thank you for taking the time to do this.

@lettlini
Copy link
Collaborator Author

We now have processed all pending PRs in the tobac-tutorials repository (thanks for your efforts @snilsn!).

I think it is time we start thinking about how and when we want to integrate these notebooks into the main repository.

@fsenf fsenf added the xarray transition Part of the transition to xarray support label Sep 1, 2023
@fsenf
Copy link
Member

fsenf commented Sep 1, 2023

I will now start to work on the re-integration of the tutorial notebooks

This is the current content

> git ls-files 
.github/pull_request_template.md
.readthedocs.yml
LICENSE
Makefile
README.md
conf.py
docs/RunningTutorials.md
docs/Testing-Sphinx-based-Rendering.md
index.rst
requirements.txt
tutorials/Basics/Idealized-Case-1_Tracking-of-a-Test-Blob-in-2D.ipynb
tutorials/Basics/Idealized-Case-2_Two_crossing_Blobs.ipynb
tutorials/Basics/Methods-and-Parameters-for-Feature-Detection_Part_1.ipynb
tutorials/Basics/Methods-and-Parameters-for-Feature-Detection_Part_2.ipynb
tutorials/Basics/Methods-and-Parameters-for-Linking.ipynb
tutorials/Basics/Methods-and-Parameters-for-Segmentation.ipynb
tutorials/Example_OLR_Tracking_model/Example_OLR_Tracking_model.ipynb
tutorials/Example_OLR_Tracking_satellite/Example_OLR_Tracking_satellite.ipynb
tutorials/Example_Precip_Tracking/Example_Precip_Tracking.ipynb
tutorials/Example_Updraft_Tracking/Example_Updraft_Tracking.ipynb
tutorials/Example_VIS_Tracking_Satellite/Example_VIS_Tracking_Satellite.ipynb
tutorials/Example_vorticity_tracking_model/Example_vorticity_tracking_model.ipynb

Two things to care for:

  1. integrate notebooks
  2. don't loose other valuable content like requirements, PR-Template and docs - etc.

@w-k-jones
Copy link
Member

Resolved with #334

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
xarray transition Part of the transition to xarray support
Projects
None yet
Development

No branches or pull requests

5 participants