Merge pull request #1 from octue/0.0.3

v0.0.3
octue · Sep 12, 2019 · faf4b9f · faf4b9f
2 parents 2a95017 + 76bb7b2
commit faf4b9f
Show file tree

Hide file tree

Showing 13 changed files with 266 additions and 79 deletions.
diff --git a/.gitignore b/.gitignore
@@ -105,3 +105,8 @@ venv.bak/
 
 # jetbrains ides
 .idea/
+
+# Sphinx related files
+docs/source/doxyoutput/
+docs/source/library_api/
+docs/build/
diff --git a/docs/source/digital_twins.rst b/docs/source/digital_twins.rst
@@ -0,0 +1,57 @@
+.. _digital_twins:
+
+=============
+Digital Twins
+=============
+
+A digital twin is a virtual representation of a real life being - a physical asset like a wind turbine or car - or even
+a human.
+
+There are three reasons why you might want to create a digital twin:
+    - Monitoring
+    - Prediction
+    - Optimisation
+
+On its own, a digital twin can be quite useful. For example, a twin might embody an AI-based analysis to predict power
+output of a turbine.
+
+.. figure:: images/digital_twin_component_basic.svg
+    :width: 400px
+    :align: center
+    :figclass: align-center
+    :alt: A digital twin component
+
+    A digital twin consists of some kind of analysis or processing task, which could be run many times per second, or
+    daily, down to occasionally or sometimes only once (the same as a "normal" analysis).
+
+Coupling digital twins is generally even more useful. You might wish to couple your turbine twin with a representation
+of the local power grid, and a representation of a factory building to determine power demand... enabling you to
+optimise your factory plant for lowest energy cost whilst intelligently selling surplus power to the grid.
+
+.. figure:: images/digital_twin_hierarchy.svg
+    :width: 350px
+    :align: center
+    :figclass: align-center
+    :alt: Hierarchy of digital twins
+
+    A hierarchy of digital twins. Each blue circle represents a twin, coupled to its neighbours. Yellow nodes are where
+    schema are used to connect twins.
+
+
+.. _gemini_principles:
+
+Gemini Principles
+=================
+
+The Gemini Principles have been derived by the
+`Centre for Digital Built Britain (CDBB) <https://www.cdbb.cam.ac.uk/system/files/documents/TheGeminiPrinciples.pdf>`_.
+We strongly recommend you give them a read if embarking on a digital twins project.
+
+The aim of **twined** is to enable the following principles. In particular:
+
+#. Openness (open-source project to create schema for twins that can be run anywhere, anywhen)
+#. Federation (encouraging a standardised way of connecting twins together)
+#. Security (making sure schemas and data can be read safely)
+#. Public Good (see our nano-rant about climate change in :ref:`reason_for_being`)
+
+
diff --git a/docs/source/gemini.rst b/docs/source/gemini.rst
diff --git a/docs/source/images/digital_twin_component_basic.svg b/docs/source/images/digital_twin_component_basic.svg
diff --git a/docs/source/images/digital_twin_hierarchy.svg b/docs/source/images/digital_twin_hierarchy.svg
diff --git a/docs/source/images/placeholder.png b/docs/source/images/placeholder.png
diff --git a/docs/source/images/schema_form_example.png b/docs/source/images/schema_form_example.png