patch pr

.pylintrc

@@ -50,7 +50,7 @@ confidence=
 # --enable=similarities". If you want to run only the classes checker, but have
 # no Warning level messages displayed, use"--disable=all --enable=classes
 # --disable=W"
-disable=print-statement,parameter-unpacking,unpacking-in-except,old-raise-syntax,backtick,long-suffix,old-ne-operator,old-octal-literal,import-star-module-level,raw-checker-failed,bad-inline-option,locally-disabled,locally-enabled,file-ignored,suppressed-message,useless-suppression,deprecated-pragma,apply-builtin,basestring-builtin,buffer-builtin,cmp-builtin,coerce-builtin,execfile-builtin,file-builtin,long-builtin,raw_input-builtin,reduce-builtin,standarderror-builtin,unicode-builtin,xrange-builtin,coerce-method,delslice-method,getslice-method,setslice-method,no-absolute-import,old-division,dict-iter-method,dict-view-method,next-method-called,metaclass-assignment,indexing-exception,raising-string,reload-builtin,oct-method,hex-method,nonzero-method,cmp-method,input-builtin,round-builtin,intern-builtin,unichr-builtin,map-builtin-not-iterating,zip-builtin-not-iterating,range-builtin-not-iterating,filter-builtin-not-iterating,using-cmp-argument,eq-without-hash,div-method,idiv-method,rdiv-method,exception-message-attribute,invalid-str-codec,sys-max-int,bad-python3-import,deprecated-string-function,deprecated-str-translate-call,W0201
+disable=print-statement,parameter-unpacking,unpacking-in-except,old-raise-syntax,backtick,import-star-module-level,raw-checker-failed,bad-inline-option,locally-disabled,file-ignored,suppressed-message,useless-suppression,deprecated-pragma,apply-builtin,basestring-builtin,buffer-builtin,cmp-builtin,coerce-builtin,execfile-builtin,file-builtin,long-builtin,raw_input-builtin,reduce-builtin,standarderror-builtin,unicode-builtin,xrange-builtin,coerce-method,delslice-method,getslice-method,setslice-method,no-absolute-import,old-division,dict-iter-method,dict-view-method,next-method-called,metaclass-assignment,indexing-exception,raising-string,reload-builtin,oct-method,hex-method,nonzero-method,cmp-method,input-builtin,round-builtin,intern-builtin,unichr-builtin,map-builtin-not-iterating,zip-builtin-not-iterating,range-builtin-not-iterating,filter-builtin-not-iterating,using-cmp-argument,div-method,idiv-method,rdiv-method,exception-message-attribute,invalid-str-codec,sys-max-int,bad-python3-import,deprecated-string-function,deprecated-str-translate-call,W0201
 
 # Enable the message, report, category or checker with the given id(s). You can
 # either give multiple identifier separated by comma (,) or put this option
@@ -220,12 +220,6 @@ max-line-length=100
 # Maximum number of lines in a module
 max-module-lines=1000
 
-# List of optional constructs for which whitespace checking is disabled. `dict-
-# separator` is used to allow tabulation in dicts, etc.: {1  : 1,\n222: 2}.
-# `trailing-comma` allows a space between comma and closing bracket: (a, ).
-# `empty-line` allows space-only lines.
-no-space-check=trailing-comma,dict-separator
-
 # Allow the body of a class to be on the same line as the declaration if body
 # contains single statement.
 single-line-class-stmt=no
@@ -252,46 +246,28 @@ min-similarity-lines=4
 
 [BASIC]
 
-# Naming hint for argument names
-argument-name-hint=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$
-
 # Regular expression matching correct argument names
 argument-rgx=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$
 
-# Naming hint for attribute names
-attr-name-hint=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$
-
 # Regular expression matching correct attribute names
 attr-rgx=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$
 
 # Bad variable names which should always be refused, separated by a comma
 bad-names=foo,bar,baz,toto,tutu,tata
 
-# Naming hint for class attribute names
-class-attribute-name-hint=([A-Za-z_][A-Za-z0-9_]{2,30}|(__.*__))$
-
 # Regular expression matching correct class attribute names
 class-attribute-rgx=([A-Za-z_][A-Za-z0-9_]{2,30}|(__.*__))$
 
-# Naming hint for class names
-class-name-hint=[A-Z_][a-zA-Z0-9]+$
-
 # Regular expression matching correct class names
 class-rgx=[A-Z_][a-zA-Z0-9]+$
 
-# Naming hint for constant names
-const-name-hint=(([A-Z_][A-Z0-9_]*)|(__.*__))$
-
 # Regular expression matching correct constant names
 const-rgx=(([A-Z_][A-Z0-9_]*)|(__.*__))$
 
 # Minimum line length for functions/classes that require docstrings, shorter
 # ones are exempt.
 docstring-min-length=-1
 
-# Naming hint for function names
-function-name-hint=(([a-z][a-z0-9_]{2,40})|(_[a-z0-9_]*))$
-
 # Regular expression matching correct function names
 function-rgx=(([a-z][a-z0-9_]{2,40})|(_[a-z0-9_]*))$
 
@@ -301,21 +277,12 @@ good-names=i,j,k,ex,Run,_
 # Include a hint for the correct naming format with invalid-name
 include-naming-hint=no
 
-# Naming hint for inline iteration names
-inlinevar-name-hint=[A-Za-z_][A-Za-z0-9_]*$
-
 # Regular expression matching correct inline iteration names
 inlinevar-rgx=[A-Za-z_][A-Za-z0-9_]*$
 
-# Naming hint for method names
-method-name-hint=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$
-
 # Regular expression matching correct method names
 method-rgx=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$
 
-# Naming hint for module names
-module-name-hint=(([a-z_][a-z0-9_]*)|([A-Z][a-zA-Z0-9]+))$
-
 # Regular expression matching correct module names
 module-rgx=(([a-z_][a-z0-9_]*)|([A-Z][a-zA-Z0-9]+))$
 
@@ -331,9 +298,6 @@ no-docstring-rgx=^_
 # to this list to register other decorators that produce valid properties.
 property-classes=abc.abstractproperty
 
-# Naming hint for variable names
-variable-name-hint=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$
-
 # Regular expression matching correct variable names
 variable-rgx=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$
 

.readthedocs.yml

@@ -1,7 +1,7 @@
 version: 2
 
 build:
-  os: "ubuntu-20.04"
+  os: "ubuntu-22.04"
   tools:
     python: "mambaforge-4.10"
 

README.md

@@ -9,6 +9,7 @@ CLIMADA stands for **CLIM**ate **ADA**ptation and is a probabilistic natural cat
 As of today, CLIMADA provides global coverage of major climate-related extreme-weather hazards at high resolution via a [data API](https://climada.ethz.ch/data-api/v1/docs), namely (i) tropical cyclones, (ii) river flood, (iii) agro drought and (iv) European winter storms, all at 4km spatial resolution - wildfire to be added soon. For all hazards, historic and probabilistic event sets exist, for some also under select climate forcing scenarios (RCPs) at distinct time horizons (e.g. 2040). See also [papers](https://github.com/CLIMADA-project/climada_papers) for details.
 
 CLIMADA is divided into two parts (two repositories):
+
 1. the core [climada_python](https://github.com/CLIMADA-project/climada_python) contains all the modules necessary for the probabilistic impact, the averted damage, uncertainty and forecast calculations. Data for hazard, exposures and impact functions can be obtained from the [data API](https://github.com/CLIMADA-project/climada_python/blob/main/doc/tutorial/climada_util_api_client.ipynb). [Litpop](https://github.com/CLIMADA-project/climada_python/blob/main/doc/tutorial/climada_entity_LitPop.ipynb) is included as demo Exposures module, and [Tropical cyclones](https://github.com/CLIMADA-project/climada_python/blob/main/doc/tutorial/climada_hazard_TropCyclone.ipynb) is included as a demo Hazard module.
 2. the petals [climada_petals](https://github.com/CLIMADA-project/climada_petals) contains all the modules for generating data (e.g., TC_Surge, WildFire, OpenStreeMap, ...). Most development is done here. The petals builds-upon the core and does not work as a stand-alone.
 
@@ -18,56 +19,59 @@ This is the Python (3.8+) version of CLIMADA - please see https://github.com/dav
 
 ## Getting started
 
-CLIMADA runs on Windows, macOS and Linux. Download the [latest release](https://github.com/CLIMADA-project/climada_petals/releases). Install CLIMADA's dependencies specified in  the downloaded file `climada_python-x.y.z/requirements/env_climada.yml` with conda. See the documentation for more [information on installing](https://climada-python.readthedocs.io/en/latest/guide/Guide_Installation.html).
+CLIMADA runs on Windows, macOS and Linux. It can be installed from sources or - in case of climada_python - directly with pip. See the [installation guide](https://climada-python.readthedocs.io/en/latest/guide/install.html) for instructions.
 
 Follow the [tutorial](https://climada-python.readthedocs.io/en/latest/tutorial/1_main_climada.html) `climada_python-x.y.z/doc/tutorial/1_main_climada.ipynb` in a Jupyter Notebook to see what can be done with CLIMADA and how.
 
 ## Documentation
 
 Documentation is available on Read the Docs:
 
+Note that all the documentations has two versions,'latest' and 'stable', and explicit version numbers, such as 'v3.1.1', in the url path. 'latest' is created from the 'develop' branch and has the latest changes by developers, 'stable' from the latest release. For more details about documentation versions, please have a look at [here](https://readthedocs.org/projects/climada-python/versions/).
+
+CLIMADA python:
+
+* [online (recommended)](https://climada-python.readthedocs.io/en/latest/)
+* [PDF file](https://climada-python.readthedocs.io/_/downloads/en/stable/pdf/)
+
+CLIMADA petals:
+
 * [online (recommended)](https://climada-petals.readthedocs.io/en/latest/)
 * [PDF file](https://climada-petals.readthedocs.io/_/downloads/en/stable/pdf/)
 * [petals Tutorials on GitHub](https://github.com/CLIMADA-project/climada_petals/tree/main/doc/tutorial)
 
+The documentation can also be [built locally](https://climada-python.readthedocs.io/en/latest/README.html).
+
 ## Citing CLIMADA
 
 If you use CLIMADA please cite (in general, in particular for academic work) :
 
+The [used version](https://zenodo.org/search?page=1&size=20&q=climada)
+
+and/or the following published articles:
+
 Aznar-Siguan, G. and Bresch, D. N., 2019: CLIMADA v1: a global weather and climate risk assessment platform, Geosci. Model Dev., 12, 3085–3097, https://doi.org/10.5194/gmd-12-3085-2019
 
 Bresch, D. N. and Aznar-Siguan, G., 2021: CLIMADA v1.4.1: towards a globally consistent adaptation options appraisal tool, Geosci. Model Dev., 14, 351-363, https://doi.org/10.5194/gmd-14-351-2021
 
 Please see all CLIMADA-related scientific publications in our [repository of scientific publications](https://github.com/CLIMADA-project/climada_papers) and cite according to your use of select features, be it hazard set(s), exposure(s) ...
 
-In presentations or other graphical material, as well as in reports etc., where applicable, please add the logo as follows:
-![](https://github.com/CLIMADA-project/climada_python/blob/main/doc/guide/img/CLIMADA_logo_QR.png)
+In presentations or other graphical material, as well as in reports etc., where applicable, please add the logo as follows:\
+![https://github.com/CLIMADA-project/climada_python/blob/main/doc/guide/img/CLIMADA_logo_QR.png](https://github.com/CLIMADA-project/climada_python/blob/main/doc/guide/img/CLIMADA_logo_QR.png?raw=true)
 
 As key link, please use https://wcr.ethz.ch/research/climada.html, as it will last and provides a bit of an intro, especially for those not familiar with GitHub - plus a nice CLIMADA infographic towards the bottom of the page
 
 ## Contributing
 
-To contribute follow these steps:
-
-1. Fork the project on GitHub.
-2. Create a local clone of the develop branch (`git clone https://github.com/YOUR-USERNAME/climada_python.git -b develop`)
-3. Install the packages in `climada_python/requirements/env_climada.yml` and `climada_python/requirements/env_developer.yml`.
-4. Make well commented and clean commits to your repository.
-5. Make unit and integration tests on your code, preferably during development.
-6. Perform a static code analysis of your code with CLIMADA's configuration `.pylintrc`.
-7. Add your name to the AUTHORS file.
-8. Push the changes to GitHub (`git push origin develop`).
-9. On GitHub, create a new pull request onto the develop branch of CLIMADA-project/climada_python.
-
-See our [developer guide](https://climada-python.readthedocs.io/en/latest/#developer-guide) for more information.
+See the [Contribution Guide](https://climada-python.readthedocs.io/en/latest/misc/CONTRIBUTING.html).
 
 ## Versioning
 
 We use [SemVer](http://semver.org/) for versioning. For the versions available, see the [releases on this repository](https://github.com/CLIMADA-project/climada_petals/releases).
 
 ## License
 
-Copyright (C) 2017 ETH Zurich, CLIMADA contributors listed in `AUTHORS.md`.
+Copyright (C) 2017 ETH Zurich, CLIMADA contributors listed in AUTHORS.
 
 CLIMADA is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License Version 3, 29 June 2007 as published by the Free Software Foundation, https://www.gnu.org/licenses/gpl-3.0.html
 

climada_petals/conf/climada.conf

@@ -36,6 +36,15 @@
         "relative_cropyield": {
             "local_data": "{exposures.crop_production.local_data}",
             "filename_wheat_mask": "mask_winter_and_spring_wheat_areas_phase3.nc4"
+        },
+        "tc_tracks_forecast": {
+            "resources": {
+                "ecmwf": {
+                    "host": "diss.ecmwf.int",
+                    "user": "wmo",
+                    "passwd": "essential"
+                }
+            }
         }
     }
 }

climada_petals/engine/test/test_supplychain.py

@@ -36,7 +36,7 @@
 class TestSupplyChain(unittest.TestCase):
     def setUp(self) -> None:
         client = Client()
-        
+
         tf = 'WIOTtest_Nov16_ROW'
         if not WIOD_DIRECTORY.joinpath(tf).is_file():
             dsf = client.get_dataset_info(name=tf, status='test_dataset').files[0]

climada_petals/engine/test/test_warn.py

@@ -373,4 +373,4 @@ def test_plot_warning_meteoswiss(self):
 
 if __name__ == "__main__":
     TESTS = unittest.TestLoader().loadTestsFromTestCase(TestWarn)
-    unittest.TextTestRunner(vaerbosity=2).run(TESTS)
+    unittest.TextTestRunner(verbosity=2).run(TESTS)

climada_petals/engine/warn.py

@@ -510,8 +510,9 @@ def plot_warning(self, var_name='Warn Levels', title='Categorical Warning Map',
         The categories are shared among all subplots, i.e. are obtained from
         np.unique(array_sub).
         Eg.:
-            array_sub = [[1, 2, 1.0, 2], [1, 2, 'a', 'a']]
-            -> categories mapping is [[0, 2, 1, 2], [0, 2, 3, 3]]
+
+        >>> array_sub = [[1, 2, 1.0, 2], [1, 2, 'a', 'a']]
+        >>> -> category mapping is [[0, 2, 1, 2], [0, 2, 3, 3]]
 
         Same category: 1 and '1'
         Different categories: 1 and 1.0

climada_petals/entity/exposures/crop_production.py

@@ -725,11 +725,12 @@ def value_to_kcal(exp_cp, biomass=True):
     ----------
     exp_cp : CropProduction
         CropProduction exposure object with units tonnes per year ('t/y')
-    biomass : bool (optional)
+    biomass : bool, optional
         if true, KCAL_PER_TON['biomass'] is used (default,
         for FAO normalized crop production). If False, KCAL_PER_TON['drymatter']
         is used (best for crop model output in dry matter, default for
-        raw crop model output)
+        raw crop model output).
+        Default: True
 
     Returns
     -------
@@ -758,10 +759,10 @@ def value_to_usd(exp_cp, input_dir=None, yearrange=None):
     ----------
     exp_cp : CropProduction
         CropProduction exposure object with units tonnes per year ('t/y')
-    input_dir : Path or str (optional)
+    input_dir : Path or str, optional
         directory containing the input (FAO pricing) data,
         default: {CONFIG.exposures.crop_production.local_data}/Input/Exposure
-    yearrange : np.array (optional)
+    yearrange : np.array, optional
         year range for prices, can also be set to a single year
         Default is set to the arbitrary time range (2000, 2018)
         The data is available for the years 1991-2018

climada_petals/entity/exposures/openstreetmap/osm_dataloader.py

@@ -367,7 +367,7 @@ def retrieve(self, geo_type, osm_keys, osm_query):
         constraint_dict = {
             'osm_keys' : osm_keys,
             'osm_query' : osm_query}
-        
+
         driver = ogr.GetDriverByName('OSM')
         data = driver.Open(self.osm_path)
         query = self._query_builder(geo_type, constraint_dict)
@@ -448,7 +448,7 @@ class OSMApiQuery:
     """
     Queries features directly via the overpass turbo API.
 
-    area: tuple (xmin, ymin, xmax, ymax), list [xmin, ymin, xmax, ymax] 
+    area: tuple (xmin, ymin, xmax, ymax), list [xmin, ymin, xmax, ymax]
         or shapely.geometry.Polygon
     query: str
         must be of format '["key"]' or '["key"="value"]', etc.
@@ -493,7 +493,7 @@ def _insistent_osm_api_query(self, query_clause, read_chunk_size=100000, end_of_
                 return api.query(query_clause)
             except overpy.exception.OverpassTooManyRequests:
                 if waiting_period < end_of_patience:
-                    LOGGER.warning("""Too many Overpass API requests - 
+                    LOGGER.warning("""Too many Overpass API requests -
                                    trying again in {waiting_period} seconds """)
                 else:
                     raise Exception("Overpass API is consistently unavailable")