InvertPy

This Python package aims to collect and implement computational models that are used in the literature and are relevant to the invertebrate processing, from the environment to sensor responses and to deeper neural responses in the invertebrate brain. It is split in 3 sub-packages: brain, sense and io; which are responsible for brain, sensor and data processing respectively.

InvertSy is a separate package that implements environments such as the sky and an AntWorld of vegetation, using simple-to-install python packages, e.g. NumPy and SciPy. These environments contain information that humans can or cannot detect but invertebrates definitely can (e.g. polarised light in the sky). This package also contains some examples of how to use the InvertPy package.

invertpy.brain

Python package that embodies brain computations of the invertebrates. This package contains python implementations of computational models for components and functions in the insect brain. The brain components include the mushroom bodies (MB) and central complex (CX). A variety of customised functions are also available allowing to change their characteristics and create your own brain models.

invertpy.sense

Python package that implements sensors of the invertebrates. The sensors are the only way that we can experience our environment. Depending on the available sensors, we can perceive different aspects of it. Invertebrates have a set of very different sensors from mammals (humans). In this package we try to capture what invertebrates sense and how do they transform their surrounding environment into neural responses that are fed to their brain.

invertpy.io

Python package that allows saving and loading brain and sensor parameters to files.

Environment

In order to be able to use this code, the required packages are listed below:

• Python 3.8
• NumPy >= 1.20.1
• SciPy >= 1.6.0
• scikit-learn >= 0.23.2

Installation

In order to install the package and reproduce the results of the manuscript you need to clone the code, navigate to the main directory of the project, install the dependencies and finally the package itself. Here is an example code that installs the package:

1. Clone this repo.

mkdir ~/src
cd ~/src
git clone https://github.com/InsectRobotics/InvertPy.git
cd InvertPy

2. Install the required libraries.

   1. using pip :

      pip install -r requirements.txt
      

   2. using conda :

      conda env create -f environment.yml
      

3. Install the package.
   1. using pip :

      pip install .
      

   2. using conda :

      conda install .
      

Note that the pip project might be needed for the above installation.

Report an issue

If you have any issues installing or using the package, you can report it here.

Author

The code is written by Evripidis Gkanias.

Copyright

Copyright © 2021, Insect robotics Group, Institute of Perception, Action and Behaviour, School of Informatics, the University of Edinburgh.