.. role:: hidden
    :class: hidden-section

.. currentmodule:: geodesic.entanglement

geodesic.entanglement
=====================
This module is used to access the Entanglement service. It is an API that represents service
data structures as well as functions used for getting and sending data to Entanglemnt. For an overview
of how Entanglement represents data see :ref:`Entanglement Overview<entanglement-overview>` and for basic usage examples 
see :ref:`Entanglement Examples<entanglement-examples>`.

.. toctree::
   :maxdepth: 2
   :caption: Guides:

   Overview <entanglement_overview.rst>
   Examples <entanglement_examples.rst>


.. contents:: geodesic.entanglement
    :depth: 2
    :local:
    :backlinks: top


Data Structures
---------------

These are classes that are used to represent data and connections that are in the Entanglement service.

.. currentmodule:: geodesic.entanglement.object
.. autosummary::
    :toctree: generated
    :nosignatures:
    :template: classtemplate.rst

    Object
    Observable
    Entity
    Event
    Property
    Link
    Model
    Concept
    Predicate
    Connection

.. currentmodule:: geodesic.entanglement.dataset
.. autosummary::
    :toctree: generated
    :nosignatures:
    :template: classtemplate.rst

    Dataset
    DatasetList
    ItemAssets

Utility Functions
-----------------
.. autosummary::
    :toctree: generated
    :nosignatures:

    get_dataset
    get_datasets
    list_datasets

.. currentmodule:: geodesic.entanglement.object
.. autosummary::
    :toctree: generated
    :nosignatures:

    get_objects
    add_objects
    delete_objects
    add_connections
    delete_connections
    get_traits
    get_predicates
    add_predicates
    


Values
------
.. currentmodule:: geodesic.entanglement.object
.. autosummary::
    :toctree: generated
    :nosignatures:

    name_re
    qualifier_re
    class_re

Graph Representation
--------------------
.. currentmodule:: geodesic.entanglement.graph
.. autosummary::
    :toctree: generated
    :nosignatures:
    :template: classtemplate.rst

    Graph