Skip to content
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

Update to use RavenPy v0.8.1 and adjust documentation #439

Merged
merged 28 commits into from
Oct 27, 2022

Conversation

Zeitsperre
Copy link
Contributor

@Zeitsperre Zeitsperre commented Oct 4, 2022

Summary of changes

  • Updated from RavenPy v0.7.8 to v0.8.1

  • Dropped support for Python3.7 (same as in RavenPy)

  • Added rioxarray and ipywidgets to requirements (used explicitly in notebooks)

  • Removed a duplicated notebook (Extract_geographical_watershed_properties.ipynb) that was not in the existing documentation.

  • Set notebooks under docs/source/paper to be ignored.

  • Set ReadTheDocs to use mambaforge for installing dependencies (quicker/less memory intensive)

  • Set ReadTheDocs builds to "fail-on-warning"

  • Updated GitHub Workflows:

    • Use latest Ubuntu images
    • Linting to use Python3.8
    • Staged a Python3.10 build for testing purposes
  • Updated pre-commit hooks:
    • Added pygrep-hooks, NBQA-hooks, yamlint, blackdoc, check-manifest,
      GitHub and RtD schema validation
    • Ran hooks over code base

@Zeitsperre Zeitsperre added Ouranos dependencies Pull requests that update a dependency file labels Oct 4, 2022
@Zeitsperre Zeitsperre self-assigned this Oct 4, 2022
@review-notebook-app
Copy link

Check out this pull request on  ReviewNB

See visual diffs & provide feedback on Jupyter Notebooks.


Powered by ReviewNB

@Zeitsperre
Copy link
Contributor Author

Running into an issue due to settings in ReadTheDocs. Relevant information here: readthedocs/readthedocs.org#9306

Copy link
Contributor

@tlvu tlvu left a comment

Choose a reason for hiding this comment

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

LGTM

.readthedocs.yml Show resolved Hide resolved
@tlvu
Copy link
Contributor

tlvu commented Oct 4, 2022

Running into an issue due to settings in ReadTheDocs. Relevant information here: readthedocs/readthedocs.org#9306

Oh they previously activate this conda update for us to ensure we use latest conda to have speed and memory optimization in latest conda.

Latest conda now not fast or use too much memory? Have to switch to mamba?

@tlvu
Copy link
Contributor

tlvu commented Oct 4, 2022

Running into an issue due to settings in ReadTheDocs. Relevant information here: readthedocs/readthedocs.org#9306

Oh they previously activate this conda update for us to ensure we use latest conda to have speed and memory optimization in latest conda.

Latest conda now not fast or use too much memory? Have to switch to mamba?

Here is when that conda update is activated for Raven: readthedocs/readthedocs.org#5847 (comment)

@Zeitsperre
Copy link
Contributor Author

Oh they previously activate this conda update for us to ensure we use latest conda to have speed and memory optimization in latest conda.

Ah! I forgot that was done on this repo/project. My bad!

Latest conda now not fast or use too much memory? Have to switch to mamba?

I figured why not have more synonymous buildouts for all of our documentation. It's not absolutely necessary, but it can't hurt?

@tlvu
Copy link
Contributor

tlvu commented Oct 4, 2022

Latest conda now not fast or use too much memory? Have to switch to mamba?

I figured why not have more synonymous buildouts for all of our documentation. It's not absolutely necessary, but it can't hurt?

Not hurt but I guess now you'll have to open an issue for RtD dev to disable that conda update flag for mamba to work.

@huard huard changed the title Update to use RavenPy v0.8.0 and adjust documentation Update to use RavenPy v0.8.1 and adjust documentation Oct 26, 2022
Zeitsperre and others added 15 commits October 26, 2022 11:57
# Conflicts:
#	.readthedocs.yml
#	docs/source/notebooks/02_Extract_geographical_watershed_properties.ipynb
#	docs/source/notebooks/Extract_geographical_watershed_properties.ipynb
* Updated GitHub Workflows
  * Use latest Ubuntu images
  * Linting to use Python3.8
  * Staged a Python3.10 build for testing purposes

* Updated pre-commit hooks
* Added pygrep-hooks, NBQA-hooks, yamlint, blackdoc, check-manifest,
GitHub and RtD schema validation
  * Ran hooks over code base

* Updated ReadTheDocs to make use of mamba dependency solver
@Zeitsperre Zeitsperre merged commit b599dc7 into master Oct 27, 2022
@Zeitsperre Zeitsperre deleted the ravenpy-080-docs branch October 27, 2022 14:12
Zeitsperre added a commit that referenced this pull request Aug 17, 2023
## Summary of changes

- Updated from RavenPy v0.7.8 to v0.8.1
- Dropped support for Python3.7 (same as in RavenPy)
- Added `rioxarray` and `ipywidgets` to requirements (used explicitly in
notebooks)
- Removed a duplicated notebook
(`Extract_geographical_watershed_properties.ipynb`) that was not in the
existing documentation.
- Set notebooks under docs/source/paper to be ignored.
- Set ReadTheDocs to use `mambaforge` for installing dependencies
(quicker/less memory intensive)
- Set ReadTheDocs builds to "fail-on-warning"

- Updated GitHub Workflows:
  * Use latest Ubuntu images
  * Linting to use Python3.8
  * Staged a Python3.10 build for testing purposes

* Updated pre-commit hooks:
  * Added pygrep-hooks, NBQA-hooks, yamlint, blackdoc, check-manifest,
GitHub and RtD schema validation
  * Ran hooks over code base
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
dependencies Pull requests that update a dependency file Ouranos
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants