Skip to content

Latest commit

 

History

History
34 lines (25 loc) · 1.43 KB

README.md

File metadata and controls

34 lines (25 loc) · 1.43 KB
Raw

alyx

Github Actions Coverage Status

Database for experimental neuroscience laboratories

Documentation: http://alyx.readthedocs.io

Installation

Alyx has only been tested on Ubuntu (16.04 / 18.04 / 20.04), the latest is recommended. There are no guarantees that this setup will work on other systems. Assumptions made are that you have sudo permissions under an account named

The getting started section of the documentation details the steps for

  • installing the Python/Django environment
  • serving a local database
  • registering local data
  • accessing local data using ONE

Contribution

  • Development happens on the dev branch
  • alyx is sync with the master branch
  • alyx-dev is sync with the dev branch
  • Migrations files are provided by the repository
  • Continuous integration is setup, to run tests locally:
    • ./manage.py test -n test without migrations (faster)
    • ./manage.py test test with migrations (recommended if model changes)
    • NB: When running tests ensure DEBUG = True in the settings.py file (specifically SECURE_SSL_REDIRECT = True causes REST tests to fail)
$ /manage.py test -n