.. Trident documentation master file, created by
   sphinx-quickstart on Sun Nov 19 22:18:51 2017.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Trident: Pythonic Scripting of Scientific Experiments
=====================================================

Trident is the Python scripting API for
`Aquarium <https://www.aquarium.bio/>`_
, the software that runs the
`UW BIOFAB <http://www.uwbiofab.org>`_.
The `code respository <https://github.com/klavinslab/trident>`_ is freely available to all.
Trident was built by members of the `Klavins lab <http://klavinslab.org/>`_.

API Reference
-------------

.. toctree::
   :maxdepth: 1

   aqsession
   models
   planner
   exceptions
   marshaller


User Documentation
------------------

The user documentation contains high-level information for users.

.. toctree::
   :maxdepth: 1

   basics/getting_started
   basics/installation
   basics/inventory
   basics/planning
   basics/querying
   api_reference
   
Advanced Topics
---------------

.. toctree::
   :maxdepth: 2

   advanced/topics

Developer Documentation
-----------------------

The developer documentation conatins information on how to contribute..

.. toctree::
   :maxdepth: 1

   developer/contributing
   developer/versions

References
----------

* |tridentgithub|
* |tridentpypi|
* |aquarium|
* |aquarium_dockerhub|
* |klavinslab|

.. |tridentgithub| raw:: html

   <a href="https://github.com/aquariumbio/trident" target="_blank">Trident's Github page</a>

.. |tridentpypi| raw:: html

   <a href="https://pypi.org/project/pydent/" target="_blank">Trident's PyPI repo</a>

.. |aquarium| raw:: html

   <a href="https://github.com/aquariumbio/aquarium" target="_blank">Aquarium's Github page</a>

.. |aquarium_dockerhub| raw:: html

   <a href="https://hub.docker.com/repository/docker/aquariumbio/aquarium" target="_blank">Aquarium DockerHub</a>

.. |klavinslab| raw:: html

   <a href="http://www.klavinslab.org" target="_blank">Klavin's Lab</a>