boom-catalogs

A repo with scripts to ingest some astronomical catalogs in MongoDB, that boom can cross-match alerts with

Environment Setup

Create and activate a virtual environment:

python3 -m venv venv
source venv/bin/activate

Install project dependencies:

pip install -r requirements.txt

Set up your environment variables by Copy the .env.example to .env and modify the variables as needed:

cp .env.example .env

Usage

To run the download scripts, use the following command:

python downloaders/<script_name>.py <arguments>

To run the ingestion scripts:

cargo build --release
./target/release/add_<file_type>_catalog

Docker and Apptainer

You can use Docker or Apptainer to create a containerized environment for running the scripts.

Apptainer

To build and run:

apptainer build apptainer.sif apptainer.def
apptainer instance start --bind <host_data_path> apptainer.sif apptainer

To shell into the running instance:

apptainer shell instance://apptainer

To run the scripts inside the instance:

add_<file_type>_catalog <arguments>

To stop the instance:

apptainer instance stop apptainer