geomexp

2-d gemometric illusion experiments


Keywords
optical-illusion, psychophysical-study, psychopy, python2
License
GPL-3.0
Install
pip install geomexp==0.2

Documentation

geomexp Python2 package

To do list

  • Update MANIFEST.in and setup.py to include auxiliary files
  • create object and classes instead of using bare functions
  • Track all the used libraries and update the requirements.
  • create and upload the whole python package to PyPi(test.pypi).
  • Find a suitable freezing package for 1-click excecutable creation. Probably can use PyInstaller as suggested here
  • Test the v0.1 executable for windows.

Installing the package

  1. Download the zip or git clone the repository.
  2. Unzip if you downloaded the zip file.
  3. Open a terminal and navigate to the unzipped folder.
  4. Use pip to install
pip install geomexp  

Installing dependencies

The environment.yml file can be used by conda to create a environment which can run the package. The first line of the file will be the name of the environment. In this case it is psychopyP2N.

If you have conda installed(or download here) then use the following command to create an environment on top of which the package can run.

conda env create -f environment.yml python=2.7

The command for activating the environment just created is

conda activate psychopyP2N

For further information read here.

The method with pip and requirements.txt is not currently working.

conda install --name psychopyP2N --yes --file requirements.txt  
pip install -r requirements.txt  
conda env export > environment_droplet.yml  
conda env create -f environment.yml

to be updated

Using the package

Once the package is installed then just import it using import geomexp.ml and you can then run the Muller-Lyer experiment as follows.

geomexp.ml.ml_exp()  

The experiment will start by asking some basic details about the subject. The esc key will pause the experiment, and q will quit the expeiment. The gathered data will be stored in a folder called "data", at the location where you are running the terminal.