This project is our final project to Computer Simulation for Sensory Systems.

Detailed software setup can be found from WIKI

• Update dataset module WIKI [2016-05-09]
• update basic processing functions on GUI and retina model [2016-05-17]
• First release of GUI by PyQtGraph [2016-05-21]
• Webcam support for the package [2016-05-21]
• Command line support for viewer [2016-05-21]
• External file support [2016-05-21]
• Redesign GUI to add fast tone transformation
• unittest-based tests
• Travis-CI integration [2016-05-21]
• Replace PyAV to moviepy for better compatibility. [2016-05-22]
• AppVeyor CI integration [2016-05-22]

We highly recommend installing Anaconda as your default Python distribution in order to avoid unnecessary messes.

• OpenCV3: conda install -c menpo opencv3=3.1.0 (for image and video processing)
• (OPTIONAL) FFMPEG: conda install -c soft-matter ffmpeg=2.2.4 (for supporting video analysis) (optional: moviepy will download FFMPEG at the first time, but you should install it if you need it for other projects.)
• PyQtGraph: conda install pyqtgraph (for GUI viewer)

Note that above requirements are installed with conda - the package management system provided along with Anaconda. Make sure you installed them before installing the package

Following packages are listed in requirements.txt, they will be installed automatically:

• numpy (for numerical computing)
• moviepy (for read videos)

Assumed you've installed above requirements

Get the stable release by:

pip install simretina

Get the bleeding edge by:

pip install git+git://github.com/duguyue100/retina-simulation.git \
-r https://raw.githubusercontent.com/duguyue100/retina-simulation/master/requirements.txt

CAUTION: WE FOUND THAT THE VIEWER MAY CRASH RANDOMLY WHILE YOU ARE SWITCHING THE MODE. WE ARE STILL TESTING THE PROGRAM, BEFORE WE SOLVED IT, YOU CAN SIMPLY RESTART THE VIEWER.

After you successfully installed the package, you are able to start the retina viewer from terminal:

retina_viewer.py

Note that above file is automatically added in your system path once you installed the package. (Yes, with the extension)

If you didn't install FFMPEG, at the first time, moviepy will download FFMPEG for you.

FOR WINDOWS USER: If you type above command, your system either start the viewer right away or it will ask for the program that opens the file, you should then find and choose python.exe from your Anaconda installation. If it's not responding, you may want to open a new console and type above command again. If it still doesn't work, please submit an issue.

Yuhuang Hu
Email: [email protected]