Metadata-Version: 2.4
Name: radiosim
Version: 0.1.0
Summary: Simulation of radio skies to create astrophysical data sets
Project-URL: Repository, https://github.com/radionets-project/radiosim
Author: radionets Developers
Maintainer-email: Kevin Schmitz <kevin2.schmiz@tu-dortmund.de>, Christian Arauner <christian.arauner@tu-dortmund.de>
License: MIT
License-File: LICENSE
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: MIT License
Classifier: Natural Language :: English
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.9
Classifier: Topic :: Scientific/Engineering :: Astronomy
Classifier: Topic :: Scientific/Engineering :: Physics
Requires-Python: >=3.11
Requires-Dist: astropy
Requires-Dist: click
Requires-Dist: h5py
Requires-Dist: joblib
Requires-Dist: numpy
Requires-Dist: opencv-python
Requires-Dist: pathlib
Requires-Dist: rich
Requires-Dist: scikit-image
Requires-Dist: scipy
Requires-Dist: toml
Requires-Dist: tqdm
Provides-Extra: torch
Requires-Dist: torch; extra == 'torch'
Requires-Dist: torchvision; extra == 'torch'
Description-Content-Type: text/markdown

# radiosim
Simulation of radio skies to create astrophysical data sets.
This repository is part of the [`radionets-project`](https://github.com/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:
```
$ mamba env create -f environment.yml
```
You can start the environment with
```
$ 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
```
$ radiosim-simulate path/to/rc/file.toml
```
You can find an exemplary 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
the necessary dependencies using the command

```
$ pip install ".[torch]"
```

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

```
$ radiosim-ppdisk path/to/rc/file.toml
```
You can find an exemplary file in `rc/default_ppdisks_simulation.toml`.
The simulations will be saved as .h5 files.

The meaning of the simulation parameters is described in the `ppdisks` module.
