Restructuring of the documentation

.readthedocs.yml

@@ -25,3 +25,6 @@ python:
 
 formats:
   - pdf
+
+sphinx:
+  configuration: doc/conf.py

AUTHORS.md

@@ -1,3 +1,4 @@
+(authors)=
 # CLIMADA List of Authors
 
 * Gabriela Aznar-Siguan

CHANGELOG.md

@@ -277,7 +277,7 @@ Removed:
 ### Added
 
 - Convenience method `api_client.Client.get_dataset_file`, combining `get_dataset_info` and `download_dataset`, returning a single file objet. [#821](https://github.com/CLIMADA-project/climada_python/pull/821)
-- Read and Write methods to and from csv files for the `DiscRates` class. [#818](ttps://github.com/CLIMADA-project/climada_python/pull/818)
+- Read and Write methods to and from csv files for the `DiscRates` class. [#818](https://github.com/CLIMADA-project/climada_python/pull/818)
 - Add `CalcDeltaClimate` to unsequa module to allow uncertainty and sensitivity analysis of impact change calculations [#844](https://github.com/CLIMADA-project/climada_python/pull/844)
 - Add function `safe_divide` in util which handles division by zero and NaN values in the numerator or denominator [#844](https://github.com/CLIMADA-project/climada_python/pull/844)
 - Add reset_frequency option for the impact.select() function. [#847](https://github.com/CLIMADA-project/climada_python/pull/847)

CONTRIBUTING.md

@@ -12,11 +12,11 @@ For orientation, these are some categories of possible contributions we can thin
 * **New Modules and Utility Functions:** Did you create a function or an entire module you find useful for your work? Maybe you are not the only one! Feel free to simply raise a pull request for functions that improve, e.g., plotting or data handling. As an entire module has to be carefully integrated into the framework, it might help if you talk to us first so we can design the module and plan the next steps. You can do that by raising an issue or starting a [discussion](https://github.com/CLIMADA-project/climada_python/discussions) on GitHub.
 
 A good place to start a personal discussion is our monthly CLIMADA developers call.
-Please contact the [lead developers](https://wcr.ethz.ch/research/climada.html) if you want to join.
+Please contact the [lead developers](https://climada.ethz.ch/team/) if you want to join.
 
 ## Why Should You Contribute?
 
-* You will be listed as author of the CLIMADA repository in the [AUTHORS](AUTHORS.md) file.
+* You will be listed as author of the CLIMADA repository in the [AUTHORS][authors] file.
 * You will improve the quality of the CLIMADA software for you and for everybody else using it.
 * You will gain insights into scientific software development.
 
@@ -40,7 +40,7 @@ To contribute follow these steps:
     ```bash
     pylint
     ```
-6. Add your name to the [AUTHORS](AUTHORS.md) file.
+6. Add your name to the [AUTHORS][authors] file.
 7. Push your updates to the remote repository:
 
     ```bash
@@ -83,4 +83,5 @@ It also contains a checklist for both pull request authors and reviewers to guid
 
 [docs]: https://climada-python.readthedocs.io/en/latest/
 [devguide]: https://climada-python.readthedocs.io/en/latest/#developer-guide
-[testing]: https://climada-python.readthedocs.io/en/latest/guide/Guide_Testing.html
+[testing]: https://climada-python.readthedocs.io/en/latest/development/Guide_Testing.html
+[authors]: https://github.com/CLIMADA-project/climada_python/blob/main/AUTHORS.md

climada/engine/unsequa/calc_base.py

@@ -223,15 +223,15 @@ def make_sample(self, N, sampling_method="saltelli", sampling_kwargs=None):
         The 'ff' sampling method does not require a value for the N parameter.
         The inputed N value is hence ignored in the sampling process in the case
         of this method.
-        The 'ff' sampling method requires a number of uncerainty parameters to be
+        The 'ff' sampling method requires a number of uncertainty parameters to be
         a power of 2. The users can generate dummy variables to achieve this
         requirement. Please refer to https://salib.readthedocs.io/en/latest/api.html
         for more details.
 
         See Also
         --------
         SALib.sample: sampling methods from SALib SALib.sample
-            https://salib.readthedocs.io/en/latest/api.html
+        https://salib.readthedocs.io/en/latest/api.html
 
         """
 

climada/engine/unsequa/calc_cost_benefit.py

@@ -53,8 +53,7 @@
 
 
 class CalcCostBenefit(Calc):
-    """
-    Cost Benefit uncertainty analysis class
+    """Cost Benefit uncertainty analysis class
 
     This is the base class to perform uncertainty analysis on the outputs of
     climada.engine.costbenefit.CostBenefit().

climada/engine/unsequa/unc_output.py

@@ -84,20 +84,9 @@ class UncOutput:
     samples_df : pandas.DataFrame
         Values of the sampled uncertainty parameters. It has n_samples rows
         and one column per uncertainty parameter.
-    sampling_method : str
-        Name of the sampling method from SAlib.
-        https://salib.readthedocs.io/en/latest/api.html#
-    n_samples : int
-        Effective number of samples (number of rows of samples_df)
-    param_labels : list
-        Name of all the uncertainty parameters
     distr_dict : dict
         Comon flattened dictionary of all the distr_dict of all input variables.
         It represents the distribution of all the uncertainty parameters.
-    problem_sa : dict
-        The description of the uncertainty variables and their
-        distribution as used in SALib.
-        https://salib.readthedocs.io/en/latest/basics.html.
     """
 
     _metadata = [
@@ -192,6 +181,7 @@ def check_salib(self, sensitivity_method):
     def sampling_method(self):
         """
         Returns the sampling method used to generate self.samples_df
+        See: https://salib.readthedocs.io/en/latest/api.html#
 
         Returns
         -------

climada/hazard/centroids/centr.py

@@ -23,7 +23,7 @@
 import logging
 import warnings
 from pathlib import Path
-from typing import Any, Literal, Union
+from typing import Any, Literal, Optional, Union
 
 import cartopy
 import cartopy.crs as ccrs
@@ -52,21 +52,7 @@
 
 
 class Centroids:
-    """Contains vector centroids as a GeoDataFrame
-
-    Attributes
-    ----------
-    lat : np.array
-        Latitudinal coordinates in the specified CRS (can be any unit).
-    lon : np.array
-        Longitudinal coordinates in the specified CRS (can be any unit).
-    crs : pyproj.CRS
-        Coordinate reference system. Default: EPSG:4326 (WGS84)
-    region_id : np.array, optional
-        Numeric country (or region) codes. Default: None
-    on_land : np.array, optional
-        Boolean array indicating on land (True) or off shore (False). Default: None
-    """
+    """Contains vector centroids as a GeoDataFrame"""
 
     def __init__(
         self,
@@ -116,13 +102,13 @@ def __init__(
             self.set_on_land(source=on_land, overwrite=True)
 
     @property
-    def lat(self):
-        """Return latitudes"""
+    def lat(self) -> np.array:
+        """Latitudinal coordinates in the specified CRS (can be any unit)."""
         return self.gdf.geometry.y.values
 
     @property
-    def lon(self):
-        """Return longitudes"""
+    def lon(self) -> np.array:
+        """Longitudinal coordinates in the specified CRS (can be any unit)."""
         return self.gdf.geometry.x.values
 
     @property
@@ -131,26 +117,26 @@ def geometry(self):
         return self.gdf["geometry"]
 
     @property
-    def on_land(self):
-        """Get the on_land property"""
+    def on_land(self) -> Optional[np.array]:
+        """Boolean array indicating on land (True) or off shore (False). Default: None"""
         if "on_land" not in self.gdf:
             return None
         if self.gdf["on_land"].isna().all():
             return None
         return self.gdf["on_land"].values
 
     @property
-    def region_id(self):
-        """Get the assigned region_id"""
+    def region_id(self) -> Optional[np.array]:
+        """Numeric country (or region) codes. Default: None"""
         if "region_id" not in self.gdf:
             return None
         if self.gdf["region_id"].isna().all():
             return None
         return self.gdf["region_id"].values
 
     @property
-    def crs(self):
-        """Get the crs"""
+    def crs(self) -> CRS:
+        """Coordinate reference system. Default: EPSG:4326 (WGS84)"""
         return self.gdf.crs
 
     @property