.. 
   Copyright (c) 2024 National Technology and Engineering Solutions of Sandia, LLC.  
   Under the terms of Contract DE-NA0003525 with National Technology and Engineering 
   Solutions of Sandia, LLC, the U.S. Government retains certain rights in this software.

Utilities
=========

The command line utilities making up the SlyPI package are listed here.  The available 
command line options for any utility can be seen using the ``--help`` flag.

These utilities can also be called from within python, where the arguments are passed
in a list.

Slycat Interaction
------------------

These utilities interact directly with Slycat, e.g. querying markings, adding/removing users, etc.

List markings
^^^^^^^^^^^^^

.. code-block:: bash

   python -m slypi.util.list_markings --help

.. program-output:: python -m slypi.util.list_markings --help

List Projects
^^^^^^^^^^^^^

.. code-block:: bash

   python -m slypi.util.list_projects --help

.. program-output:: python -m slypi.util.list_projects --help

Get Project
^^^^^^^^^^^

.. code-block:: bash

   python -m slypi.util.get_project --help

.. program-output:: python -m slypi.util.get_project --help

Get Model
^^^^^^^^^

.. code-block:: bash

   python -m slypi.util.get_model --help

.. program-output:: python -m slypi.util.get_model --help

List Project Members
^^^^^^^^^^^^^^^^^^^^

.. code-block:: bash

   python -m slypi.util.list_project_members --help

.. program-output:: python -m slypi.util.list_project_members --help

Add Project Members
^^^^^^^^^^^^^^^^^^^

.. code-block:: bash

   python -m slypi.util.add_project_members --help

.. program-output:: python -m slypi.util.add_project_members --help

Remove Project Members
^^^^^^^^^^^^^^^^^^^^^^

.. code-block:: bash

   python -m slypi.util.rm_project_members --help

.. program-output:: python -m slypi.util.rm_project_members --help

Uploading Slycat Models
-----------------------

These utilities allow users to upload Slycat models.

Parameter Space 
^^^^^^^^^^^^^^^

.. code-block:: bash

   python -m slypi.ps.upload_csv --help

.. program-output:: python -m slypi.ps.upload_csv --help

CCA
^^^

.. code-block:: bash

   python -m slypi.cca.upload_csv --help

.. program-output:: python -m slypi.cca.upload_csv --help

Dial-A-Cluster
^^^^^^^^^^^^^^

.. code-block:: bash

   python -m slypi.dac.upload_gen --help

.. program-output:: python -m slypi.dac.upload_gen --help

VideoSwarm
^^^^^^^^^^

.. code-block:: bash

   python -m slypi.vs.upload_local --help

.. program-output:: python -m slypi.vs.upload_local --help


Ensemble Manipulation
---------------------

These utilities are used to read and manipulate the files making up ensemble data, typically
from numerical simulations.  They will accept various file formats and output various Slycat
file formats.  They can be extended to work with new file formats using plugins.

table.py
^^^^^^^^

.. code-block:: bash

   python -m slypi.ensemble.table --help

.. program-output:: python -m slypi.ensemble.table --help

The table utilities can also be called directly using a python API.  Each of the major functions is split out as described below.

.. autofunction:: slypi.ensemble.table.join_csv

.. autofunction:: slypi.ensemble.table.convert_uris

convert.py
^^^^^^^^^^

.. code-block:: bash

   python -m slypi.ensemble.convert --help
   
.. program-output:: python -m slypi.ensemble.convert --help