Skip to content

Add a Jupyter esmvalcore API tutorial#339

Open
flicj191 wants to merge 10 commits into
mainfrom
add-jupyter-esmvalcoreapi-tutorial
Open

Add a Jupyter esmvalcore API tutorial#339
flicj191 wants to merge 10 commits into
mainfrom
add-jupyter-esmvalcoreapi-tutorial

Conversation

@flicj191
Copy link
Copy Markdown
Contributor

@flicj191 flicj191 commented Sep 6, 2024

Pull Request checklist

We appreciate your time and effort to improve the tutorial. Please keep in mind that lesson maintainers are volunteers and it may be some time before they can respond to your contribution.


Before you start

Tasks

  • Give this pull request a descriptive title.
  • If you are contributing to existing lesson materials, please make sure the content conforms to the Lesson development section in CONTRIBUTING.md and does not contain any spelling or grammatical errors.
  • If you are making a new episode, please make sure the content conforms to the Lesson organization and Lesson formatting sections in CONTRIBUTING.md and does not contain any spelling or grammatical errors.
  • Preferably Codacy checks pass. Status can be seen below your pull request. If there is an error, click the link to find out why.
  • Preview changes on your machine before pushing them to GitHub by running make serve, alternatively make docker-serve. Please see the Previewing your changes locally section in CONTRIBUTING.md for installation instructions.
  • All code instructions have been tested.

If you need help with any of the tasks above, please do not hesitate to ask by commenting in the issue or pull request.


Closes {Link to the corresponding issue} #283 and part of #324

@flicj191
Copy link
Copy Markdown
Contributor Author

flicj191 commented Sep 6, 2024

Adding lesson made for our ACCESS 2024 workshop Training day Hackathon with @rbeucher. Have edited to remove references to Gadi (Australia's NCI supercomputer) workflow

@rbeucher
Copy link
Copy Markdown

@LisaBock , @rswamina
Would any of you have time to look at this? Thank you!

@LisaBock
Copy link
Copy Markdown
Member

@LisaBock , @rswamina Would any of you have time to look at this? Thank you!

Sorry! I will do next week...

@rswamina
Copy link
Copy Markdown
Contributor

@rbeucher - I will also try it this week. Thanks!

Copy link
Copy Markdown
Member

@LisaBock LisaBock left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks a lot, @flicj191 ! It is great that we have finally a episode how to use the Jupyter esmvalcore API. And since I've never used it before, I can say that you learn it well with this episode. The examples and exercises are also very useful.

Some comments:

  • I am missing in the beginning a small part about the configuration. How to check the CFG keys and how to adapt them. (I think Peter has it in his blog.)
  • When using the ESMValCore preprocessor function I got many warnings with the output. Is it the same for you? I am not sure if we should mention that somehow. Otherwise it could be irritating.
  • I could not find the 'ACCESS-OM2, omip2' data on ESGF. Did I something wrong or could you replace it with a dataset which is available on ESGF?

@flicj191
Copy link
Copy Markdown
Contributor Author

Thanks @LisaBock for your comments! Good points, I will address them though I'm at a conference next week so probably the week after. Cheers

@rswamina
Copy link
Copy Markdown
Contributor

rswamina commented Nov 5, 2024

@flicj191 - I have started this review..will try and see if the instructions work simultaneously.

Comment thread _episodes/11-esmvalcoreapi.md Outdated
Comment thread _episodes/11-esmvalcoreapi.md
Comment thread _episodes/11-esmvalcoreapi.md Outdated
Comment thread _episodes/11-esmvalcoreapi.md
Comment thread _episodes/11-esmvalcoreapi.md Outdated
Comment thread _episodes/11-esmvalcoreapi.md
@rswamina
Copy link
Copy Markdown
Contributor

@flicj191 - This is really nice! I have added some comments at the start of the lesson essentially to provide more detailed instructions in keeping with other lessons and for easy assimilation by the user. We haven't mentioned anything about the ESMValCore API in the tutorial, so either we should provide some background here and/or link to documentation in a way that explains this.
Also, we have to have some way of explaining how to use the appropriate environment.

I'd be interested to know what you and @LisaBock think about this.

Copy link
Copy Markdown
Contributor

@rswamina rswamina left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@flicj191 - Leaving this request for changes based on overall comments. Happy to discuss how best to make these changes.

@flicj191
Copy link
Copy Markdown
Contributor Author

Hi @LisaBock and @rswamina I have edited this to address all your comments in this episode. Let me know what you think, thanks

@flicj191 flicj191 linked an issue Nov 18, 2025 that may be closed by this pull request
@rbeucher
Copy link
Copy Markdown

This is quite old. @flicj191 any update on this?

@flicj191
Copy link
Copy Markdown
Contributor Author

This is quite old. @flicj191 any update on this?

Oh yes, it would need updating for new versions and then will request another review

@flicj191 flicj191 dismissed stale reviews from rswamina and LisaBock May 20, 2026 01:09

updates added

@CLAassistant
Copy link
Copy Markdown

CLAassistant commented May 20, 2026

CLA assistant check
All committers have signed the CLA.

@flicj191
Copy link
Copy Markdown
Contributor Author

Hi @rswamina and @LisaBock, I have updated to v2.14 and have addressed previous comments. What are your thoughts? happy to discuss what else could be useful

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Mention posibility of using Jupyter notebooks in the tutorial

5 participants