ALminer: ALMA Archive Mining & Visualization Toolkit¶
alminer is a Python-based code to effectively query, analyse, and
visualize the ALMA science archive. It also allows users to
directly download ALMA data products and/or raw data for further image
The easiest way to install
alminer is with
pip install alminer
To obtain the most recent version of the code from GitHub:
pip install https://github.com/emerge-erc/ALminer/archive/refs/heads/main.zip
Or clone and install from source:
# If you have a Github account: git clone firstname.lastname@example.org:emerge-erc/ALminer.git # If you do not: git clone https://github.com/emerge-erc/ALminer.git # After cloning: cd ALminer pip install .
Note that depending on your setup, you may need to use pip3.
The dependencies are
pandas, pyvo, astropy version 3.1.2 or higher, and
astroquery version 0.4.2.dev6649 or higher. We only use the
for downloading data from the ALMA archive. The strict requirement to
have its newest version is due to recent changes made to the ALMA
alminer works in Python 3.
We have created an extensive tutorial Jupyter Notebook
alminer features have been highlighted. This is an
excellent starting point to get familiar with all the possibilities; a
glossary of all functions is provided at the bottom of this notebook. We
highly recommend working in a Jupyter notebook environment in order to make use of
alminer’s visualization tools. We aim to keep adding new notebooks
relevant for various sub-fields in the future.
- 1. Query tools
- 2. Filter & explore results
- 3. Plot results
- 4. Create reports
- 5. Download data
- 6. Advanced query features
alminer has been developed through a collaboration between
Allegro, the ALMA Regional Centre in
The Netherlands, and the University of Vienna as part of the EMERGE-StG
project. This project has received
funding from the European Research Council (ERC) under the European
Union’s Horizon 2020 research and innovation programme (Grant agreement
We also acknowledge the work of Leiden University M.Sc. students, Robin Mentel and David van Dop, who contributed to early versions of this work.