.. pyslk documentation master file, created by
   sphinx-quickstart on Sat Oct 23 22:03:13 2021.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Welcome to pyslk's documentation!
=================================

:py:mod:`pyslk` is a python wrapper for the command line interface
of StrongLink, the software of the HSM tape archival system at DKRZ.
:py:mod:`pyslk` wrapps two command line interfaces, ``slk`` for basic interaction
with the tape system and ``slk_helpers`` which serves as a DKRZ specific
extension of ``slk``.

This wrapper is compatible with slk versions ``>= 3.3.21`` (recommended: ``>= 3.3.90``)
and slk_helpers versions ``>= 1.9.0`` (some functions won't work; recommended: ``>= 1.9.4``).

Installation
-------------

The installation requires the following dependencies

- :py:mod:`>= python 3.8`
- :py:mod:`>= slk 3.3.21` (:py:mod:`>= slk 3.3.90` recommended)
- :py:mod:`>= slk_helpers 1.9.0` (:py:mod:`>= slk_helpers 1.9.4` recommended)
- :py:mod:`pandas`
- :py:mod:`psutil`


The package can be installed via pip:

.. code-block:: console

    pip install pyslk -U --extra-index-url https://gitlab.dkrz.de/api/v4/projects/1848/packages/pypi/simple


.. toctree::
   :maxdepth: 1
   :caption: Contents:

   examples
   availability
   api
   changelog
   development


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

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