EYRA documentation

Go to documentation

Running from Docker compose

You only need in this case to have installed docker-compose in your machine.

1. After cloning the repository, create a folder a “postgres_data” on the main directory.

2. Then run up the all the backend services at once with: docker-compose --env-file=.env.localdocker up -d --force-recreate

Setup a dev environment:

• Use miniconda3 https://docs.conda.io/en/latest/miniconda.html

• Create a virtual environment: conda create -n comic python=3

• Activate environment: conda activate comic

• Install dependencies: pip install -r requirements.txt && pip install -r requirements.dev.txt

• Install our repo in edit mode: pip install -e app

• Install docker-compose: pip install docker-compose

• Setup .env: cp .env.dev .env

• Start containers: docker-compose up postgres redis

• Run the database migrations: cd app; python manage.py migrate; python manage.py init_db_data

• Install VSCode Python extension

• Set the correct python path in .vscode/settings.json ("python.pythonPath").

• Launch Python: Django, the server should start running at http://localhost:8000.

Docs

• Building these docs

Platform

• Overview of entities and relations

Development

• Setting up a dev environment
  • Local K8s cluster?
  • Installing EYRA Helm chart
  • DNS setup
  • Using a local PostgreSQL database

REST API

• API Docs
• Authentication

References

• Models
  • Algorithms
    • Interface
    • Input
    • Algorithm
    • Implementation
    • Job
    • JobInput
  • Benchmarks
    • Benchmark
    • Submission
  • Data
    • DataType
    • DataFile
    • DataSet