.. HyperBlend documentation master file, created by
   sphinx-quickstart on Tue Apr 15 10:03:35 2025.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Welcome to HyperBlend's documentation!
======================================

HyperBlend is a scientific Python software for conducting spectral simulations.
Below, you can find the welcome page of the project's main fork's GitHub repository.
Read it through to get a general grasp of the simulator if you have not already done
so. You can then continue to :ref:`chap-install` for installation instructions
and then to :ref:`chap-basics` to construct your first HyperBlend
simulation. Chapters :ref:`chap-slab-simulation` and :ref:`chap-system-simulation`
give further details for more advanced usage. If you want to develop HyperBlend,
you might be intersted in :ref:`chap-developers` and guide to build this
documentation at :ref:`chap-documentation`.
The :ref:`chap-api` documents the source code.
The code is licensed under MIT license which gives you a lot of freedom to use
the code as you wish, see :ref:`chap-license`. See bottom of this page (or the
strip on the left) for full table of contents.

The main fork of HyperBlend is hosted at https://github.com/silmae/HyperBlend .
The only other fork by the original developer is for photobioreactor simulation
at https://github.com/silmae/HBA .

A benchmarking and validation dataset for spectral unmixing of forestry scenes
simulated with HyperBlend
is available in Zenodo with DOI: https://doi.org/10.5281/zenodo.17140892 .

All usage examples are in the tutorials, there are none in the API documentation.


Readme
=========

This is the same README file that is shown on the github landing page.

.. The README file is included here to provide a quick overview of the project.
   It will be displayed on the main page of the documentation.
.. include:: ../../README.rst


.. The toctree defines the structure of the documentation.
.. toctree::
   :glob:
   :maxdepth: 2
   :name: mastertoc
   :caption: Contents:

   self
   install
   basics
   slab_sim
   system_sim
   documentation
   developers
   code/src
   license
   contributing
   glossary
   references

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

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