Physrisk Financial
======================

- **version**: 0.1 (See `Changelog <changelog.html>`_)
- **date**: July 4th 2024

An OS-Climate project, **osc-physrisk-financial** is a library for valuating assets under different climate risk scenarios.

.. _cards-clickable:

..
  list with all the possible icons for the grid
  https://sphinx-design.readthedocs.io/en/latest/badges_buttons.html

.. raw:: html

   <style>
       .grid {
           display: grid;
           grid-template-columns: repeat(2, 1fr);
           grid-template-rows: repeat(4, 1fr);
           grid-gap: 10px; /* Ajusta el valor según el espaciado deseado */
           gap: 100px 100px;
       }
   </style>


.. grid:: 2
    :gutter: 1

    .. grid-item-card::  Overview
      :link: readme.html
      :text-align: center

      :octicon:`book;5em;sd-text-info`
      ^^^
      Check the getting started guides and tutorials to learn how to install and use **osc-physrisk-financial**.

    .. grid-item-card::  Code documentation
      :link: modules.html
      :text-align: center

      :octicon:`code;5em;sd-text-info`
      ^^^
      Check the documentation of the code used in **osc-physrisk-financial**.

.. grid:: 2
    :gutter: 1

    .. grid-item-card::  Changelog
      :link: changelog.html
      :text-align: center

      :octicon:`list-ordered;5em;sd-text-info`
      ^^^
      Check the history of the evolution of the code.

    .. grid-item-card:: Contributions & Help
      :link: contributing.html
      :text-align: center

      :octicon:`code-of-conduct;5em;sd-text-info`
      ^^^
      If you want to contribute to the development take a look to the development guidelines first.

.. grid:: 2
    :gutter: 1

    .. grid-item-card::  Authors
      :link: authors.html
      :text-align: center

      :octicon:`people;5em;sd-text-info`
      ^^^

    .. grid-item-card::  License
      :link: license.html
      :text-align: center

      :octicon:`file-badge;5em;sd-text-info`
      ^^^


Contents
==========

.. toctree::
   :maxdepth: 2

   Overview <readme>
   Code documentation <modules>
   Changelog <changelog>
   Contributions & Help <contributing>
   Authors <authors>
   License <license>


Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`

.. _toctree: https://www.sphinx-doc.org/en/master/usage/restructuredtext/directives.html
.. _reStructuredText: https://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html
.. _references: https://www.sphinx-doc.org/en/stable/markup/inline.html
.. _Python domain syntax: https://www.sphinx-doc.org/en/master/usage/restructuredtext/domains.html#the-python-domain
.. _Sphinx: https://www.sphinx-doc.org/
.. _Python: https://docs.python.org/
.. _Numpy: https://numpy.org/doc/stable
.. _SciPy: https://docs.scipy.org/doc/scipy/reference/
.. _matplotlib: https://matplotlib.org/contents.html#
.. _Pandas: https://pandas.pydata.org/pandas-docs/stable
.. _Scikit-Learn: https://scikit-learn.org/stable
.. _autodoc: https://www.sphinx-doc.org/en/master/ext/autodoc.html
.. _Google style: https://google.github.io/styleguide/pyguide.html#38-comments-and-docstrings
.. _NumPy style: https://numpydoc.readthedocs.io/en/latest/format.html
.. _classical style: https://www.sphinx-doc.org/en/master/domains.html#info-field-lists