init

.gitignore

@@ -0,0 +1 @@
+build

Makefile

@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line.
+SPHINXOPTS    =
+SPHINXBUILD   = sphinx-build
+SPHINXPROJ    = Neodroid
+SOURCEDIR     = source
+BUILDDIR      = build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

README.md

@@ -0,0 +1,3 @@
+# documentation
+
+![documentation](https://upload.wikimedia.org/wikipedia/commons/2/2b/Bookshelf.jpg)

index.html

@@ -0,0 +1 @@
+<meta http-equiv="refresh" content="0; url=./build/html/index.html" />

make.bat

@@ -0,0 +1,36 @@
+@ECHO OFF
+
+pushd %~dp0
+
+REM Command file for Sphinx documentation
+
+if "%SPHINXBUILD%" == "" (
+	set SPHINXBUILD=sphinx-build
+)
+set SOURCEDIR=source
+set BUILDDIR=build
+set SPHINXPROJ=Neodroid
+
+if "%1" == "" goto help
+
+%SPHINXBUILD% >NUL 2>NUL
+if errorlevel 9009 (
+	echo.
+	echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
+	echo.installed, then set the SPHINXBUILD environment variable to point
+	echo.to the full path of the 'sphinx-build' executable. Alternatively you
+	echo.may add the Sphinx directory to PATH.
+	echo.
+	echo.If you don't have Sphinx installed, grab it from
+	echo.http://sphinx-doc.org/
+	exit /b 1
+)
+
+%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS%
+goto end
+
+:help
+%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS%
+
+:end
+popd

requirements.txt

@@ -0,0 +1 @@
+sphinx

source/_templates/logo.html

@@ -0,0 +1,17 @@
+<div id="logo">
+    <a href="{{ pathto(master_doc) }}">
+        <h1>
+            <div style="margin-right: 40px; text-align: center;">
+                <p><span>Neodroid</span></p>
+                <p><span>SINTEF</span></p>
+            </div>
+        </h1>
+    </a>
+    <div class="headshot" style="margin-right: 40px;">
+        <a href="{{ pathto('about') }}" style="border-bottom: 0;">
+            <img src="{{ pathto('_images/neodroid_banner.png', 1) }}" alt='Neodroid'>
+            <div style="text-align: center; vertical-align: middle;">
+            </div>
+        </a>
+    </div>
+</div>

source/about.rst

@@ -0,0 +1,3 @@
+=====
+About
+=====

source/abstractions/actor.rst

@@ -0,0 +1,8 @@
+.. _actor:
+.. _motor:
+
+=====
+Actor
+=====
+
+The concept of the actor_ model is that is that is encapsulates a number of motor_ s as part of one entity. For example as brushless electric motors on a multirotor aircraft, here the actor is the aircraft and the motors in are the brushless electric motors.

source/abstractions/agent.rst

@@ -0,0 +1,9 @@
+.. _agent:
+.. _reaction:
+.. _TCP:
+
+=====
+Agent
+=====
+
+The agent_ model is an abstraction of some external agent providing reaction_ s to be acted out in the environment. The agent_ abstraction has the responsibility of providing the interface for external agents into the environment, this include passing messages back and forth through a TCP_ connection or likewise.

source/abstractions/environment_state.rst

@@ -0,0 +1,9 @@
+.. _environment_state:
+.. _observer:
+.. _actor:
+
+=================
+Environment State
+=================
+
+The environment_state_ encapsulates all information that should be exposed to external agents into one message. This message is comprised of observer_ s  with their relevant observational data, actor_ s with their positions and rotations in the environments, how much energy has been spent since the last reset, how many frames/time has passed since last reset and lastly a reward given by some objective function.

source/abstractions/index.rst

@@ -0,0 +1,24 @@
+.. _abstractions:
+
+============
+Abstractions
+============
+
+Neodroid is comprised of a collection models designed to be general and simple, to facilitate the user to easily build the mental model of the environment they building. These models include:
+
+.. toctree::
+   :maxdepth: 2
+
+   actor
+   agent
+   observer
+   reaction
+   motion
+   motor
+   environment_state
+
+and a additional one which is relevant for building the interface for an external agent with only partially observervable state of the environment.
+
+.. image:: images/neodroid_classes.*
+
+.. image:: images/reaction_brainstorm.*

source/abstractions/motion.rst

@@ -0,0 +1,11 @@
+.. _motion:
+.. _actor:
+.. _motor:
+.. _reaction:
+
+======
+Motion
+======
+
+Motions are abstractions of spendature of energy and where the energy should be spent. These is simply an address on an actor_ and a motor_ with an assigned energy strength, this energy may be positive or negative to indicate for example expansion and contraction of a motor_ or the torque applied to a motor_ clock-wise or anti-clock-wise. Its is the absolute magnitude of the strenght that counts towards total energy spendature.
+Motions are passed through reaction_ model as messages produced by the agent, this the way the external agent affect the environment.

source/abstractions/motor.rst

@@ -0,0 +1,8 @@
+.. _motor:
+
+=====
+Motor
+=====
+
+The idea of the motor is very general, is can be unary or binary, here binary refers to the sign of the motion/force being applied to it, if a motor_ is unary it can only be affected by a positive force.
+A motor can apply anything from a spinning motion to a sliding motion, it is easy the realise that both of these can be binary but also unary if chosen. Whereas a rocket motor provide a thrust motion will most likely only be unary.

source/abstractions/observer.rst

@@ -0,0 +1,7 @@
+.. _observer:
+
+========
+Observer
+========
+
+An observer or its 'sensor' synonym fits quite well for thinking about the abstraction at hand. It is responsable for capturing information in the environment to be passed on the agent. It can for example be used for capturing depth images in the environment or tracking a specific variable in the environment.

source/abstractions/reaction.rst

@@ -0,0 +1,9 @@
+.. _reaction:
+.. _agent:
+.. _motion:
+
+========
+Reaction
+========
+
+A reaction is the abstraction of a message passed from an external agent to the agent_ model providing the interface, as a response to the observed state. A reaction includes a boolean variable for resetting the environment and a number of the motion_ s to be acted out the environment by actor and their motors.

source/architecture.rst

@@ -0,0 +1,7 @@
+============
+Architecture
+============
+
+.. image:: images/neodroid_agent_game.*
+
+.. image:: images/neodroid_classes_verbs.*