About
=====

The **SciGeoh5** package is an interface between machine learning libraries, such as `scikit-learn <https://scikit-learn.org/stable/>`_ or `scipy <https://docs.scipy.org/doc/scipy/>`_, and `Mira Geoscience <https://www.mirageoscience.com/>`_'s `geoh5py <https://mirageoscience-geoh5py.readthedocs-hosted.com/en/stable>`_ data storage package. **SciGeoh5** comes with a ui.json file that allows users to run the various applications through `Geoscience ANALYST <https://mirageoscience.com/products/geoscience-analyst/>`_
using GEOH5 file format.

.. image:: ./images/basic_usage/intro.png
    :name: link_scigeoh5_geoh5py
    :align: center

Upon execution, **SciGeoh5** will reformat the data, call **Scikit-Learn** or **Scipy** functions, collect the results and re-package into geoh5py objects for display in ANALYST. **SciGeoh5** also includes for each application a robust data-preprocessing workflow tailored to geoscientific data, ensuring stable and reliable outputs.

.. toctree::
   :maxdepth: 1
   :caption: Installation:

   getting_started
   usage
   THIRD_PARTY_SOFTWARE

.. toctree::
   :maxdepth: 1
   :caption: Applications:

   applications/pca
   applications/rbf


License
^^^^^^^

Proprietary License

|copyright_notice|

All rights reserved.

The software and information contained herein are proprietary to, and
comprise valuable trade secrets of, Mira Geoscience, which
intend to preserve as trade secrets such software and information.
This software is furnished pursuant to a written license agreement and
may be used, copied, transmitted, and stored only in accordance with
the terms of such license and with the inclusion of the above copyright
notice.  This software and information or any other copies thereof may
not be provided or otherwise made available to any other person.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.



Third Party Software
^^^^^^^^^^^^^^^^^^^^
The **SciGeoh5** Software may provide links to third party libraries or code (collectively “Third Party Software”)
to implement various functions. Third Party Software does not comprise part of the Software.
The use of Third Party Software is governed by the terms of such software license(s).
Third Party Software notices and/or additional terms and conditions are located in the
`THIRD_PARTY_SOFTWARE`_ file.

.. _THIRD_PARTY_SOFTWARE: ./THIRD_PARTY_SOFTWARE.html