Quick start

Installation

Latest release

Azulero is a Python package deployed to PyPI. The simplest way to install it is with pip:

$ pip install azulero

If you already have an old version installed, use:

$ pip install --upgrade azulero

Development version

If you simply want to get the development version from time to time, use:

$ pip install git+https://github.com/kabasset/azulero

If instead, you want to modify the sources or update very often, better clone the repository locally:

$ git clone https://github.com/kabasset/azulero
$ cd azulero
$ uv run pytest
$ pip install .

Azulero is packaged with uv. Hence, there is no need to install the package in order to execute the scripts. Instead, from the clone directory, you can prepend commands with uv run. For example, to download a cutout without installing, launch:

$ uv run azul retrieve NGC6505 -r 1m

Setup

For Euclid members

Accessing public data requires no configuration.

Internal data retrieval requires authentication, which is set up in the netrc configuration file (~/.netrc on Unix, %HOMEPATH%\_netrc on Windows) as follows:

For internal SAS data, use your LDAP credentials:

machine easidr.esac.esa.int
  login <LDAP_login>
  password <LDAP_password>

For DSS data, use your archive credentials:

machine eas-dps-rest-ops.esac.esa.int
  login <EC_login>
  password <EC_password>
machine euclidsoc.esac.esa.int
  login <EC_login>
  password <EC_password>

For other users

Because you will retrieve only public data, you can setup your environment to always restrict queries to the public archive. To do so, simply set the environment variable AZULRETRIEVE_FROM to pdr (see azul retrieve and Named options to understand why). Typically, Bash users may add the following to the .bashrc file:

$ export AZULRETRIEVE_FROM=pdr

No other configuration is needed for public data.

Your first image

Because you may not want to read documentation now that everything was just setup, we propose to create an image before (carefully) reading the next pages!

We will start by downloading some Euclid data around a colorful and large-enough-but-not-too-large galaxy: UGC 11169. Go to your favorite directory and run:

$ azul retrieve UGC11169 -r 30s | azul process -w 0

This will retrieve and process an area of 1’ x 1’ or roughly 600 x 600 pixels around the galaxy core. Wait for a few seconds for the commands to complete… At the end of the logs, you should see the path to which the glorious color image was written, which you can already open and admire!

How to read the documentation?

Azulero is a command line toolbox made of several commands, e.g. azul retrieve or azul process. All of them follow a common interface on one hand, and have their own specificities on the other hand.

The shared interface concepts are described in General interface design – make sure to read this page first!

Then, each command has its own documentation page named after itself, e.g. azul retrieve or azul process. In these pages, commands are presented graphically, like:

file input {
}

object Step1 {
--param1
}
object Step2 {
}
object Step3 {
--param2
}

file interm {
}

file output {
}

input --> Step1
Step1 -> Step2
Step2 -> Step3
Step2 --> interm
Step3 --> output

The diagram depicts the sequence of steps performed by the command. If any, the command line options are listed for each step. On top of the sequence are the inputs, and below the sequence are the (intermediate and final) outputs.

After this overview section, inputs and outputs are described. Then, more details are given for each step and parameter. Additional sections may dive deeper on a case-by-case basis.