Skip to content
Snippets Groups Projects
Commit 286ff463 authored by Olivier Bertrand's avatar Olivier Bertrand
Browse files

Improve the doc and change its template as in readthedoc

parent 51b94af2
No related branches found
No related tags found
No related merge requests found
Analysing
=========
Finding catchment areas
-----------------------
Attractor type
--------------
Does my agent go home?
----------------------
Catchment area around a or few goals
------------------------------------
Comparing
=========
Talk about memory
.. automodule:: navipy.comparing
Image difference (IDF)
----------------------
Place code
----------
Image diff
~~~~~~~~~~
.. autofunction:: navipy.comparing.simple_imagediff
Rotational image difference (rIDF)
----------------------------------
Euclidian image diff
~~~~~~~~~~~~~~~~~~~~
.. autofunction:: navipy.comparing.imagediff
Familiarity network (Infomax)
-----------------------------
Rotational image difference function
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. autofunction:: navipy.comparing.rot_imagediff
Differential optic flow
~~~~~~~~~~~~~~~~~~~~~~~
.. autofunction:: navipy.comparing.diff_optic_flow
Memory in networks
------------------
Computing
=========
From rotational image differences
---------------------------------
From average place-code vector
------------------------------
From familiarity network
------------------------
......@@ -42,7 +42,7 @@ extensions = ['matplotlib.sphinxext.only_directives',
'sphinx.ext.coverage',
'sphinx.ext.mathjax',
'sphinx.ext.viewcode',
'sphinx.ext.githubpages']
'sphinx.ext.graphviz']
# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']
......@@ -94,7 +94,7 @@ todo_include_todos = True
# The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes.
#
html_theme = 'alabaster'
html_theme = 'sphinx_rtd_theme'
# Theme options are theme-specific and customize the look and feel of a theme
# further. For a list of options available for each theme, see the
......
Getting started
===============
Installing navipy
-----------------
.. code-block:: bash
python setup.py install
Testing navipy
--------------
.. code-block:: bash
python -m unittest discover navipy
The core modules
----------------
* Rendering
* Processing
* Comparing
* Moving
......@@ -3,19 +3,30 @@
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
Welcome to Navigation Toolbox's documentation!
==============================================
About navipy
============
Navipy is a package providing method to simulate a navigating agent in realistic environment. Navipy make use of the blender rendering engine and its python API. Therefore any environment that can be realised with blender, can be used by navipy. Blender rendering may however be too slow to test different model of navigation or the different parameters of a given model. To speed up the simulation, the scene at relevant location in the environment can be stored in a database. Then, instead of rendering the scene again, it is simply loaded from the database. The agent can, thus, jump from relevant location to the next (i.e. move on a grid) without the need to use the blender API. Moreover, certain models of navigation do not depend on the history of the agent, but instead associate a moving direction to the current agent location. With such model, a graph can be created from the moving direction at each location on a grid of relevant places. The graph make use of the package networkx, thus attracting points or loop can be found, the possible connection from one point on the grid to another can be assessed, the number of independent sub graph can be calculated, etc.
Goals
=====
The navigation toolbox aims to bring in an intuitive python toolbox different methods to model the visual navigation of a virtual agent.
* Keep the interface simple
* Allow complex environments and realistic world scenario
* Implement the most popular model of insect navigation
* Avoid re-rendering by using grid constrained motion.
Content
=======
.. toctree::
:maxdepth: 1
gettingstarted
rendering
processing
comparing
computing
moving
analysing
database
......
......@@ -75,6 +75,7 @@ the current and memorised place code.
Current opinion in neurobiology
..note: assume that the image is periodic along the x axis
(the left-right axis)
"""
if not is_ibpc(current): # and not is_obpc(current):
raise TypeError('The current and memory place code\
......
......@@ -29,7 +29,7 @@ setup_dict = {'name': 'navipy',
'description': 'Insect Navigation Toolbox',
'packages': create_package_list("navipy"),
'requires': ['numpy', 'pandas', 'matplotlib', 'scipy'],
'install_requires': ["numpy", 'pandas', 'matplotlib', 'scipy'],
'install_requires': ["numpy", 'pandas', 'matplotlib', 'scipy', 'sphinx_rtd_theme', 'pydot'],
'package_data': {'navipy': ['resources/database.db']},
'include_package_data': True, }
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment