Skip to content

Move basic tutorial episodes from Carpentry to rst format - #4592

Draft
LisaBock wants to merge 11 commits into
mainfrom
tutorial_to_rst
Draft

LisaBock wants to merge 11 commits into
mainfrom
tutorial_to_rst

Conversation

@LisaBock

@LisaBock LisaBock commented Aug 13, 2026

Copy link
Copy Markdown
Member

Description

We are moving all our tutorial episodes from carpentry to rst format as part of the ESMValTool repo.


Before you get started

Checklist

It is the responsibility of the author to make sure the pull request is ready to review. The icons indicate whether the item will be subject to the 🛠 Technical or 🧪 Scientific review.

@LisaBock
LisaBock marked this pull request as draft August 13, 2026 12:00
@LisaBock LisaBock added documentation tutorials Items related to ESMValTool tutorials labels Aug 13, 2026

@valeriupredoi valeriupredoi left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

thanks very much, Lisa! 🍺 - merge at will when you ready from Draft to normal PR

@flicj191 flicj191 left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Thanks @LisaBock, I have added some suggestions for using the linking within the docs

Comment thread doc/sphinx/source/tutorials/episode_1.rst Outdated
Comment thread doc/sphinx/source/tutorials/episode_1.rst Outdated
LisaBock and others added 2 commits August 14, 2026 07:57
Co-authored-by: Felicity Chun <32269066+flicj191@users.noreply.github.com>
Co-authored-by: Felicity Chun <32269066+flicj191@users.noreply.github.com>
@LisaBock

Copy link
Copy Markdown
Member Author

Thanks @LisaBock, I have added some suggestions for using the linking within the docs

Thanks very much @flicj191! That is exactly what I was looking for... Thanks!

@hb326 hb326 left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Hey @LisaBock, thanks for starting this! I like the structure with the general landing page that will guide you to the tutorial welcoming page. I added a few minor comments, but overall I think the structure works like this.

@@ -5,6 +5,8 @@ Tutorials

A tutorial is available on https://tutorial.esmvaltool.org.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

This sentence is not right, correct? We don't need two links to the tutorial here, I think.

* `ESMValCore Source code <https://github.com/ESMValGroup/ESMValCore>`_
* `ESMValTool Citation info <https://esmvaltool.org/references/>`_

How to site the tutorial

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Should be "How to cite the tutorial"



The actual schedule may vary slightly depending on the topics and exercises
chosen by the instructor.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Maybe we want to add here "... and how fast you work your way through the different episodes."?

through the Software Carpentry Unix Shell course.

* Command line: `Software Carpentry Shell Novice
<https://swcarpentry.github.io/shell-novice/>`_

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

This still links to Software Carpentry. That should probably be updated as well?


We typically use the command line to interact with ESMValTool. While most of us
are likely to have experience with the command line, novices may want to work
through the Software Carpentry Unix Shell course.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Here is a link to a Software carpentry course. Should we update this?


* git: `Software Carpentry Git Novice
<https://swcarpentry.github.io/git-novice/>`_

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Again here: a link to Software Carpentry.

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

Labels

documentation tutorials Items related to ESMValTool tutorials

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Move basic tutorial episodes from Carpentry to rst format

4 participants