url fixing WIP

spjuhel · spjuhel · commit 410223260ed4 · 2025-03-17T17:50:35.000+01:00
diff --git a/AUTHORS.md b/AUTHORS.md
@@ -1,3 +1,4 @@
+(authors)=
 # CLIMADA List of Authors
 
 * Gabriela Aznar-Siguan
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -203,7 +203,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)
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -16,7 +16,7 @@ Please contact the [lead developers](https://climada.ethz.ch/team/) if you want
 
 ## 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.
 
diff --git a/doc/_static/css/custom.css b/doc/_static/css/custom.css
@@ -20,3 +20,20 @@ html {
     --pst-font-size-base: 16px;
     --pst-header-height: 7rem;
 }
+
+.hero {
+  display: flex;
+  align-items: center;
+  justify-content: center;
+  text-align: center; /* Center-align text */
+  background: linear-gradient(to right, #f39c12, #1abc9c, #bdc3c7); /* Orange, teal, gray gradient */
+  color: white; /* Ensure text stands out */
+  padding: 10px;
+  border-radius: 10px; /* Soft rounded corners */
+  margin: 10px auto; /* Center the hero section horizontally */
+  max-width: 980px; /* Restrict width to ensure readability */
+  font-size: 1.1em; /* Slightly smaller text size */
+  line-height: 1.8; /* Better line spacing for readability */
+  box-shadow: 0 4px 6px rgba(0, 0, 0, 0.1); /* Subtle shadow for depth */
+  overflow-wrap: break-word; /* Ensure text doesn't overflow borders */
+}
diff --git a/doc/development/index.rst b/doc/development/index.rst
@@ -1,4 +1,4 @@
-.. include:: ../../CONTRIBUTING.md
+.. include:: ../misc/CONTRIBUTING.md
    :parser: myst_parser.sphinx_
 
 .. toctree::
@@ -14,3 +14,4 @@
    Writing tests for your code <Guide_Testing>
    Guide_Review
    Guide_Euler
+   Authors <../misc/AUTHORS>
diff --git a/doc/getting-started/install.rst b/doc/getting-started/install.rst
@@ -263,7 +263,7 @@ With the ``climada_env`` activated, execute
 
    pre-commit install
 
-Please refer to the :ref:`pre-commit-hooks` for information on how to use this tool.
+Please refer to the `guide on pre-commit hooks <../development/Guide_CLIMADA_Development.html#pre-commit-hooks>`_ for information on how to use this tool.
 
 For executing the pre-defined test scripts in exactly the same way as they are executed by the automated CI pipeline, you will need ``make`` to be installed.
 On macOS and on Linux it is pre-installed. On Windows, it can easily be installed with Conda:
@@ -272,7 +272,7 @@ On macOS and on Linux it is pre-installed. On Windows, it can easily be installe
 
    mamba install -n climada_env make
 
-Instructions for running the test scripts can be found in the :doc:`Testing Guide <Guide_Testing>`.
+Instructions for running the test scripts can be found in the `Testing Guide <../development/Guide_Testing.html>`_.
 
 Install CLIMADA Petals (Optional)
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
@@ -373,7 +373,7 @@ Test Explorer Setup
 
 After you set up a workspace, you might want to configure the test explorer for easily running the CLIMADA test suite within VSCode.
 
-.. note:: Please install the additional :ref:`test dependencies <install-dev>` before proceeding.
+.. note:: Please install the additional :ref:`test dependencies <devdeps>` before proceeding.
 
 #. In the left sidebar, select the "Testing" symbol, and click on *Configure Python Tests*.
 
diff --git a/doc/index.rst b/doc/index.rst
@@ -1,16 +1,20 @@
+:html_theme.sidebar_secondary.remove: true
+
 ===================
 Welcome to CLIMADA!
 ===================
 
-.. image:: guide/img/CLIMADA_logo_QR.png
-   :align: center
-   :alt: CLIMADA Logo
-
-`CLIMADA <https://climada.ethz.ch>`_ (CLIMate ADAptation) is a free and open-source software framework for
-comprehensive climate risk assessment. Designed by a large scientific community,
-CLIMADA offers a robust and flexible platform to analyse the impacts of natural
-hazards and explore adaptation strategies, and it can be used by researchers,
-policy and decision-makers.
+.. raw:: html
+
+    <div class="hero">
+      <b style="font-size: 1.5rem; display: block;">CLIMADA (CLIMate ADAptation)</b>
+      <p style="font-size: 1.5rem; display: block;">
+        is a free and open-source software framework for climate risk assessment and
+        adaptation option appraisal. Designed by a large scientific community, it
+        helps reasearchers, policymakers, and businesses analyse the impacts of
+        natural hazards and explore adaptation strategies.
+      </p>
+    </div>
 
 CLIMADA is primarily developed and maintained by the `Weather and Climate Risks
 Group <https://wcr.ethz.ch/>`_ at `ETH Zürich <https://ethz.ch/en.html>`_.
diff --git a/doc/misc/AUTHORS.md b/doc/misc/AUTHORS.md
@@ -0,0 +1 @@
+../../AUTHORS.md
diff --git a/doc/misc/CHANGELOG.md b/doc/misc/CHANGELOG.md
@@ -0,0 +1 @@
+../../CHANGELOG.md
diff --git a/doc/misc/CONTRIBUTING.md b/doc/misc/CONTRIBUTING.md
@@ -0,0 +1 @@
+../../CONTRIBUTING.md
diff --git a/doc/misc/citation.rst b/doc/misc/citation.rst
@@ -19,19 +19,19 @@ If you use specific tools and modules of CLIMADA, please cite the appropriate pu
      - Publication to cite
    * - *Any*
      - The `Zenodo archive <https://doi.org/10.5281/zenodo.4598943>`_ of the CLIMADA version you are using
-   * - :doc:`Impact calculations </tutorial/climada_engine_Impact>`
+   * - :doc:`Impact calculations </user-guide/climada_engine_Impact>`
      - 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-14-351-2021
-   * - :doc:`Cost-benefit analysis </tutorial/climada_engine_CostBenefit>`
+   * - :doc:`Cost-benefit analysis </user-guide/climada_engine_CostBenefit>`
      - 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
-   * - :doc:`Uncertainty and sensitivity analysis </tutorial/climada_engine_unsequa>`
+   * - :doc:`Uncertainty and sensitivity analysis </user-guide/climada_engine_unsequa>`
      - Kropf, C. M. et al. (2022): Uncertainty and sensitivity analysis for probabilistic weather and climate-risk modelling: an implementation in CLIMADA v.3.1.0. Geosci. Model Dev. 15, 7177–7201, https://doi.org/10.5194/gmd-15-7177-2022
-   * - :doc:`Lines and polygons exposures </tutorial/climada_entity_Exposures_polygons_lines>` *or* `Open Street Map exposures <https://climada-petals.readthedocs.io/en/latest/tutorial/climada_exposures_openstreetmap.html>`_
+   * - :doc:`Lines and polygons exposures </user-guide/climada_entity_Exposures_polygons_lines>` *or* `Open Street Map exposures <https://climada-petals.readthedocs.io/en/latest/user-guide/climada_exposures_openstreetmap.html>`_
      - Mühlhofer, E., et al. (2024): OpenStreetMap for Multi-Faceted Climate Risk Assessments : Environ. Res. Commun. 6 015005, https://doi.org/10.1088/2515-7620/ad15ab
-   * - :doc:`LitPop exposures </tutorial/climada_entity_LitPop>`
+   * - :doc:`LitPop exposures </user-guide/climada_entity_LitPop>`
      - Eberenz, S., et al. (2020): Asset exposure data for global physical risk assessment. Earth System Science Data 12, 817–833, https://doi.org/10.3929/ethz-b-000409595
-   * - :doc:`Impact function calibration </tutorial/climada_util_calibrate>`
+   * - :doc:`Impact function calibration </user-guide/climada_util_calibrate>`
      - Riedel, L., et al. (2024): A Module for Calibrating Impact Functions in the Climate Risk Modeling Platform CLIMADA. Journal of Open Source Software, 9(99), 6755, https://doi.org/10.21105/joss.06755
-   * - `GloFAS River Flood Module <https://climada-petals.readthedocs.io/en/latest/tutorial/climada_hazard_glofas_rf.html>`_
+   * - `GloFAS River Flood Module <https://climada-petals.readthedocs.io/en/latest/user-guide/climada_hazard_glofas_rf.html>`_
      - Riedel, L. et al. (2024): Fluvial flood inundation and socio-economic impact model based on open data, Geosci. Model Dev., 17, 5291–5308, https://doi.org/10.5194/gmd-17-5291-2024
 
 Please find the code to reprocduce selected CLIMADA-related scientific publications in our `repository of scientific publications <https://github.com/CLIMADA-project/climada_papers>`_.
diff --git a/doc/user-guide/0_10min_climada.ipynb b/doc/user-guide/0_10min_climada.ipynb
@@ -6,7 +6,7 @@
    "source": [
     "# 10 minutes CLIMADA\n",
     "\n",
-    "This is a brief introduction to CLIMADA that showcases CLIMADA's key building block, the impact calculation. For more details and features of the impact calculation, please check out the more detailed [CLIMADA Overview](../tutorial/1_main_climada.ipynb). TBDnaming\n",
+    "This is a brief introduction to CLIMADA that showcases CLIMADA's key building block, the impact calculation. For more details and features of the impact calculation, please check out the more detailed [CLIMADA Overview](../user-guide/1_main_climada.ipynb).\n",
     "\n",
     "## Key ingredients in a CLIMADA impact calculation\n",
     "\n",
diff --git a/doc/user-guide/1_main_climada.ipynb b/doc/user-guide/1_main_climada.ipynb
diff --git a/doc/user-guide/climada_engine_Impact.ipynb b/doc/user-guide/climada_engine_Impact.ipynb
diff --git a/doc/user-guide/climada_engine_unsequa.ipynb b/doc/user-guide/climada_engine_unsequa.ipynb
diff --git a/doc/user-guide/climada_entity_LitPop.ipynb b/doc/user-guide/climada_entity_LitPop.ipynb
diff --git a/doc/user-guide/climada_util_api_client.ipynb b/doc/user-guide/climada_util_api_client.ipynb
diff --git a/doc/user-guide/climada_util_calibrate.ipynb b/doc/user-guide/climada_util_calibrate.ipynb

Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,4 @@`
	`1`	`+(authors)=`
`1`	`2`	`# CLIMADA List of Authors`
`2`	`3`
`3`	`4`	`* Gabriela Aznar-Siguan`