From ec5509464bf1b4cb72b53a0e8e2c5d5ab4e87a1e Mon Sep 17 00:00:00 2001 From: Leonardo Uieda Date: Mon, 8 May 2023 14:41:22 +0100 Subject: [PATCH 1/2] Changelog entry for v1.8.0 (#413) Add the updates to the changelog, tweaks to the README, and link to new docs version. --- README.md | 6 +-- doc/changes.rst | 111 +++++++++++++++++++++++++++++++++++------------ doc/versions.rst | 1 + 3 files changed, 87 insertions(+), 31 deletions(-) diff --git a/README.md b/README.md index eda1325eb..ef4fc517a 100644 --- a/README.md +++ b/README.md @@ -23,9 +23,9 @@ Part of the Fatiando a Terra ## About -**Verde** is a Python library for processing spatial data (bathymetry, -geophysics surveys, etc) and interpolating it on regular grids (i.e., -*gridding*). +**Verde** is a Python library for processing spatial data (topography, point +clouds, bathymetry, geophysics surveys, etc) and interpolating them on a 2D +surface (i.e., gridding) with a hint of machine learning. Our core interpolation methods are inspired by machine-learning. As such, Verde implements an interface that is similar to the popular diff --git a/doc/changes.rst b/doc/changes.rst index c04248ed9..001563c0b 100644 --- a/doc/changes.rst +++ b/doc/changes.rst @@ -3,10 +3,74 @@ Changelog ========= +Version 1.8.0 +------------- + +Released on: 2023/05/08 + +DOI: https://doi.org/10.5281/zenodo.7907182 + +.. warning:: + + **Verde v1.8.0 is the last release that is compatible with Python 3.6.** + +Deprecations: + +* Deprecate the ``engine`` argument of ``Spline/SplineCV`` (`#373 `__) +* Deprecate the ``engine`` argument in ``VectorSpline2D`` (`#410 `__) +* Deprecate ``verde.ScipyGridder`` in favor of the new ``Linear/Cubic/KNeighbors`` (`#393 `__) +* Deprecate the ``scatter`` method of all interpolators (`#357 `__) +* Undo deprecation of region/spacing/shape in the ``grid`` method (`#394 `__) +* Undo deprecation of ``verde.VectorSpline2D`` (`#385 `__) + +New features: + +* New interpolator ``verde.KNeighbors`` class for nearest neighbor interpolation (`#378 `__) +* New interpolator ``verde.Cubic`` gridder class based on SciPy (`#374 `__) +* New interpolator ``verde.Linear`` gridder class based on SciPy (`#372 `__) +* New function ``verde.line_coordinates``, a 1D version of ``verde.grid_coordinates`` (`#390 `__) +* New ``scoring`` parameter for ``verde.SplineCV`` to specify the scoring function (`#380 `__) + +Improvements: + +* Remove the need for ``mindist`` in ``verde.Spline`` by using a better Green's function for small distances (`#401 `__) +* Fix behavior of coordinate generation in ``verde.line_coordinates`` if ``spacing >= 2 * interval`` (`#406 `__) +* Use the new classes ``Linear/Cubic/KNeighbors`` in ``verde.project_grid`` (`#395 `__) +* Default to not rescaling coordinates in ``Linear/Cubic`` (`#391 `__) +* Add option to return 1D arrays in ``grid_coordinates`` (`#388 `__) + +Documentation: + +* New logo and use sphinx-design in the docs (`#367 `__) +* Move deprecated APIs to their own docs section (`#400 `__) +* Improve docstring of ``verde.make_xarray_grid`` (`#399 `__) +* Fix typo in the ``verde.base.BaseGridder.fit`` docstring (`#397 `__) +* Add missing matplotlib scraper for sphinx-gallery (`#389 `__) +* Use PyGMT instead of Cartopy in the ``verde.Chain`` tutorial (`#386 `__) +* Use Markdown for the README instead of RST (`#366 `__) + +Maintenance: + +* Drop support for Python 3.6 (`#364 `__) +* Fail CI if codecov upload fails (`#409 `__) +* More informative warning messages by setting ``stacklevel=2`` (`#407 `__) +* Remove the deprecated sample data gallery (`#387 `__) +* Set lower bounds for dependencies based on NEP29 (`#384 `__) +* Replace ``setup.py`` with PyPA "build" (`#371 `__) +* Replace deprecated numpy dtypes ``np.bool`` and ``np.int`` (`#362 `__) + +This release contains contributions from: + +* Sarah Margrethe Askevold +* James Sample +* Santiago Soler +* Matt Tankersley +* Leonardo Uieda + Version 1.7.0 ------------- -*Released on: 2022/03/25* +Released on: 2022/03/25 DOI: https://doi.org/10.5281/zenodo.6384887 @@ -48,10 +112,9 @@ This release contains contributions from: Version 1.6.1 ------------- -*Released on: 2021/03/22* +Released on: 2021/03/22 -.. image:: https://zenodo.org/badge/DOI/10.5281/zenodo.4626786.svg - :target: https://doi.org/10.5281/zenodo.4626786 +DOI: https://doi.org/10.5281/zenodo.4626786 Minor changes: @@ -69,10 +132,9 @@ This release contains contributions from: Version 1.6.0 ------------- -*Released on: 2021/03/18* +Released on: 2021/03/18 -.. image:: https://zenodo.org/badge/DOI/10.5281/zenodo.4617252.svg - :target: https://doi.org/10.5281/zenodo.4617252 +DOI: https://doi.org/10.5281/zenodo.4617252 New features: @@ -111,10 +173,9 @@ This release contains contributions from: Version 1.5.0 ------------- -*Released on: 2020/06/04* +Released on: 2020/06/04 -.. image:: https://zenodo.org/badge/DOI/10.5281/zenodo.3877060.svg - :target: https://doi.org/10.5281/zenodo.3877060 +DOI: https://doi.org/10.5281/zenodo.3877060 Bug fixes: @@ -167,10 +228,9 @@ This release contains contributions from: Version 1.4.0 ------------- -*Released on: 2020/04/06* +Released on: 2020/04/06 -.. image:: https://zenodo.org/badge/DOI/10.5281/zenodo.3739449.svg - :target: https://doi.org/10.5281/zenodo.3739449 +DOI: https://doi.org/10.5281/zenodo.3739449 Bug fixes: @@ -242,10 +302,9 @@ This release contains contributions from: Version 1.3.0 ------------- -*Released on: 2020/01/22* +Released on: 2020/01/22 -.. image:: https://zenodo.org/badge/DOI/10.5281/zenodo.3620851.svg - :target: https://doi.org/10.5281/zenodo.3620851 +DOI: https://doi.org/10.5281/zenodo.3620851 **DEPRECATIONS** (the following features are deprecated and will be removed in Verde v2.0.0): @@ -328,10 +387,9 @@ This release contains contributions from: Version 1.2.0 ------------- -*Released on: 2019/07/23* +Released on: 2019/07/23 -.. image:: https://zenodo.org/badge/DOI/10.5281/zenodo.3347076.svg - :target: https://doi.org/10.5281/zenodo.3347076 +DOI: https://doi.org/10.5281/zenodo.3347076 Bug fixes: @@ -405,10 +463,9 @@ This release contains contributions from: Version 1.1.0 ------------- -*Released on: 2018/11/06* +Released on: 2018/11/06 -.. image:: https://zenodo.org/badge/DOI/10.5281/zenodo.1478245.svg - :target: https://doi.org/10.5281/zenodo.1478245 +DOI: https://doi.org/10.5281/zenodo.1478245 New features: @@ -443,10 +500,9 @@ New contributors to the project: Version 1.0.1 ------------- -*Released on: 2018/10/10* +Released on: 2018/10/10 -.. image:: https://zenodo.org/badge/DOI/10.5281/zenodo.1421979.svg - :target: https://doi.org/10.5281/zenodo.1421979 +DOI: https://doi.org/10.5281/zenodo.1421979 * Paper submission to JOSS (`#134 `__). This is the new default citation for Verde. @@ -458,10 +514,9 @@ Version 1.0.1 Version 1.0.0 ------------- -*Released on: 2018/09/13* +Released on: 2018/09/13 -.. image:: https://zenodo.org/badge/DOI/10.5281/zenodo.1415281.svg - :target: https://doi.org/10.5281/zenodo.1415281 +DOI: https://doi.org/10.5281/zenodo.1415281 * First release of Verde. Establishes the gridder API and includes blocked reductions, bi-harmonic splines [Sandwell1987]_, coupled 2D interpolation [SandwellWessel2016]_, diff --git a/doc/versions.rst b/doc/versions.rst index 88ff67017..8db350c11 100644 --- a/doc/versions.rst +++ b/doc/versions.rst @@ -7,6 +7,7 @@ Use the links below to access documentation for specific versions * `Latest release `__ * `Development `__ (reflects the *main* branch on GitHub) +* `v1.8.0 `__ * `v1.7.0 `__ * `v1.6.1 `__ * `v1.6.0 `__ From a5a4992d831e60f5958e75ff8473a010efd1e8c6 Mon Sep 17 00:00:00 2001 From: Santiago Soler Date: Wed, 25 Oct 2023 13:34:46 -0700 Subject: [PATCH 2/2] Remove mention of "setup.py" from pyproject.toml (#415) Since `setup.py` was removed from Verde, the comment in `pyproject.toml` should be updated and remove "setup.py" from it. --- pyproject.toml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pyproject.toml b/pyproject.toml index 63f849b22..c7589447b 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -1,5 +1,5 @@ # Specify that we use setuptools and setuptools_scm (to generate the version -# string). Actual configuration is in setup.py and setup.cfg. +# string). Actual configuration is in setup.cfg. [build-system] requires = ["setuptools>=45", "wheel", "setuptools_scm[toml]>=6.2"] build-backend = "setuptools.build_meta"