radiosim

Simulation of radio skies to simulate astrophysical data sets.

https://github.com/radionets-project/radiosim

Science Score: 54.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • CITATION.cff file
    Found CITATION.cff file
  • codemeta.json file
    Found codemeta.json file
  • .zenodo.json file
    Found .zenodo.json file
  • DOI references
  • Academic publication links
    Links to: zenodo.org
  • Academic email domains
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (15.1%) to scientific vocabulary
Last synced: 6 months ago · JSON representation ·

Repository

Simulation of radio skies to simulate astrophysical data sets.

Basic Info
Statistics
  • Stars: 1
  • Watchers: 1
  • Forks: 0
  • Open Issues: 2
  • Releases: 2
Created about 5 years ago · Last pushed 6 months ago
Metadata Files
Readme Changelog License Citation

README.rst

==============================================================
radiosim |ci| |pre-commit| |codecov| |pypi| |zenodo| |license|
==============================================================

.. |ci| image:: https://github.com/radionets-project/radiosim/actions/workflows/ci.yml/badge.svg?branch=main
   :target: https://github.com/radionets-project/radiosim/actions/workflows/ci.yml?branch=main
   :alt: Test Status

.. |pre-commit| image:: https://results.pre-commit.ci/badge/github/radionets-project/radiosim/main.svg
   :target: https://results.pre-commit.ci/latest/github/radionets-project/radiosim/main
   :alt: pre-commit.ci status

.. |codecov| image:: https://codecov.io/github/radionets-project/radiosim/badge.svg
   :target: https://codecov.io/github/radionets-project/radiosim
   :alt: Code coverage

.. |pypi| image:: https://badge.fury.io/py/radiosim.svg
   :target: https://badge.fury.io/py/radiosim
   :alt: PyPI version

.. |zenodo| image:: https://zenodo.org/badge/337708657.svg
   :target: https://zenodo.org/badge/latestdoi/337708657
   :alt: Zenodo DOI

.. |license| image:: https://img.shields.io/badge/License-MIT-blue.svg
   :target: https://opensource.org/license/mit
   :alt: License: MIT



Simulation of radio skies to create astrophysical data sets.
This repository is part of the `Radionets Project `__.


Installation
============

This repository is built as a python package. We recommend creating a mamba environment to handle the dependencies of all packages.
You can create one by running the following command in this repository:

.. code-block:: shell-session

   $ mamba env create --file=environment.yml

You can start the environment with

.. code-block:: shell-session

   $ mamba activate radiosim

after the installation.


Usage
=====

Radio Galaxy Simulations
------------------------

There are currently three supported simulation types:
1. ``survey`` full sky simulation
2. ``jet`` extended source
3. ``mojave`` MOJAVE like extended source

In the ``radiosim`` environment you can start the simulation with

.. code-block:: shell-session

   $ radiosim-simulate path/to/rc/file.toml

You can find an example file in ``rc/default_simulation.toml``.
The simulations will be saved as ``.h5`` files.


Protoplanetary Disk Simulations
-------------------------------

Simulating protoplanetary disks requires `pytorch `__.
You can install radiosim with the required dependencies using `uv `__:

.. code-block:: shell-session

   $ uv pip install "radiosim[torch]"


You can start the simulation with using the ``ppdisk`` CLI tool:

.. code-block:: shell-session

   $ radiosim-ppdisk path/to/rc/file.toml

You can find an example file in ``rc/default_ppdisks_simulation.toml``.
The simulations will be saved as ``.h5`` files.

The simulation parameters are described in the `ppdisks` module.

Owner

  • Name: Radionets-Project
  • Login: radionets-project
  • Kind: organization
  • Email: kevin3.schmidt@tu-dortmund.de
  • Location: Dortmund, Germany

Python packages for Machine Learning in radio interferometry.

Citation (CITATION.cff)

# This CITATION.cff file was generated with cffinit.
# Visit https://bit.ly/cffinit to generate yours today!

cff-version: 1.2.0
title: >-
  radiosim: Simulation of radio skies to create
  astrophysical data sets.
message: 'If you use this software, please cite it as below.'
type: software
authors:
  - family-names: Schmitz
    given-names: Kevin
    affiliation: 'TU Dortmund University, Germany'
    orcid: 'https://orcid.org/0000-0002-9883-4454'
    email: kevin2.schmitz@tu-dortmund.de
  - family-names: Geyer
    given-names: Felix
    affiliation: 'TU Dortmund University, Germany'
    orcid: 'https://orcid.org/0000-0002-5615-2498'
    email: felix.geyer@tu-dortmund.de
  - family-names: Poggenpohl
    given-names: Arne
    affiliation: 'TU Dortmund University, Germany'
    orcid: 'https://orcid.org/0000-0002-0746-4735'
    email: arne.poggenpohl@tu-dortmund.de
  - given-names: Christian
    family-names: Arauner
    email: christian.arauner@tu-dortmund.de
    affiliation: 'TU Dortmund University, Germany'
  - given-names: Anno
    family-names: Knierim
    email: anno.knierim@tu-dortmund.de
    affiliation: 'TU Dortmund University, Germany'
    orcid: 'https://orcid.org/0009-0004-8728-2879'
  - orcid: 'https://orcid.org/0009-0008-5497-0885'
    given-names: Tom
    family-names: Groß
    email: tom.gross@tu-dortmund.de
    affiliation: 'TU Dortmund University, Germany'
repository-code: 'https://github.com/radionets-project/radiosim'
url: 'https://radiosim.readthedocs.io/en/latest/'
keywords:
  - Astronomy
  - Data analysis
  - Simulation
license: MIT

GitHub Events

Total
  • Create event: 20
  • Release event: 1
  • Issues event: 1
  • Watch event: 1
  • Delete event: 19
  • Issue comment event: 1
  • Member event: 2
  • Push event: 40
  • Pull request event: 38
  • Pull request review event: 18
Last Year
  • Create event: 20
  • Release event: 1
  • Issues event: 1
  • Watch event: 1
  • Delete event: 19
  • Issue comment event: 1
  • Member event: 2
  • Push event: 40
  • Pull request event: 38
  • Pull request review event: 18

Issues and Pull Requests

Last synced: 6 months ago

All Time
  • Total issues: 1
  • Total pull requests: 19
  • Average time to close issues: about 3 years
  • Average time to close pull requests: 2 days
  • Total issue authors: 1
  • Total pull request authors: 4
  • Average comments per issue: 0.0
  • Average comments per pull request: 0.05
  • Merged pull requests: 14
  • Bot issues: 0
  • Bot pull requests: 1
Past Year
  • Issues: 0
  • Pull requests: 19
  • Average time to close issues: N/A
  • Average time to close pull requests: 2 days
  • Issue authors: 0
  • Pull request authors: 4
  • Average comments per issue: 0
  • Average comments per pull request: 0.05
  • Merged pull requests: 14
  • Bot issues: 0
  • Bot pull requests: 1
Top Authors
Issue Authors
  • FeGeyer (1)
Pull Request Authors
  • aknierim (8)
  • tgross03 (6)
  • ChAr-De (4)
  • pre-commit-ci[bot] (1)
Top Labels
Issue Labels
enhancement (1)
Pull Request Labels
enhancement (2) documentation (1)

Packages

  • Total packages: 1
  • Total downloads:
    • pypi 199 last-month
  • Total dependent packages: 0
  • Total dependent repositories: 0
  • Total versions: 2
  • Total maintainers: 2
pypi.org: radiosim

Simulation of radio skies to create astrophysical data sets

  • Versions: 2
  • Dependent Packages: 0
  • Dependent Repositories: 0
  • Downloads: 199 Last month
Rankings
Dependent packages count: 8.7%
Average: 28.9%
Dependent repos count: 49.1%
Maintainers (2)
Last synced: 6 months ago

Dependencies

setup.py pypi
  • astropy *
  • click *
  • h5py *
  • matplotlib *
  • numpy *
  • pathlib *
  • pytest *
  • scipy *
  • toml *
  • tqdm *
.github/workflows/ci.yml actions
  • actions/checkout v2 composite
  • actions/setup-python v2 composite
  • codecov/codecov-action v1 composite
environment.yml pypi