.. Cerulean documentation master file, created by
   sphinx-quickstart on Thu Jun 21 11:07:11 2018.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

====================================
Welcome to Cerulean's documentation!
====================================

Cerulean is a Python 3 library for connecting to HPC compute resources, such as
compute clusters and supercomputers. It lets you copy files between local and
SFTP filesystems using a ``pathlib``-like API, it lets you start processes
locally and remotely via SSH, and it lets you submit jobs to schedulers such as
Slurm and Torque/PBS.

Cerulean supports Python 3.7 and later.

.. toctree::
   :maxdepth: 2
   :caption: Contents:

   tutorial


.. toctree::
   :maxdepth: 1

   api


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

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