Merge pull request #84 from unifhy-org/release-v0.1.1

Release v0.1.1
unifhy-org · Apr 17, 2022 · 4105932 · 4105932
2 parents c4e235c + 8c3c989
commit 4105932
Show file tree

Hide file tree

Showing 490 changed files with 114,915 additions and 959 deletions.
diff --git a/.github/workflows/advanced_tests.yml b/.github/workflows/advanced_tests.yml
@@ -45,22 +45,19 @@ jobs:
         run: |
           mamba install udunits2=2.2.25
           mamba install --file=requirements.txt
+          mamba install --file=requirements-tests.txt
 
       # build dummy components required for tests
-      - name: install Fortran compiler (linux)
-        if: matrix.os == 'ubuntu-latest'
-        run: |
-          mamba install gfortran_impl_linux-64
-
-      - name: install Fortran compiler (macos)
+      - name: make gfortran available (macos only)
         if: matrix.os == 'macos-latest'
         run: |
-          mamba install gfortran_impl_osx-64
+          sudo ln -s /usr/local/bin/gfortran-10 /usr/local/bin/gfortran
+          sudo mkdir /usr/local/gfortran
+          sudo ln -s /usr/local/Cellar/gcc@10/*/lib/gcc/10 /usr/local/gfortran/lib
 
       - name: build dummy C and Fortran components
         run: |
-          mamba install cython
-          (cd ./tests/components && make)
+          (cd ./tests/tests/components && make)
 
       # install package
       - name: install package

diff --git a/.github/workflows/build_docs.yml b/.github/workflows/build_docs.yml
@@ -10,7 +10,7 @@ on:
       release:
         description: 'release version tag (#.#.#)'
         required: false
-        default: ''
+        default: '""'
 
 jobs:
 

diff --git a/.zenodo.json b/.zenodo.json
@@ -12,7 +12,7 @@
     ],
     "title": "unifhy",
     "description": "A Unified Framework for Hydrology.",
-    "notes": "Funded by the Natual Environment Research Council (NERC) Hydro-JULES programme (NE/S017380/1).",
+    "notes": "Funded by the Natural Environment Research Council (NERC) Hydro-JULES programme (NE/S017380/1).",
     "license": {
         "id": "BSD-3-Clause"
     }

diff --git a/README.rst b/README.rst
@@ -1,13 +1,13 @@
 Unified Framework for Hydrology
 -------------------------------
 
-.. image:: https://img.shields.io/pypi/v/unifhy?style=flat-square&color=00b0f0
+.. image:: https://img.shields.io/pypi/v/unifhy?style=flat-square
    :target: https://pypi.python.org/pypi/unifhy
    :alt: PyPI Version
-.. image:: https://img.shields.io/badge/dynamic/json?url=https://zenodo.org/api/records/4726695&label=doi&query=doi&style=flat-square&color=00b0f0
+.. image:: https://img.shields.io/badge/dynamic/json?url=https://zenodo.org/api/records/4726695&label=doi&query=doi&style=flat-square
    :target: https://zenodo.org/badge/latestdoi/234523723
    :alt: DOI
-.. image:: https://img.shields.io/github/license/unifhy-org/unifhy?style=flat-square&color=00b0f0
+.. image:: https://img.shields.io/github/license/unifhy-org/unifhy?style=flat-square
    :target: https://opensource.org/licenses/BSD-3-Clause
    :alt: Licence
 .. image:: https://img.shields.io/badge/fair-%E2%97%8F%20%20%E2%97%8F%20%20%E2%97%8F%20%20%E2%97%8F%20%20%E2%97%8B-yellow?style=flat-square
@@ -20,5 +20,13 @@ Unified Framework for Hydrology
 The Python package `unifhy` (Unified Framework for Hydrology) is a hydrological 
 modelling framework which combines interchangeable modelling components for the 
 surface layer, subsurface, and open water parts of the terrestrial water cycle. 
-It is designed to foster collaborations between land surface, hydrological, and 
-groundwater modelling communities.
+By two-way coupling these three components, the framework provides a fully
+functional model for simulating the terrestrial water cycle. It is designed to
+foster collaborations between land surface, hydrological, and groundwater
+modelling communities by structuring their interactions around standardised
+interfaces between the components.
+
+.. end here for docs
+
+More details can be found in the online documentation accessible at
+`<https://unifhy-org.github.io/unifhy>`_.
diff --git a/changelog.rst b/changelog.rst
@@ -1,9 +1,32 @@
 .. default-role:: obj
 
-latest
+..
+   latest
+   ------
+
+   Yet to be versioned and released. Only available from *dev* branch until then.
+
+v0.1.1
 ------
 
-Yet to be versioned and released. Only available from *dev* branch until then.
+Released on 2022-04-17.
+
+.. rubric:: Bug fixes
+
+* fix intermittent data filenames loss in YAML configuration file
+  (`#80 <https://github.com/unifhy-org/unifhy/issues/80>`_)
+* fix relative import bug for advanced test suite
+  (`#82 <https://github.com/unifhy-org/unifhy/issues/82>`_)
+* prevent unwanted installation of `tests` package alongside `unifhy`
+  (`#83 <https://github.com/unifhy-org/unifhy/issues/83>`_)
+
+.. rubric:: Documentation
+
+* add data to run tutorial and revise tutorial accordingly
+  (`#81 <https://github.com/unifhy-org/unifhy/pull/81>`_)
+* revise installation instructions to recommend `conda` over `pip`
+  because of `esmpy` dependency not available on PyPI
+  (`#81 <https://github.com/unifhy-org/unifhy/pull/81>`_)
 
 v0.1.0
 ------

diff --git a/data/README.rst b/data/README.rst
@@ -0,0 +1,44 @@
+Data
+----
+
+These data files are provided to run the tutorial in the online documentation.
+
+The table below lists the source for each data file.
+
++----------------------------------------------+----------------------------------------------+
+| Filename                                     | Source                                       |
++==============================================+==============================================+
+| precipitation_flux.nc                        | https://doi.org/10.24381/cds.20d54e34,       |
++----------------------------------------------+ https://doi.org/10.5194/essd-12-2097-2020    |
+| specific_humidity.nc                         |                                              |
++----------------------------------------------+                                              |
+| surface_downwelling_shortwave_flux_in_air.nc |                                              |
++----------------------------------------------+                                              |
+| surface_downwelling_longwave_flux_in_air.nc  |                                              |
++----------------------------------------------+                                              |
+| air_temperature.nc                           |                                              |
++----------------------------------------------+                                              |
+| wind_speed.nc                                |                                              |
++----------------------------------------------+----------------------------------------------+
+| surface_albedo.nc                            | suite u-ag343 accessible at                  |
+|                                              | https://code.metoffice.gov.uk/trac/roses-u   |
++----------------------------------------------+----------------------------------------------+
+| canopy_height.nc                             | https://doi.org/10.5194/gmd-5-413-2012       |
++----------------------------------------------+----------------------------------------------+
+| leaf_area_index.nc                           | https://doi.org/10.5067/MODIS/MOD15A2H.006   |
++----------------------------------------------+----------------------------------------------+
+| available_water_storage_capacity.nc          | Nachtergaele, F., et al.: Harmonized World   |
++----------------------------------------------+ Soil Database (version 1.2), Food and        |
+| saturated_hydraulic_conductivity.nc          | Agriculture Organization of the UN,          |
+|                                              | International Institute for Applied Systems  |
+|                                              | Analysis, ISRIC - World Soil Information,    |
+|                                              | Institute of Soil Science - Chinese Academy  |
+|                                              | of Sciences, Joint Research Centre of the    |
+|                                              | EC, 2012.                                    |
++----------------------------------------------+----------------------------------------------+
+| topographic_index.nc                         | https://doi.org/10.5194/hess-19-91-2015      |
++----------------------------------------------+----------------------------------------------+
+| flow_direction.nc                            | https://doi.org/10.1029/2008EO100001,        |
++----------------------------------------------+ https://doi.org/10.1002/hyp.9740             |
+| flow_accumulation.nc                         |                                              |
++----------------------------------------------+----------------------------------------------+
diff --git a/data/air_temperature.nc b/data/air_temperature.nc
diff --git a/data/available_water_storage_capacity.nc b/data/available_water_storage_capacity.nc
diff --git a/data/canopy_height.nc b/data/canopy_height.nc
diff --git a/data/flow_accumulation.nc b/data/flow_accumulation.nc
diff --git a/data/flow_direction.nc b/data/flow_direction.nc
diff --git a/data/land_sea_mask.nc b/data/land_sea_mask.nc
diff --git a/data/leaf_area_index.nc b/data/leaf_area_index.nc
diff --git a/data/precipitation_flux.nc b/data/precipitation_flux.nc
diff --git a/data/saturated_hydraulic_conductivity.nc b/data/saturated_hydraulic_conductivity.nc
diff --git a/data/soil_albedo.nc b/data/soil_albedo.nc
diff --git a/data/specific_humidity.nc b/data/specific_humidity.nc
diff --git a/data/surface_downwelling_longwave_flux_in_air.nc b/data/surface_downwelling_longwave_flux_in_air.nc
diff --git a/data/surface_downwelling_shortwave_flux_in_air.nc b/data/surface_downwelling_shortwave_flux_in_air.nc
diff --git a/data/topographic_index.nc b/data/topographic_index.nc
diff --git a/data/wind_speed.nc b/data/wind_speed.nc
diff --git a/docs/.buildinfo b/docs/.buildinfo
@@ -1,4 +1,4 @@
 # Sphinx build info version 1
 # This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
-config: 5c46ce953949bd1a8a072b18c5578f97
+config: 296a6d03df30610eda09667a1e37e1ea
 tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/docs/0.1.1/.buildinfo b/docs/0.1.1/.buildinfo
@@ -0,0 +1,4 @@
+# Sphinx build info version 1
+# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
+config: 296a6d03df30610eda09667a1e37e1ea
+tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/tests/components/__init__.py → docs/0.1.1/.nojekyll b/tests/components/__init__.py → docs/0.1.1/.nojekyll