Adopt PEP 517 and PEP 621, use raven-hydro package

.pre-commit-config.yaml

@@ -6,31 +6,33 @@ repos:
     rev: v3.4.0
     hooks:
       - id: pyupgrade
-        args: [ --py38-plus ]
+        args: [ '--py38-plus' ]
   - repo: https://github.com/pre-commit/pre-commit-hooks
     rev: v4.4.0
     hooks:
       - id: trailing-whitespace
-        exclude: .rvc|.rvh|.rvi|.rvp|.rvt|.tpl|.txt|setup.cfg
       - id: end-of-file-fixer
-        exclude: .ipynb|.rvc|.rvh|.rvi|.rvp|.rvt|.tpl|.txt
       - id: check-json
+      - id: check-toml
       - id: check-yaml
-        args: [ --allow-multiple-documents ]
+        args: [ '--allow-multiple-documents' ]
+      - id: debug-statements
       - id: pretty-format-json
         args: [ '--autofix', '--no-ensure-ascii', '--no-sort-keys' ]
-      - id: debug-statements
   - repo: https://github.com/pre-commit/pygrep-hooks
     rev: v1.10.0
     hooks:
       - id: python-check-blanket-noqa
       - id: rst-inline-touching-normal
+  - repo: https://github.com/pappasam/toml-sort
+    rev: v0.23.0
+    hooks:
+      - id: toml-sort-fix
   - repo: https://github.com/psf/black
     rev: 23.3.0
     hooks:
       - id: black
         exclude: ^docs/
-        args: [ --target-version=py38 ]
   - repo: https://github.com/pycqa/flake8
     rev: 6.0.0
     hooks:
@@ -40,19 +42,16 @@ repos:
     rev: 5.12.0
     hooks:
       - id: isort
-        args: [ --settings-file=setup.cfg ]
   - repo: https://github.com/nbQA-dev/nbQA
     rev: 1.7.0
     hooks:
       - id: nbqa-pyupgrade
         args: [ --py38-plus ]
-        additional_dependencies: [ pyupgrade==3.3.1 ]
+        additional_dependencies: [ 'pyupgrade==3.3.1' ]
       - id: nbqa-black
-        args: [ --target-version=py38 ]
-        additional_dependencies: [ black==23.3.0 ]
+        additional_dependencies: [ 'black==23.3.0' ]
       - id: nbqa-isort
-        args: [ --settings-file=setup.cfg ]
-        additional_dependencies: [ isort==5.12.0 ]
+        additional_dependencies: [ 'isort==5.12.0' ]
   - repo: https://github.com/pycqa/pydocstyle
     rev: 6.3.0
     hooks:
@@ -62,16 +61,12 @@ repos:
     rev: v0.3.8
     hooks:
       - id: blackdoc
-        additional_dependencies: [ black==23.3.0 ]
+        additional_dependencies: [ 'black==23.3.0' ]
   - repo: https://github.com/adrienverge/yamllint.git
     rev: v1.31.0
     hooks:
       - id: yamllint
-        args: [ '--config-file', '.yamllint.yaml' ]
-  - repo: https://github.com/mgedmin/check-manifest
-    rev: "0.49"
-    hooks:
-      - id: check-manifest
+        args: [ '--config-file=.yamllint.yaml' ]
   - repo: https://github.com/python-jsonschema/check-jsonschema
     rev: 0.23.0
     hooks:
@@ -91,5 +86,5 @@ ci:
   autoupdate_branch: ''
   autoupdate_commit_msg: '[pre-commit.ci] pre-commit autoupdate'
   autoupdate_schedule: weekly
-  skip: [ check-manifest ]
+  skip: [ ]
   submodules: false

Makefile

@@ -89,9 +89,11 @@ release: dist ## package and upload a release
 	twine upload dist/*
 
 dist: clean ## builds source and wheel package
-	python setup.py sdist
-	python setup.py bdist_wheel
+	flit build
 	ls -l dist
 
 install: clean ## install the package to the active Python's site-packages
-	python setup.py install
+	python -m pip install --no-user .
+
+develop: clean ## install the package and development dependencies in editable mode to the active Python's site-packages
+	python -m pip install --no-user --editable ".[dev]"

README.rst

@@ -17,7 +17,6 @@ Raven_ is an hydrological modeling framework that lets hydrologists build hydrol
 
 Note that version 0.20 includes major changes compared to the previous 0.12 release, and breaks backward compatibility. The benefits of these changes are a much more intuitive interface for configuring and running the model.
 
-
 Features
 --------
 

docs/installation.rst

@@ -33,9 +33,9 @@ Custom Installation (Python/Pip)
 --------------------------------
 
 .. warning::
-   The following instructions will only work on POSIX-like systems (Unix/Linux; not supported on Windows).
+   As of April 2023, this installation method does not install the `raven-hydro` hydrological model. You must install the `raven-hydro` model and add it to your `bin` or append it to your `$PATH` manually. This may change in the future
 
-If you wish to install RavenPy and its C-libraries manually, compiling the `Raven` binaries for your system,
+If you wish to install RavenPy and its C-libraries manually, compiling the `Raven` binary for your system,
 you can install the entire system directly, placing them in the `bin` folder of your environment.
 In order to perform this from Ubuntu/Debian:
 
@@ -48,51 +48,25 @@ Then, from your python environment, run:
 .. code-block:: console
 
    $ pip install ravenpy[gis]
-   $ pip install ravenpy[gis] --verbose --install-option="--with-binaries"
-
-.. warning::
-
-  It is imperative that the Python dependencies are pre-installed before running the `--with-binaries`
-  option; This install step will fail otherwise.
 
 If desired, the core functions of `RavenPy` can be installed without its GIS functionalities as well.
 This implementation of RavenPy is much lighter on dependencies and can be installed easily with `pip`,
 without the need for `conda` or `virtualenv`.
 
-The only libraries required for RavenPy in this approach are a C++ compiler and the NetCDF4 development libraries.
-
-.. code-block:: console
-
-   $ sudo apt-get install gcc libnetcdf-dev
-
 .. code-block:: console
 
    $ pip install ravenpy
-   $ pip install ravenpy --verbose --install-option="--with-binaries"
-
-.. warning::
-
-  It is imperative that the Python dependencies are pre-installed before running the `--with-binaries`
-  option; This install step will fail otherwise.
-
-If for any reason you prefer to install without the binaries, from a fresh python environment, run the following:
-
-.. code-block:: console
-
-   (ravenpy-env) $ pip install ravenpy[gis]
 
 But then you will be in charge of providing ``raven``  binaries on your PATH, or setting values for the
 ``RAVENPY_RAVEN_BINARY_PATH`` environment variable (as an absolute path) in the
 terminal/command prompt/shell used at runtime.
 
-.. note::
-
-  The `virtualenv <https://virtualenv.pypa.io/en/latest/>`_ implementation also works well, but the
-  GIS system libraries it depends on (specifically `GDAL` and `GEOS`) can be more difficult to configure.
-
 Development Installation (from sources)
 ---------------------------------------
 
+.. warning::
+   As of April 2023, this installation method does not install the `raven-hydro` hydrological model. You must install the `raven-hydro` model and add it to your `bin` or append it to your `$PATH` manually. This may change in the future
+
 The sources for RavenPy can be obtained from the GitHub repo:
 
 .. code-block:: console
@@ -116,15 +90,6 @@ You can then install RavenPy with:
    # for the python dependencies
    (ravenpy) $ pip install --editable ".[dev]"
 
-.. warning::
-
-   The following command will only work on POSIX-like systems (Unix/Linux; not supported on Windows).
-
-.. code-block:: console
-
-   # for the Raven binaries
-   (ravenpy) $ pip install --editable "." --install-option="--with-binaries"
-
 Install the pre-commit hook (to make sure that any code you contribute is properly formatted):
 
 .. code-block:: console

environment-rtd.yml

@@ -6,6 +6,8 @@ dependencies:
   - python >=3.8,<3.11
   - autodoc-pydantic
   - click
+#  - clisops  # mocked
+  - gdal
   - ipykernel
   - ipython
   - jupyter_client

environment.yml

@@ -20,9 +20,9 @@ dependencies:
   - lxml
   - matplotlib
   - netCDF4
-  - numpy < 1.24
-  - owslib >=0.24.1,<0.29
-  - pandas < 2.0
+  - numpy
+  - owslib >=0.29.1
+  - pandas <2.0
   - pint >=0.20
   - pip
   - pre-commit
@@ -39,6 +39,6 @@ dependencies:
   - spotpy
   - statsmodels
   - xarray <2022.11.0  # Pinned due to incompatibility with climpred @ 2.2.0
-  - xclim >=0.40
+  - xclim >=0.41
   - xskillscore
   - wheel