GaiaXPy - Batch

A convenience script for submitting lots (>1000) Gaia DR3 source IDs through the gaiaxpy.calibrate or gaiaxpy.convert function (but can handle any number). It allows one to download the spectra directly to individual fits or txt files.

Installation

Downloading:

git clone git@github.com:Will-Cooper/gaiaxpy-batch.git
cd gaiaxpy-batch/

To keep updated:

git pull

Set-up:

Conda

The best way of setting up a clean environment with this package & gaiaxpy is to use conda.

conda env create -f environment.yml
conda activate gaiaxpy-batch
conda deactivate # to leave environment

Venv (pip)

Alternatively, to create a pip environment:

# if venv isn't installed:
python3 -m pip install --user virtualenv
# then / otherwise
python3 -m venv env  # creates directory called 'env'
source env/bin/activate
python3 -m pip install -r requirements.txt
deactivate  # to leave

Usage

Pass the gaiaxpy_batch a csv containing DR3 source IDs as discussed in the usage below:

usage: gaiaxpy_batch.py [-h] -f Filename [-s numpy function start end step] [-t] [-o {fits,txt}] [-i Source ID column name]
                        [-n Object name column name] [-u] [-x {BP,RP}] [-v]

optional arguments:
  -h, --help            show this help message and exit
  -f Filename           Input CSV file containing the Gaia DR3 Source IDs
  -s numpy function start end step
                        Wavelength [absolute nm] sampling to be retrieved, e.g. "linspace 600 1050 120"
  -t                    Truncate set of bases?
  -o {fits,txt}         Output of produced spectra (default: None)
  -i Source ID column name
                        Name of the column relating to DR3 Source ID
  -n Object name column name
                        Name of the column relating to the object name (for saving spectra)
  -u                    Switch to uncalibrated spectra mode?
  -x {BP,RP}            If in uncalibrated mode, RP or BP? (default: RP)
  -v                    Print failure errors?

The filename is the only required inputs, username and password will be prompted for. We require a username & password as that allows less restrictive access to the Gaia archive, c.f. FAQ.

It's highly recommended that you check that your source IDs have XP spectra available. You can do this by cross-matching with the dr3.xp_summary table. It'll work without this check but there can be unintended behaviour.

Examples

When calling from the command line:

Minimum Example

python gaiaxpy_batch.py -f mysourceids.csv

Expanded example

python gaiaxpy_batch.py -f mysourceids.csv -s linspace 600 1050 120 -t -o fits -i source_id -n shortname

where mysourceids.csv looks like:

source_id, shortname
1, alice
2, bob
3, charles
...

Python example

When importing the package within python:

import numpy as np
from gaiaxpy_batch import batch
kwargs = dict(sampling=np.linspace(600, 1050, 120), truncate=False, outputstyle=None)
batch('mysourceids.csv', **kwargs)

calibrate

For more information on the gaiaxpy.calibrate function, read the tutorial. Additionally, the documentation can be found here.

convert

For more information on the gaiaxpy.convert function, read the tutorial. Additionally, the documentation can be found here.

Citing

Please cite gaiaxpy following the instructions on the documentation page. The version of that code used here is:
Daniela Ruz-Mieres. (2022). gaia-dpci/GaiaXPy: GaiaXPy 1.1.1 (1.1.1). Zenodo. https://doi.org/10.5281/zenodo.6637762

If you use the software from this repo, please cite the latest version through this zenodo badge: