Skip to main content

A collection of simulation routines describing the HERA instrument.

Project description

Build Status Coverage Status Documentation Status

Basic simulation package for HERA-like redundant interferometric arrays.

Features

  • Systematic Models: Many models of instrumental systematics in various forms, eg. thermal noise, RFI, bandpass gains, cross-talk, cable reflections and foregrounds.

  • HERA-tuned: All models have defaults tuned to HERA, with various default “sets” available (eg.H1C, H2C)

  • Interoperability: Interoperability with pyuvdata datasets and pyuvsim configurations.

  • Ease-of-use: High-level interface for adding multiple systematics to existing visibilities in a self-consistent way.

  • Visibility Simulation: A high-level interface for visbility simulation that is compatible with the configuration definition from pyuvsim but is able to call multiple simulator implementations.

  • Convenience: Methods for adjusting simulated data to match the times/baselines of a reference dataset.

Documentation

At ReadTheDocs. In particular, for a tutorial and overview of available features, check out the tour.

Installation

Conda users

If you are using conda, the following command will install all dependencies which it can handle natively:

$ conda install -c conda-forge numpy scipy pyuvdata attrs h5py healpy pyyaml

If you are creating a new development environment, consider using the included environment file:

$ conda env create -f ci/tests.yaml

This will create a fresh environment with all required dependencies, as well as those required for testing. Then follow the pip-only instructions below to install hera_sim itself.

Pip-only install

Simply use pip install -e . or run pip install git+git://github.com/HERA-Team/hera_sim.

Developer install

For a development install (tests and documentation), run pip install -e .[dev].

Other optional extras can be installed as well. To use baseline-dependent averaging functionality, install the extra [bda]. For the ability to simulate redundant gains, install [cal]. To enable GPU functionality on some of the methods (especially visibility simulators), install [gpu].

As the repository is becoming quite large, you may also wish to perform a shallow clone to retrieve only the recent commits and history. This makes the clone faster and avoid bottleneck in CI pipelines.

Provide an argument --depth 1 to the git clone command to copy only the latest revision of the repository.

git clone -–depth [depth] git@github.com:HERA-Team/hera_sim.git

Versioning

We use semantic versioning (major.minor.patch) for the hera_sim package (see SemVer documentation). To briefly summarize, new major versions include API-breaking changes, new minor versions add new features in a backwards-compatible way, and new patch versions implement backwards-compatible bug fixes.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

hera_sim-3.1.1.tar.gz (4.9 MB view details)

Uploaded Source

Built Distribution

hera_sim-3.1.1-py2.py3-none-any.whl (481.3 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file hera_sim-3.1.1.tar.gz.

File metadata

  • Download URL: hera_sim-3.1.1.tar.gz
  • Upload date:
  • Size: 4.9 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.9.16

File hashes

Hashes for hera_sim-3.1.1.tar.gz
Algorithm Hash digest
SHA256 5c836750d2dbe0fa3c2852c68d451ddf9bda85facfb563543ebd3e59b845d255
MD5 3cb6f6171fdaad29092ce3b96838b9f3
BLAKE2b-256 080eb3cac8b0826b3e9507f07a8fa8c4584fb01a76c94b9b706055e7a6286d08

See more details on using hashes here.

File details

Details for the file hera_sim-3.1.1-py2.py3-none-any.whl.

File metadata

  • Download URL: hera_sim-3.1.1-py2.py3-none-any.whl
  • Upload date:
  • Size: 481.3 kB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.9.16

File hashes

Hashes for hera_sim-3.1.1-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 1aa21a7f15a9cf0e74a12db9e89ca72e565ba84586a2e89b0943b49d8d483b20
MD5 fe6cc751d21c1c47f53ea94c237cd447
BLAKE2b-256 1d08740f441e5b7bb183cffeeb1133be24b148543cfafe8a3dd14f8c4a8f59d9

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page