Skip to content

Commit

Permalink
update README file
Browse files Browse the repository at this point in the history
  • Loading branch information
ChAr-De committed Jan 24, 2025
1 parent b2bb036 commit 33e8e11
Showing 1 changed file with 28 additions and 0 deletions.
28 changes: 28 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,30 @@
# 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

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 path/to/rc/file.toml
```
You can find an exemplary file in `rc/default_simulation.toml`.
The simulations will be saved as `.h5` files.

0 comments on commit 33e8e11

Please sign in to comment.