Metadata-Version: 2.1
Name: trame-sandtank-xai
Version: 1.0.3
Summary: AI/XAI exploration in the context of ParFlow simulation code
Home-page: UNKNOWN
Author: Kitware Inc.
Author-email: UNKNOWN
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
Requires-Dist: trame
Requires-Dist: pftools[io] (>=1.3.2)
Requires-Dist: pytorch-lightning
Requires-Dist: xaitk-saliency
Requires-Dist: captum

============
sandtank-xai
============

AI/XAI exploration in the context of ParFlow simulation code


* Free software: BSD License


Installing
----------
Build and install the Vue components

.. code-block:: console

    cd vue-components
    npm i
    npm run build
    cd -

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 pf_ai python=3.9
    conda activate pf_ai
    conda install "pytorch==1.9.1" -c pytorch
    conda install scipy "scikit-learn==0.24.2" "scikit-image==0.18.3" -c conda-forge

    # For development when inside repo
    pip install -e .

    # For testing (no need to clone repo)
    pip install trame-sandtank-xai


Run the application

.. code-block:: console

    conda activate pf_ai
    trame-sandtank-xai


