Package: alminer
ALminer: ALMA Archive Mining & Visualization Toolkitalmineris a Python-based code to effectively query, analyse, and visualize theALMA science archive. It also allows users to directly download ALMA data products and/or raw data for further image processing.InstallationThe easiest way to installalmineris withpip:pip install alminerTo obtain the most recent version of the code from Github:pip install https://github.com/emerge-erc/ALminer/archive/refs/heads/main.zipOr clone and install from source:# If you have a Github account:
git clone git@github.com: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.DependenciesThe dependencies arenumpy,matplotlib,pandas,pyvo,astropyversion 3.1.2 or higher, andastroqueryversion 0.4.2.dev6649 or higher. We only use theastroquerypackage for downloading data from the ALMA archive. The strict requirement to have its newest version is due to recent changes made to the ALMA archive.alminerworks in Python 3.Getting startedWe have created an extensivetutorial Jupyter Notebookwhere allalminerfeatures have been highlighted. This is an excellent starting point to get familiar with all the possibilities; a glossery of all functions is provided at the bottom of this notebook.To work with the tutorial notebook interactivelyWe highly recommend working in aJupyter notebook environmentin order to make use ofalminer's visualization tools. We aim to keep adding new notebooks relevant for various sub-fields in the future.Note that the Jupyter notebooks may be outdated. The most up-to-date information can be found on thedocumentation page.DocumentationMore information can be found in thedocumentation.What's new:You can now specify which archive mirror to download data from:ESOis the default, and other options areNRAOandNAOJ. This option can be given through the'archive_mirror'parameter in thedownload_datafunction.You can now specify which archive service to query:ESOis the default, and other options areNRAOandNAOJ. This option can be given through the'tap_service'parameter to all functions that do the query (e.g. keysearch, target, catalog). For example:alminer.target(["TW Hya", "HL Tau"], tap_service='NRAO')Note that currently the ESO service is not returning all results, hence it is advisable to test your queries with multiple services until further notice.It is now possible to query entire phrases with thekeysearchfunction. For example:alminer.keysearch({'proposal_abstract': ['"high-mass star formation" outflow disk']})will query the proposal abstracts for the phrasehigh-mass star formationAND the wordsoutflowANDdisk.alminer.keysearch({'proposal_abstract': ['"high-mass star formation" outflow disk', '"massive star formation" outflow disk']})will query the the proposal abstracts for the phrasehigh-mass star formationAND the wordsoutflowANDdiskOR the phrasemassive star formationAND the wordsoutflowANDdisk.Acknowledgementsalminerhas been developed through a collaboration betweenAllegro, the ALMA Regional Centre in The Netherlands, and the University of Vienna as part of theEMERGE-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 No. 851435).If you usealmineras part of your research, please consider citing thisASCL article(ADS reference will be added to the Github page when available).alminermakes use of different routines inAstropyandAstroquery. Please also consider citing the following papers:Astropy:Astropy Collaboration et al. 2013Astroquery:Ginsburg et al. 2019We also acknowledge the work of Leiden University M.Sc. students, Robin Mentel and David van Dop, who contributed to early versions of this work.Contact usIf you encounter issues, pleaseopen an issue.If you have suggestions for improvement or would like to collaborate with us on this project, please e-mailAida AhmadiandAlvaro Hacar.