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

Prepare version 0.3.0 #52

Merged
merged 5 commits into from
Dec 1, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .cruft.json
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
"project_slug": "xhydro",
"project_short_description": "Hydrological analysis library built with xarray.",
"pypi_username": "TC-FF",
"version": "0.2.4",
"version": "0.3.0",
"use_pytest": "y",
"use_black": "y",
"use_conda": "y",
Expand Down
8 changes: 2 additions & 6 deletions .github/workflows/bump-version.yml
Original file line number Diff line number Diff line change
Expand Up @@ -14,19 +14,15 @@ on:
- .yamllint.yaml
- .zenodo.json
- AUTHORS.rst
- CHANGES.rst
- CONTRIBUTING.rst
- HISTORY.rst
- MANIFEST.in
- Makefile
- docs/*.py
- docs/*.rst
- docs/notebooks
- environment-docs.yml
- environment-dev.yml
- environment.yml
- pyproject.toml
- requirements_dev.txt
- setup.cfg
- setup.py
- tests/**.py
- tox.ini
- xhydro/__init__.py
Expand Down
11 changes: 7 additions & 4 deletions .readthedocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -15,12 +15,15 @@ build:
tools:
python: "mambaforge-22.9"
jobs:
post_create_environment:
# FIXME: this is a workaround for xdatasets until the `xagg-no-xesmf-deps` issue is addressed
- pip install xdatasets
- pip install . --no-deps
pre_build:
- sphinx-apidoc -o docs/apidoc --private --module-first xhydro

conda:
environment: environment-dev.yml

python:
install:
- method: pip
path: .
extra_requirements:
- docs
12 changes: 4 additions & 8 deletions CHANGES.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,30 +2,26 @@
Changelog
=========

v0.3.0 (unreleased)
v0.3.0 (2023-12-01)
-------------------
Contributors to this version: Gabriel Rondeau-Genesse (:user:`RondeauG`), Trevor James Smith (:user:`Zeitsperre`).

Announcements
^^^^^^^^^^^^^
* N/A

New features and enhancements
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
* The `xhydro` planification was added to the documentation. (:issue:`39`, :pull:`49`).

Breaking changes
^^^^^^^^^^^^^^^^
* `xhydro` now adheres to PEPs 517/518/621 using the `flit` backend for building and packaging.
* `xhydro` now adheres to PEPs 517/518/621 using the `flit` backend for building and packaging. (:pull:`50`).

Bug fixes
^^^^^^^^^
* The `return_level` dimension in `xh.frequency_analysis.local.parametric_quantiles()` is now the actual return level, not the quantile (:issue:`41`, :pull:`43`).
* The `return_level` dimension in `xh.frequency_analysis.local.parametric_quantiles()` is now the actual return level, not the quantile. (:issue:`41`, :pull:`43`).

Internal changes
^^^^^^^^^^^^^^^^
* Added `xhydro.testing.utils.publish_release_notes()` to help with the release process. (:pull:`37`).
* `xh.frequency_analysis.local.parametric_quantiles()` and `xh.frequency_analysis.local.criteria()` are now lazier (:issue:`41`, :pull:`43`).
* `xh.frequency_analysis.local.parametric_quantiles()` and `xh.frequency_analysis.local.criteria()` are now lazier. (:issue:`41`, :pull:`43`).
* The `cookiecutter` template has been updated to the latest commit via `cruft`. (:pull:`50`):
* `Manifest.in` and `setup.py` have been removed.
* `pyproject.toml` has been added, with most package configurations migrated into it.
Expand Down
7 changes: 3 additions & 4 deletions environment-dev.yml
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,9 @@ dependencies:
- xarray
- xclim >=0.45.0
- xscen >=0.7.1
- pip
- pip:
- xdatasets
# Dev
- bump-my-version >=0.12.0
- coveralls
Expand All @@ -35,7 +38,3 @@ dependencies:
- flit
# Notebooks
- hvplot
# FIXME: xdatasets install xagg-no-xesmf-deps which breaks xhydro
# - pip
# - pip:
# - xdatasets
3 changes: 3 additions & 0 deletions environment.yml
Original file line number Diff line number Diff line change
Expand Up @@ -10,3 +10,6 @@ dependencies:
- xarray
- xclim >=0.45.0
- xscen >=0.7.1
- pip
- pip:
- xdatasets
3 changes: 2 additions & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,7 @@ dependencies = [
"statsmodels",
"xarray",
"xclim>=0.45.0",
"xdatasets>=0.3.1",
"xscen>=0.7.1"
]

Expand Down Expand Up @@ -96,7 +97,7 @@ target-version = [
]

[tool.bumpversion]
current_version = "0.2.4"
current_version = "0.3.0"
commit = true
tag = false
tag_name = "v{new_version}"
Expand Down
2 changes: 1 addition & 1 deletion tests/test_xhydro.py
Original file line number Diff line number Diff line change
Expand Up @@ -36,4 +36,4 @@ def test_package_metadata():
contents = f.read()
assert """Thomas-Charles Fortier Filion""" in contents
assert '__email__ = "tcff_hydro@outlook.com"' in contents
assert '__version__ = "0.2.4"' in contents
assert '__version__ = "0.3.0"' in contents
2 changes: 1 addition & 1 deletion xhydro/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -6,4 +6,4 @@

__author__ = """Thomas-Charles Fortier Filion"""
__email__ = "tcff_hydro@outlook.com"
__version__ = "0.2.4"
__version__ = "0.3.0"