noaa-ocs-modeling / EnsemblePerturbation

perturbation of coupled model input over a space of input variables
https://ensembleperturbation.readthedocs.io
Creative Commons Zero v1.0 Universal
7 stars 3 forks source link

readthedocs are missing dependencies #116

Closed pmav99 closed 7 months ago

pmav99 commented 7 months ago

E.g. https://ensembleperturbation.readthedocs.io/en/latest/client.html#perturb-tracks

image

There are more similar errors

SorooshMani-NOAA commented 7 months ago

This issue seems to be due to pooch dependency in adcircpy, but adcircpy already defines pooch as a dependency: https://github.com/oceanmodeling/adcircpy/blob/main/pyproject.toml

@pmav99 do you have any suggestion as why it's still missing that dependency when generating the documentation? https://github.com/noaa-ocs-modeling/EnsemblePerturbation/blob/main/.readthedocs.yml

pmav99 commented 7 months ago

Not sure. I guess that adding pooch as a dependency will probably fix the issue, but we will still have not understood the underlying issue.

For the record there is another similar error mentioning cartopy which seems to be an optional dependency. I guess that this should be added to the documentation extras, too.

pmav99 commented 7 months ago

Hmm... could it be that the adcircpy version you get on readthedocs is a rather old one? I.e. one before pooch became a mandatory deendency of adcircpy?

https://github.com/oceanmodeling/adcircpy/commit/5d3c9e941f4dc2f93375040cb483a61e3d74aa6f

pmav99 commented 7 months ago

Your readthedocs builds have been failing for the past 20 months, too: https://readthedocs.org/projects/ensembleperturbation/builds/?page=2

SorooshMani-NOAA commented 7 months ago

Thanks for your comments. I haven't been paying attention to the readthedocs logs! That's a good place to start for me.

SorooshMani-NOAA commented 7 months ago

@zacharyburnett is ensembleperturbation's readthedoc project still under your account? I can't seem to add it in my rtd projects because of existing project name.

zacharyburnett commented 7 months ago

oh yes, it looks like all of these are failing because of missing dependencies in the extras section; @SorooshMani-NOAA I'll add you as a maintainer as well

zacharyburnett commented 7 months ago

https://github.com/noaa-ocs-modeling/EnsemblePerturbation/pull/117 https://github.com/noaa-ocs-modeling/CoupledModelDriver/pull/161 https://github.com/noaa-ocs-modeling/nemspy/pull/62 https://github.com/oceanmodeling/adcircpy/pull/181

I've made these PRs to add dunamai to the docs dependencies (as per the most recent failing build logs), but I'm still not sure why pooch is not available at runtime to this docs build. It might be that that was the last successful build and thus represents an outdated version of the docs

Sorry about that! I also did not pay attention to the build logs

pmav99 commented 7 months ago

It might be that that was the last successful build and thus represents an outdated version of the docs

That's probably the case.

SorooshMani-NOAA commented 7 months ago

@zacharyburnett thank you, I was the one who should have paid more attention!!

SorooshMani-NOAA commented 7 months ago

Still after #117 and #119 the issue is not fixed:

Image

I need to add UDUNITS2 as well!

SorooshMani-NOAA commented 7 months ago

Fixed by #121