Unverified Commit bae9324d authored by Akke Viitanen's avatar Akke Viitanen
Browse files

add docker installation instructions

parent 961948b6
Loading
Loading
Loading
Loading
Loading
+37 −4
Original line number Diff line number Diff line
Installation
============

AGILE may be installed using Docker (https://www.docker.com/), or manually
installing the required external dependencies. The exact manual installation
steps could vary from the target machine, while the docker container ought to
be portable. We detail both these steps here.

Docker installation
-------------------

1. Get the AGILE Dockerfile

::

   wget https://www.ict.inaf.it/gitlab/akke.viitanen/lsst_inaf_agile/-/raw/angela_install/etc/docker/Dockerfile?ref_type=heads

2. Build the Docker image

::

    docker build -t agile:latest .

3. Run the Docker image

::

    docker run -it agile:latest /bin/bash

This will launch the container with an initialized AGILE environment. Within
the environment, the external dependencies (e.g. EGG, imSim, and the LSST
Science Pipelines) can be run directly without further configuration.

Manual installation
-------------------

Due to the modular nature, installation of AGILE is done in a few distinct
steps that are detailed here.

@@ -12,7 +45,7 @@ the following sections in order to gain an understanding of what is being
installed and why.

Installing the AGILE repository
-------------------------------
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

We will install AGILE under the directory `AGILE_DIR`, which can be freely
chosen by the user. For example:
@@ -51,7 +84,7 @@ The virtual environment should be activated each time a new terminal session is
activated.

Installing EGG
--------------
^^^^^^^^^^^^^^

AGILE uses ``EGG`` (Empirical Galaxy Generator) for the creation of the truth
galaxy catalog. In addition, EGG requires the ``vif`` library to be installed. The
@@ -77,7 +110,7 @@ and are located in
    $AGILE_DIR/data/egg/share

Installing imSim
----------------
^^^^^^^^^^^^^^^^

AGILE uses ``imSim`` (https://lsstdesc.org/imSim/) to simulate synthetic
LSST-like images. The installation instructions for ``imSim`` are provided
@@ -87,7 +120,7 @@ by the AGILE team. The details are provided here:
https://lsstdesc.org/imSim/install.html#method-2-conda-and-the-stackvana-package

Installing the LSST Science Pipelines
-------------------------------------
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

AGILE uses the LSST Science Pipelines (https://pipelines.lsst.io/) to both
reduce and analyze the simulated images. The installation of the LSST Science