Finalise the documentation

Author: evgkanias

README.md

@@ -1,2 +1,43 @@
 # InsectVision
+
 Computer Vision Toolbox for Insect Vision
+
+## Version 1.0.1
+
+This version has been created as support for the article:
+
+Gkanias E., Risse B., Mangan M., and Webb B. (2019) From skylight input to behavioural
+output: a computational model of the insect polarised light compass. PLOS Computational
+Biology.
+
+### Requirements
+
+To be able to run all the experiments and replicate the results presented in the article,
+the [compmodels](https://github.com/evgkanias/compmodels) package is needed. If you
+don't have access to this package, please contact the authors.
+
+Clone both repositories and set the **compmodels** as a dependence to the
+**insectvision** package.
+
+### Observe the plots presented in the article
+
+To see the results, it is not necessary to run the code. By simply opening the
+[notebooks/plos.ipynb](https://github.com/InsectRobotics/insectvision/blob/plos-submit/notebooks/plos.ipynb)
+file, the plots should be automatically generated for you to observe them.
+
+
+### Replicate the results from the article
+
+To create the plots by yourself, you need to start a **Jupyter notebook** kernel at
+the root of the package. Then run the [notebooks/plos.ipynb](https://github.com/InsectRobotics/insectvision/blob/plos-submit/notebooks/plos.ipynb)
+file, which already contains all the plots and the respective code to replicate them.
+Some plots (especially the ones related to the global optimisation) may need a long 
+time to run; this does not mean that they do not work.
+
+### Author
+
+All the code has been implemented by [Evripidis Gkanias](http://homepages.inf.ed.ac.uk/s1514920/).
+
+### Copyright
+
+Copyright © 2019, Insect Robotics Group, Institude of Perception, Action and Behaviour, School of Informatics, the University of Edinburgh

code/__init__.py

@@ -1 +1,13 @@
+#!/usr/bin/env python
+
+__author__ = "Evripidis Gkanias"
+__copyright__ = "Copyright (c) 2019, Insect Robotics Group," \
+                "Institude of Perception, Action and Behaviour," \
+                "School of Informatics, the University of Edinburgh"
+__credits__ = ["Evripidis Gkanias"]
+__license__ = "MIT"
+__version__ = "1.0.1"
+__maintainer__ = "Evripidis Gkanias"
+
+
 from .compass import encode_sph, decode_sph, decode_xy

code/compass.py

@@ -1,3 +1,15 @@
+#!/usr/bin/env python
+
+__author__ = "Evripidis Gkanias"
+__copyright__ = "Copyright (c) 2019, Insect Robotics Group," \
+                "Institude of Perception, Action and Behaviour," \
+                "School of Informatics, the University of Edinburgh"
+__credits__ = ["Evripidis Gkanias"]
+__license__ = "MIT"
+__version__ = "1.0.1"
+__maintainer__ = "Evripidis Gkanias"
+
+
 import numpy as np
 from numbers import Number
 

compoundeye/__init__.py

@@ -1,7 +1,15 @@
-from .beeeye import load_both_eyes as bee_eyes
+#!/usr/bin/env python
+
+__author__ = "Evripidis Gkanias"
+__copyright__ = "Copyright (c) 2019, Insect Robotics Group," \
+                "Institude of Perception, Action and Behaviour," \
+                "School of Informatics, the University of Edinburgh"
+__credits__ = ["Evripidis Gkanias"]
+__license__ = "MIT"
+__version__ = "1.0.1"
+__maintainer__ = "Evripidis Gkanias"
+
+
 from .geometry import angles_distribution, fibonacci_sphere
 from .model import CompoundEye, DRA
-from .bumblebee import BumbleBeeEye
-from .anteye import AntEye
 from .sensor import POLCompassDRA
-from .utils import get_microvilli_angle, RNG

compoundeye/anteye.py

@@ -1,3 +1,15 @@
+#!/usr/bin/env python
+
+__author__ = "Evripidis Gkanias"
+__copyright__ = "Copyright (c) 2019, Insect Robotics Group," \
+                "Institude of Perception, Action and Behaviour," \
+                "School of Informatics, the University of Edinburgh"
+__credits__ = ["Evripidis Gkanias"]
+__license__ = "MIT"
+__version__ = "1.0.1"
+__maintainer__ = "Evripidis Gkanias"
+
+
 from compoundeye.geometry import angles_distribution, fibonacci_sphere
 from sphere.transform import tilt
 from environment import Sky, eps, spectrum_influence, spectrum