.. _Interface:

Interface for Python 
================================================

The following section contains the documentation for using the Python interface
that allows to set up, run studies and analyze their results.

Overview of Python classes
--------------------------

The interface consists of the following Python classes

.. currentmodule:: jcmoptimizer
                      
.. csv-table::
   :header: "Class", "Purpose"
   :widths: 50, 150

   :class:`Server`, "Class for for starting and stopping the optimization server."
   :class:`Client`, "Class for connecting to server, creating studies,
   and creating benchmarks."
   :class:`Study`, "Class for configuring, running and analyzing
   results of a study"
   :class:`Observation`, "Container for observations to be sent
   to the server."
   :class:`Suggestion`, "Suggestion retrieved by a study to be
   evaluated."
   :class:`Driver`, "Interface to driver-specific methods."
   :class:`Benchmark`, "Class for benchmarking different
   studies against each other"


Documentation
--------------
.. autoclass:: Server
   :members:
   
.. autoclass:: Client
   :members:

.. autoclass:: Study
   :members:

.. autoclass:: Observation
   :members:

.. autoclass:: Suggestion
   :members:

.. autoclass:: Benchmark
   :members:

.. autoclass:: Driver
   :members: