Unverified Commit 2b40280b authored by Akke Viitanen's avatar Akke Viitanen
Browse files

modify python version requirement and AGILE_DIR

parent bb160627

docs/installation.rst

+26 −15
Original line number Diff line number Diff line
@@ -5,34 +5,45 @@ Due to the modular nature, installation of AGILE is done in a few distinct 
steps that are detailed here.



An installation script is provided, which could very well work on a typical

UNIX-based system. The install script is located in ``install.sh`` (see below).

The script attempts to simply automatize the steps that are detailed here. It

is recommended to read through the following sections in order to gain an

understanding of what is being installed and why.

UNIX-based system. The install script is located in ``install.sh`` (see

`src/scripts/install.sh` in the repository). The script attempts to simply

automatize the steps that are detailed here. It is recommended to read through

the following sections in order to gain an understanding of what is being

installed and why.



Installing the AGILE repository

-------------------------------



The main AGILE repository contains the actual pipeline as well as necessary

data files for running the software. First, enter a directory to install AGILE

in e.g. ``/home/user/lsst_inaf_agile``.

We will install AGILE under the directory `AGILE_DIR`, which can be freely

chosen by the user. For example:



::



    cd /home/user

    git clone https://www.ict.inaf.it/gitlab/akke.viitanen/lsst_inaf_agile.git

    cd /home/user/lsst_inaf_agile

    export AGILE_DIR=/home/user/lsst_inaf_agile



For the rest of the installation, we refer to this path as `$AGILE_DIR`. The

main AGILE repository contains the actual pipeline as well as necessary data

files for running the software. To clone the repository, run the following

commands:



::



    git clone \

        https://www.ict.inaf.it/gitlab/akke.viitanen/lsst_inaf_agile.git \

        "$AGILE_DIR"



Then, a virtual environment is created by using the python module ``venv``



::



    cd "$AGILE_DIR"

    python -m venv ./venv



Finally, this environment is activate by using



::



    cd "$AGILE_DIR"

    . venv/bin/activate

    pip install -e .
@@ -52,8 +63,8 @@ The only AGILE consideration is that we recommend to install ``EGG`` and 


::



    lsst_inaf_agile/opt/egg

    lsst_inaf_agile/opt/vif

    $AGILE_DIR/opt/egg

    $AGILE_DIR/opt/vif



Note that AGILE uses a custom stellar mass function for ``EGG`` based on the

COSMOS2020 galaxies. In addition, the filter bandpasses are provided in the EGG
@@ -63,7 +74,7 @@ and are located in 


::



    data/egg/share

    $AGILE_DIR/data/egg/share



Installing imSim

----------------
@@ -90,10 +101,10 @@ calibration-level data should be downloaded. Instructions on downloading these 
::



    # Create repo_assets directory

    mkdir /home/user/lsst_inaf_agile/opt/repo_assets

    mkdir $AGILE_DIR/opt/repo_assets



    # Extract the files from https://portal.nersc.gov/cfs/descssim/imSim/repo_assets/

    # to the created directory



    # Point REPO_ASSET_DIR environment variable to the location

    export REPO_ASSET_DIR=/home/user/lsst_inaf_agile/opt/repo_assets
 
    export REPO_ASSET_DIR=$AGILE_DIR/opt/repo_assets

pyproject.toml

+1 −1
Original line number Diff line number Diff line
@@ -16,7 +16,7 @@ classifiers = [ 
]

dynamic = ["version"]

#requires-python = ">=3.9"

requires-python = "==3.12.*"

requires-python = ">=3.12"

dependencies = [

    "astropy",

    "batman-package@git+https://github.com/PriyadarshiAkshay/batman.git@py13", # fixes python3.12 issue