Skip to main content

Alt text | Status | | | :—- | :—————————————- | | Tests | Run tests | | PyPi | PyPI | | Documentation Status | Documentation Status | | Python Version | Python Version | | Publish | Upload Python Package | Zenodo| DOI |Repostatus| image1 | | CodeCov | codecov | |

Overview

ALMASim is a package to generate mock observations of HI line galaxies as observed by the Atacama Large Millimetre/Submillimetre Array (ALMA). ALMASim primary goal is to allow users to generate simulated datasets on which to test deconvolution and source detection models. ALMASim is intended to leverage MPI parallel computing on modern HPC clusters to generate thousands of ALMA data cubes, but can also work on laptopts. ALMA database or a prepared catalogue is queried to sample observational metadata such as band, bandwidth, integration time, antenna configurations and so on. ALMASim employs the MARTINI Package (https://github.com/kyleaoman/martini), and the Illustris Python Package (https://github.com/illustristng/illustris_python) to be able to generate observations of extendend sources in all possible ALMA configurations. For every observed target ALMASim generates:

Citing ALMASim

If you use ALMASim in your research, please cite the following paper:

@ARTICLE{10.1093/mnras/stac3314,
author = {Delli Veneri, Michele and Tychoniec, Łukasz and Guglielmetti, Fabrizia and Longo, Giuseppe and Villard, Eric},
title = "{3D Detection and Characterisation of ALMA Sources through Deep Learning}",
journal = {Monthly Notices of the Royal Astronomical Society},
year = {2022},
month = {11},
issn = {0035-8711},
doi = {10.1093/mnras/stac3314},
url = {https://doi.org/10.1093/mnras/stac3314},
note = {stac3314},
eprint = {https://academic.oup.com/mnras/advance-article-pdf/doi/10.1093/mnras/stac3314/47014718/stac3314.pdf}
}

ALMASim entry: https://doi.org/10.1093/mnras/stac3314

Installation Notes

ALMASim works with python3 (version 3.12), and does not support python2. First create a virtual environment with python3 and activate it. Then install the required packages with pip:

  • Create the Python Environment:python3.12 -m venv astro-env

  • Activate it: source astro-env/bin/activate (in case of your shell is Bash, otherwise check the other activations scripts within the bin folders)

  • Clone the ALMASim Repository: git clone https://github.com/MicheleDelliVeneri/ALMASim.git

  • Install packages from the requirements file: pip install -r ALMASim/requirements.txt

  • Clone Illustris TNG Folder: git clone https://github.com/illustristng/illustris_python.git

  • Move to the Folder: cd illustris_python

  • Install the packages: pip install .

  • Login into Kaggle and go to: https://www.kaggle.com/settings

  • Click on create new token, this will produce a kaggle.json file which must be saved in your home folder

Getting started

To run the simulation, just navigate to the ALMASim folder and execute:

python ui.py

Notes

Cube size will dictate simulation speed and RAM usage. To gauge what you can affor to run, we advice to start with a single simulation of a 256 x 256 x 256 cube. 1.85 GHZ is the descriminator between line and continuum spectral window.

Metadata

Release files for almasim 2.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for almasim 2.0
File Size Uploaded
almasim-2.0.tar.gz 95.0 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for almasim 2.0
File Interpreter ABI Platform
almasim-2.0-py3-none-any.whl Python 3 none any Details

Total release size: 191.4 kB

Release files / almasim-2.0.tar.gz

Download URL almasim-2.0.tar.gz
Size 95.0 kB
Tags Source
SHA-256 checksum
How to use checksums
0c1928d1b1792a1749d3a536c6bfbcd7ac5267e32a03d0cb273d7a9bcb829b55
BLAKE2b-256 checksum
How to use checksums
31bcc432103f20b789911ba0f9315bb1d1a72026968788961e2ab9ebb10312d1
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/5.1.0 CPython/3.12.4

Release files / almasim-2.0-py3-none-any.whl

Download URL almasim-2.0-py3-none-any.whl
Size 96.5 kB
Tags Python 3
SHA-256 checksum
How to use checksums
2c62ef4985a4c8a4a8e9685c4c29541cc044069a95b7d3172e8f59b1161eba1d
BLAKE2b-256 checksum
How to use checksums
0db1535399340ef44fce12039e83d196859124cfc001afe30d68304b6cb4333c
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/5.1.0 CPython/3.12.4

Release history Release notifications | RSS feed

2.1.16

2 release files

2.1.15

2 release files

2.1.14

2 release files

2.1.11

2 release files

2.1.9

2 release files

2.1.7

2 release files

2.1.6

2 release files

2.1.5

2 release files

2.1.4

2 release files

2.1.3

2 release files

2.1.2

2 release files

2.1.1

2 release files

2.1.0

2 release files

2.0.9

2 release files

2.0.8

2 release files

2.0.7

2 release files

2.0.6

2 release files

2.0.5

2 release files

2.0.4

2 release files

2.0.3

2 release files

2.0.2

2 release files

2.0.1

2 release files

This release

2.0 This release

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page