From 12778dbef13841bdf77e4fac5dbd47342b58fdda Mon Sep 17 00:00:00 2001 From: Benoit Bovy Date: Mon, 9 Oct 2023 12:14:48 +0200 Subject: [PATCH] prepare for release 0.2.0 --- doc/source/conf.py | 2 +- doc/source/release_notes.md | 28 ++++++++++++++++++++++++---- 2 files changed, 25 insertions(+), 5 deletions(-) diff --git a/doc/source/conf.py b/doc/source/conf.py index 9dd55dab..497e5189 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -117,7 +117,7 @@ "sidebar_hide_name": True, "light_logo": "fastscapelib_logo.svg", "dark_logo": "fastscapelib_logo.svg", - "announcement": "Fastscapelib is in active development (refactoring) and will be released soon, stay tuned!", + # "announcement": "Fastscapelib is in active development (refactoring) and will be released soon, stay tuned!", "footer_icons": [ { "name": "GitHub", diff --git a/doc/source/release_notes.md b/doc/source/release_notes.md index 76e6254e..71825cf0 100644 --- a/doc/source/release_notes.md +++ b/doc/source/release_notes.md @@ -2,10 +2,30 @@ # Release Notes -## v0.2.0 (Unreleased) - -- Add a cmake option that allows downloading/using xtensor development version - ({issue}`37`). +## v0.2.0 (9 October 2023) + +A complete re-write of Fastscapelib with brand new features and API (note: the +API of the previous version has been mostly removed). Some highlights: + +- A flexible grid system, including 1D profile grid, 2D raster grid (with + support of diagonals vs. non-diagonals connectivity) and 2D triangular mesh +- Full support of looped (periodic) boundary conditions for uniform rectangular + grids +- Flexible flow routing using a "flow graph" and "flow operators" +- Support for both single direction and multiple direction flow (grid-agnostic + implementation) +- Efficient resolution of closed depressions in the topography while routing the + flow paths, based either on explicit computation of a graph of basins or on + the priority flood algorithm (grid-agnostic implementation) +- The current flow graph implementation graph based on fixed-size arrays is + extensible to alternative representations (e.g., sparse matrix, linked-lists) +- First-class C++ and Python APIs +- Detailed documentation (examples, user-guide, API reference, etc.) + +Thanks to the contributors to this release: Benoît Bovy, Adrien Delsalle, +Guillaume Cordonnier and Hannah Sophia Davies. Thanks also to Johan Mabille and +QuantStack (https://quantstack.net/) for their contribution and advice on the +design of the library. ## v0.1.3 (5 November 2018)