MyPyDavid / HeFDI-Forschungsdatentag-2022

Code Beispielen für die Einstieg ins Programmieren.
MIT License
2 stars 0 forks source link

Greetings from Wetterdienst #6

Open amotl opened 1 year ago

amotl commented 1 year ago

Hi David,

we appreciate you used Wetterdienst for conducting a Python curriculum at HeFDI Forschungsdatentag 2022.

If you like it, we may find a good place for the corresponding Python code at the list of example programs for Wetterdienst. In this manner, we may be able to make it part of Wetterdienst's test harness, so it is ensured it does not break during the evolution of Wetterdienst.

With kind regards, Andreas.

/cc @gutzbenj

MyPyDavid commented 1 year ago

Dear Andreas,

thank you for reaching out from the Wetterdienst!

The examples that I made are mostly based on your climate_observations.ipynb example. I've added a Gaussian fitting to the data of a DwdObservationRequest and made the plots. Would you like to have this dependency (on LMfit-py) also in your list of examples? Is the list of examples part of the automated testing or used separately as scripts/.ipynb? I think I have to rewrite my examples a bit before I add them to your list but I can look into this.

Best regards, David

amotl commented 1 year ago

Hi David,

apologies for the late reply.

The examples that I made are mostly based on your climate_observations.ipynb example. I've added a Gaussian fitting to the data of a DwdObservationRequest and made the plots.

Sounds good!

Would you like to have this dependency (on LMfit-py) also in your list of examples?

It does not sound bad, but I would let @gutzbenj finally decide on this detail. In general, it is no problem to add LMfit-py to a list of optional dependencies. In this manner, we will not put an obligation on the end user to install it, but we can still satisfy the test suite.

Is the list of examples part of the automated testing or used separately as scripts/.ipynb?

The test suite covers both Python programs and .ipynb notebook within the examples/ folder, right. If it is needed, we will find a way to add a program, but exclude it from the test suite.

With kind regards, Andreas.

gutzbenj commented 1 year ago

Dear all,

sure, let's put it in there. I thin those dependencies in examples I marked as docs dependencies (such as matplotlib used in the notebook).

Examples are being tested as such they are executed and if no error occurs they pass.

The notebook is being executed once per test and re-rendered if there are any differences.

MyPyDavid commented 1 year ago

Thanks for your considerations about the example, Ive made the PR now: https://github.com/earthobservations/wetterdienst/pull/866

Cheers, David