Skip to content

Permalink for atmospheric greenhouse effect notebook #328

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

Open
hbrogniez opened this issue Apr 11, 2025 · 18 comments · May be fixed by #329
Open

Permalink for atmospheric greenhouse effect notebook #328

hbrogniez opened this issue Apr 11, 2025 · 18 comments · May be fixed by #329

Comments

@hbrogniez
Copy link

Data Type

Satellite ECVs - Atmosphere Physics

Assessment Category

validation

Dataset Name

satellite-total-column-water-vapour-land-ocean

Question Number

1

Workflow ID

eqctier1-0f509d7b-fe2c-4f62-b335-c062921f4968

Zipped Notebook

Hello,

Can I have the permalink for this notebook ?

satellite_satellite-total-column-water-vapour-land-ocean_validation_q1.zip

Thanks a lot,
Helene

Environment

# Paste here

Anything else we need to know?

No response

@micguerr-bopen micguerr-bopen self-assigned this Apr 11, 2025
@micguerr-bopen
Copy link
Collaborator

Hi @hbrogniez,

I am making a few minor changes to your notebook to make it compatible with the template.
You set #Use case: Studying the Greenhouse Effect produced by the water vapour as a level one header, i.e. the title.

Is this correct? If so, you are missing the first second-level header of the template, i.e. ## 🌍 Use case: Use case listed here in full.

If instead Use case: Studying the Greenhous... was suppose to be the level-two header, I would ask you to provide the title of this note book, so that I can add it before releasing the permalink.

All the best,
Michele

@hbrogniez
Copy link
Author

Dear Michele

Sorry for the omission
Could it be possible to put

  • as the title "Water vapor amplification of Earth's Greenhouse Effect"
  • and as the use case "Observing the water vapour feedback" (instead of "Studying the Greenhouse Effect"

I have another question : where can I have access to the notebooks that you (and your team) correct ? (so that I can get the corrected notebooks in my directory on the virtual machine)

Thank you

Best
Helene

@micguerr-bopen micguerr-bopen linked a pull request Apr 14, 2025 that will close this issue
@micguerr-bopen
Copy link
Collaborator

@hbrogniez, you can find below the permalink as well as the notebook preview.

Permalink: https://github.com/ecmwf-projects/c3s2-eqc-quality-assessment/blob/7c8dd8b63bd2f206e87212b3f67c51a4ecc4f666/Satellite_ECVs/Atmosphere_Physics/satellite_satellite-total-column-water-vapour-land-ocean_validation_q01.ipynb

Please ensure that the notebook name is correct. If you need to make any modifications (e.g., addressing the reviewer's comments), please share the new version of the notebook here, and I will provide a new permalink. Let me know once the notebook is accepted, and I will merge the PR into the main branch.

PREVIEW

@micguerr-bopen
Copy link
Collaborator

Yo can check how the notebook look like via the PREVIEW,

while to obtain the corrected version of the notebook you need to:

Click on permalink -> Download raw file

@micguerr-bopen
Copy link
Collaborator

In your notebook, it remains the authorship to be defined (just under the title).

Also, there was an issue in the way you used cross references within the text:
although the approach you were using was working, this is not compatible with the template.
Instead, to refer to a specific section within the text you should use the following format:

(this-is-ref-to-the-section)=
### This is a section

when you define a section

[](this-is-ref-to-the-section)

when refer to the section

@hbrogniez
Copy link
Author

Hi @micguerr-bopen
thanks for the permalink.
about your comment on the cross references : are your referring to the [1], [2], ... that point to the "Reference and Useful Material" section at the end of the notebook ?

@micguerr-bopen
Copy link
Collaborator

No, I am referring to references made from one part of the document to another part of the document.

For example the reference:

__1. [](Choose-the-data-to-use-and-setup-code)__

In the 📋 Methodology section, to the sub-section Choose the data to use and setup code in the 📈 Analysis and results section.

@hbrogniez
Copy link
Author

Hi @micguerr-bopen
I have made some slight modifications to the notebook.
I noticed in particular that I'd got the wrong version of one of the datasets, which I've corrected. Sorry for the error.

I am not sure that I had to make changes following your comment about cross-references because you already implemented them.

So here is the correct notebook.

satellite_satellite-total-column-water-vapour-ocean_validation_q01_14.04.2025.zip

May I have an updated permalink ?

Thanks
Helene

@micguerr-bopen
Copy link
Collaborator

Hi @hbrogniez ,

It looks like the version of the notebook you shared was downloaded from the PREVIEW (I can tell by the logos at the top of the page).

You should download and modify the permalink version instead. Could you please make the changes there and share it again?

P.S. Yes, I updated the cross-references for you—just wanted to let you know.

Cheers,
Michele

@hbrogniez
Copy link
Author

OK, that should be good now
Here it is

satellite_satellite-total-column-water-vapour-ocean_validation_q01_14.04.2025.zip

Is its ok ?

@micguerr-bopen
Copy link
Collaborator

Yes, that is the right one.

Here is the permalink of the updated version: https://github.com/ecmwf-projects/c3s2-eqc-quality-assessment/blob/1bdbea10c67e3c058c0621962d4086e9da6a401c/Satellite_ECVs/Atmosphere_Physics/satellite_satellite-total-column-water-vapour-land-ocean_validation_q01.ipynb

And here's the PREVIEW

@hbrogniez
Copy link
Author

hbrogniez commented Apr 18, 2025

Hello,
I have put some modifications to the notebook.
Also, I am sorry I didn't notice before, but the latex equations (in Methodology and in Conclusion) don't show properly in the preview. Could you help ?

Here it is

satellite_satellite-total-column-water-vapour-ocean_validation_q01_18.04.2025.zip

Thanks

@micguerr-bopen
Copy link
Collaborator

Hi,

I modified the equations, they should be visualized correctly now.
The following convention seems to work fine:

$$
latex equation
$$

Also, I added numbering to the Analysis and results sub-sections and removed it from the Methodology table of content.
This is more consistent with the template.

@micguerr-bopen
Copy link
Collaborator

@hbrogniez
Copy link
Author

Thanks a lot. So that the latex command lines for equations outside of the paragrah, not inside the paragraph. I will keep that in mind.

@micguerr-bopen
Copy link
Collaborator

If you want to add an equation inside the paragraph you ca use a single $ symbol:

text ... $equation$ ... text

@hbrogniez
Copy link
Author

Hi @micguerr-bopen

could you please add "11-04-2025" as production date for this notebook and update the permalink and preview ?
If you prefer I can modify the notebook and send it to you.

Thanks !

@micguerr-bopen
Copy link
Collaborator

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 a pull request may close this issue.

2 participants