Metadata-Version: 2.1
Name: trame-sandtank-ml
Version: 0.0.3
Summary: Interactive application blending ParFlow execution and AI models for validation
Author: Kitware Inc.
License: BSD License
Keywords: Python,Interactive,Web,Application,Framework
Platform: UNKNOWN
Classifier: Development Status :: 1 - Planning
Classifier: Environment :: Web Environment
Classifier: License :: OSI Approved :: BSD License
Classifier: Natural Language :: English
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: JavaScript
Classifier: Topic :: Software Development :: Libraries :: Application Frameworks
Classifier: Topic :: Software Development :: Libraries :: Python Modules
License-File: LICENSE

===========
Sandtank ML
===========

Interactive application blending ParFlow execution and AI models for validation


* Free software: BSD License


Installing
----------

For the Python layer it is recommended to use conda to properly install the various ML packages.

macOS conda setup
^^^^^^^^^^^^^^^^^

.. code-block:: console

    brew install miniforge
    conda init zsh

venv creation for AI
^^^^^^^^^^^^^^^^^^^^

.. code-block:: console

    conda create --name sandtank-ml python=3.9 -y
    conda activate sandtank-ml
    conda install "pytorch==1.11.0" -c pytorch -y
    conda install scipy "scikit-learn==0.24.2" "scikit-image==0.18.3" -c conda-forge -y # For XAITK

    # A: For development when inside repo (A or B not both)
    pip install -e .

    # B: For testing without repo (A or B not both)
    pip install trame-sandtank-ml

    # Build parflow for simulation execution
    ./dependencies/parflow/build.sh


Run the application

.. code-block:: console

    conda activate sandtank-ml
    source ./dependencies/parflow/activate.sh
    trame-sandtank-ml


