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

Packaging fixes #248

Merged
merged 21 commits into from
Sep 13, 2023
Merged

Packaging fixes #248

merged 21 commits into from
Sep 13, 2023

Conversation

Zeitsperre
Copy link
Contributor

@Zeitsperre Zeitsperre commented Aug 24, 2023

Pull Request Checklist:

  • This PR addresses an already opened issue (for bug fixes / features)
  • (If applicable) Documentation has been added / updated (for bug fixes / features).
  • (If applicable) Tests have been added.
  • This PR does not seem to break the templates.
  • HISTORY.rst has been updated (with summary of main changes).
    • Link to issue (:issue:number) and pull request (:pull:number) has been added.

What kind of change does this PR introduce?

  • Makes it so that tests are not treated as an installable package.
  • Removes the tests_require in the setup.py.
  • Adds a new dev recipe for convenience.
  • Includes the documentation in the source distribution, excludes the NetCDF files.
  • Renames the pytest marker from requires_docs to requires_netcdf.
  • Substantially reduced the size of the files in /docs/notebooks/samples (from 16Mb to 400kb) and changed the Notebooks and tests to work around it.
  • datablock_3d moved to a new xscen.testing
  • xscen.testing.fake_data to easily populate DataArrays with fake, but realistic data.

Does this PR introduce a breaking change?

Sort of. tests no longer acts like an installable module. This wil only affect xscen developers who write tests.

Other information:

This will be fully obsolete when we move to pyproject.toml, but, for those curious, why not use tests_require?

@Zeitsperre Zeitsperre requested a review from RondeauG August 24, 2023 18:50
@Zeitsperre Zeitsperre self-assigned this Aug 24, 2023
README.rst Show resolved Hide resolved
@review-notebook-app
Copy link

Check out this pull request on  ReviewNB

See visual diffs & provide feedback on Jupyter Notebooks.


Powered by ReviewNB

@RondeauG
Copy link
Collaborator

RondeauG commented Aug 28, 2023

@aulemahal @juliettelavoie No need to review everything, but I'd like you to look into the Notebooks, at least. I had to change them somewhat because we reduced the size of the underlying datasets.

  • I created a new fake_data function to fake 70/120 years of climate data after extract_dataset, for Getting Started and Warming Levels. That means that we can do things properly, but keep the on-disk files at a very small size.
  • pangeo-cmip6.csv is now the bare minimum (48 lines vs 35000!) to make the Catalogs notebook work.
  • The Ensemble Reduction notebook now uses precomputed tg_mean from xclim.testing

@github-actions github-actions bot added CI Modifications to autiomation utilities docs labels Aug 29, 2023
@RondeauG RondeauG mentioned this pull request Aug 30, 2023
6 tasks
Copy link
Collaborator

@RondeauG RondeauG left a comment

Choose a reason for hiding this comment

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

LGTM, but I'll wait for the others to look at it too (for my changes, at least).

Copy link
Collaborator

@aulemahal aulemahal left a comment

Choose a reason for hiding this comment

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

Looks good to me.

@RondeauG RondeauG merged commit 6e893a4 into main Sep 13, 2023
6 checks passed
@RondeauG RondeauG deleted the packaging-fixes branch September 13, 2023 14:30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
CI Modifications to autiomation utilities docs
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Reduce the size of /docs
4 participants