.. _subsurface-manual:

############################
vector-geology Documentation
############################

:Release: |version|
:Date: |today|
:Source: `github.com/vector-raw-materials/vector-geology <https://github.com/vector-raw-materials/vector-geology>`_

----


.. include:: ../../README.rst
  :start-after: sphinx-inclusion-marker


Explore Our Guides
------------------
.. toctree::
   :maxdepth: 2
   :caption: Galleries

   examples/index
   external/external_examples

.. include:: examples/index.rst
.. include:: external/external_examples.rst  


Requirements
------------
The requirements for the core functionality of the package are:

.. include:: ../../requirements.txt
   :literal:

Optional requirements
---------------------

There are many optional requirements, depending on the data format you want to
read/write. Currently, the ``requirements_opt.txt`` reads like:

.. include:: ../../requirements_opt.txt
   :literal:


.. toctree::
   :maxdepth: 2
   :hidden:
   :caption: User Guide

   contributing
   maintenance


Acknowledgements
----------------

This project has received funding from the European Union‘s Horizon Europe research and innovation programme under grant agreement No  101058483

Funded by the European Union. Views and opinions expressed are however those of the author(s) only and do not necessarily reflect those of the European Union or Horizon Europe research and innovation programme

.. image:: https://raw.githubusercontent.com/vector-raw-materials/vector-geology/main/docs/source/_static/logos/eu_logo.png
    :width: 50
    :align: center
    :alt: EU logo