Installation¶

Docker¶

We use Docker as a container to install QLF. Install docker and docker-compose from the links below:

Make sure docker --version, docker-compose --version, and docker ps runs without error.

More details on how to use docker see Using docker and docker-compose.

QLF¶

Requires ~2 GB

Clone Quick Look Framework Project¶

git clone https://github.com/desihub/qlf.git

Everything you need is contained in this repository. Even desimodel, desisim, desitarget, desispec and desiutil as sub-repositories.

QLF Default Configuration¶

Get into qlf directory and configure it.

Make sure you have svn installed

cd qlf
./configure.sh

Besides setting the environment and cloning desispec and desiutil, this downloads the data used for tests (~1 GB).

Starting QLF¶

Start QLF frontend and backend.

./start.sh

frontend takes about 5 minutes to start in dev mode

Making sure all containers are up¶

Running docker ps you should see 4 containers:

$ docker ps
CONTAINER ID        IMAGE               COMMAND                  CREATED             STATUS              PORTS                                    NAMES
d92b7eb3583e        qlf_nginx           "nginx -g 'daemon of…"   5 minutes ago       Up 5 minutes        80/tcp, 7070/tcp, 0.0.0.0:80->8080/tcp   qlf_nginx_1
7622ffe8f2a9        qlf_backend         "/usr/bin/tini -- ./…"   5 minutes ago       Up 5 minutes        8000/tcp                                 qlf_backend_1
1c69cb7e5aff        redis               "docker-entrypoint.s…"   5 minutes ago       Up 5 minutes        6379/tcp                                 qlf_redis_1
709cc22755bc        postgres            "docker-entrypoint.s…"   5 minutes ago       Up 5 minutes        5432/tcp                                 qlf_db_1

You can access QLF interface by going to

http://localhost/

In case you need to access the backend

http://localhost/dashboard/api/

Stoping QLF¶

./stop.sh

Restarting QLF backend to update desispec changes¶

./restartBackend.sh