Skip to main content

Processing polarized RACS data products.

Project description


Spectra and Polarization In Cutouts of Extragalactic Sources from RACS

Scripts for processing polarized RACS data products.


pip install spiceracs

Or, after cloning this repo, please run:

pip install -e .

This will install the python dependencies and the command-line scrips. Please note: this package requires python >= 3.6.

Third-party tools

Additionally, this package also requires RM-Tools, java >= 8, and mongodb to be installed. Details on how to install these can be found at their respective websites:


If you wish to use MPI for parallelisation, please also make sure some implementation (such as OpenMPI) is also installed. If MPI is not available, then python multiprocessing can be used. Please note that multiprocessing is not capable of going across nodes in an HPC environment.

Getting started

It is recommended to use the command-line tools. Alternatively, scripts for processing RACS data are located in spiceracs/.

Bash scripts which run everything together on PBS or SBATCH systems are located in submit/.

To keep track of the many files, and associated metadata, these scripts use MongoDB. Additionally, the scripts are intended to be run in order (pipeline-style).

Currently, the order to run each script is:

  1. mongod --dbpath /path/to/database/ & -- This initialises MongoDB in a directory of your choosing.
  2. spicecutout or spiceracs/ -- Produce cubelets from a RACS field using a Selavy table.
  3. The datacubes can be removed from disk, if required. Optional: 3. spiceunresolved or spiceracs/ -- Find unresolved sources from a Selavy catalogue. 4. spicemoments or spiceracs/ -- Make Faraday moment maps for Farnes+ (2018) method. 5. spicepolfind or spiceracs/ Find polarized sources in a RACS field using the Farnes+ (2018) method.
  4. spicermsynth or spiceracs/ -- Run RM synthesis on cutouts.
  5. spicermclean or spiceracs/ -- Run RM-CLEAN on cutouts.
  6. spicemakecat or spiceracs/ -- Make RM catalogue from results.


Third-party software

This package utilises a number of third-party libraries. Please acknowledge these, as appropriate, if you use these tools for your research.

List of third party libraries:

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for spiceracs, version 0.1.0
Filename, size File type Python version Upload date Hashes
Filename, size spiceracs-0.1.0-py2.py3-none-any.whl (46.9 kB) File type Wheel Python version py2.py3 Upload date Hashes View
Filename, size spiceracs-0.1.0.tar.gz (12.2 MB) File type Source Python version None Upload date Hashes View

Supported by

Pingdom Pingdom Monitoring Google Google Object Storage and Download Analytics Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page