##############################
Plugins: what are they?
##############################

.. role:: bash(code)
   :language: bash


Plugins in pyCIF are the elementary block of the python library.
They are the basic class on which all other classes are built.

All data and meta-data in pyCIF are stored as attributes of
:bash:`Plugin` class instance.

Dependencies and links between each :bash:`plugin` are automatically dealt with,
as further explained :doc:`here <dependencies>`.

The list of classes in the CIF is detailed below.
Click to expand the code of each class.
For each class, please refer to the corresponding page for the list of available plugins
and further documentation:

    1. :bash:`Plugin` class

       .. container:: toggle

         .. container:: header

           Click here to expand the code of the :bash:`Plugin` class

         .. autoclass:: pycif.utils.classes.baseclass.Plugin
             :members:

    2. :bash:`Setup` class

       .. container:: toggle

         .. container:: header

           Click here to expand the code of the :bash:`Setup` class

         .. autoclass:: pycif.utils.classes.setup.Setup
             :members:

    3. :doc:`Chemistry class <plugins/chemistries/index>`

       .. container:: toggle

         .. container:: header

           Click here to expand the code of the :bash:`Chemistry` class

         .. autoclass:: pycif.utils.classes.chemistries.Chemistry
             :members:

    4. :doc:`Controlvect class <plugins/controlvects/index>`

       .. container:: toggle

         .. container:: header

           Click here to expand the code of the :bash:`Controlvect` class

         .. autoclass:: pycif.utils.classes.controlvects.ControlVect
             :members:

    5. :doc:`Datastream class <plugins/datastreams/index>`

       .. container:: toggle

         .. container:: header

           Click here to expand the code of the :bash:`Datastream` class

         .. autoclass:: pycif.utils.classes.datastreams.DataStream
             :members:

    6. :doc:`Datavect class <plugins/datavects/index>`

       .. container:: toggle

         .. container:: header

           Click here to expand the code of the :bash:`Datavect` class

         .. autoclass:: pycif.utils.classes.datavects.DataVect
             :members:

    7. :doc:`Domain class <plugins/domains/index>`

       .. container:: toggle

         .. container:: header

           Click here to expand the code of the :bash:`Domain` class

         .. autoclass:: pycif.utils.classes.domains.Domain
             :members:


    8. :doc:`Measurement class <plugins/measurements/index>`

       .. container:: toggle

         .. container:: header

           Click here to expand the code of the :bash:`Measurement` class

         .. autoclass:: pycif.utils.classes.measurements.Measurement
             :members:


    9. :doc:`Minimizer class <plugins/minimizers/index>`

       .. container:: toggle

         .. container:: header

           Click here to expand the code of the :bash:`Minimizer` class

         .. autoclass:: pycif.utils.classes.minimizers.Minimizer
             :members:


    10. :doc:`Model class <plugins/models/index>`

       .. container:: toggle

         .. container:: header

           Click here to expand the code of the :bash:`Model` class

         .. autoclass:: pycif.utils.classes.models.Model
             :members:


    11. :doc:`Mode class <plugins/modes/index>`

        .. container:: toggle

          .. container:: header

            Click here to expand the code of the :bash:`Mode` class

          .. autoclass:: pycif.utils.classes.modes.Mode
              :members:


    12. :doc:`Obsoperator class <plugins/obsoperators/index>`

        .. container:: toggle

          .. container:: header

            Click here to expand the code of the :bash:`Obsoperator` class

          .. autoclass:: pycif.utils.classes.obsoperators.ObsOperator
              :members:


    13. :doc:`Obsparser class <plugins/obsparsers/index>`

        .. container:: toggle

          .. container:: header

            Click here to expand the code of the :bash:`Obsparser` class

          .. autoclass:: pycif.utils.classes.obsparsers.ObsParser
              :members:


    14. :doc:`Obsvect class <plugins/obsvects/index>`

        .. container:: toggle

          .. container:: header

            Click here to expand the code of the :bash:`Obsvect` class

          .. autoclass:: pycif.utils.classes.obsvects.ObsVect
              :members:


    15. :doc:`Platform class <plugins/platforms/index>`

        .. container:: toggle

          .. container:: header

            Click here to expand the code of the :bash:`Platform` class

          .. autoclass:: pycif.utils.classes.platforms.Platform
              :members:


    16. :doc:`Simulator class <plugins/simulators/index>`

        .. container:: toggle

          .. container:: header

            Click here to expand the code of the :bash:`Simulator` class

          .. autoclass:: pycif.utils.classes.simulators.Simulator
              :members:


    17. :doc:`Transform class <plugins/transforms/index>`

        .. container:: toggle

          .. container:: header

            Click here to expand the code of the :bash:`Transform` class

          .. autoclass:: pycif.utils.classes.transforms.Transform
              :members: