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-4.1.2.tar.gz (7.0 MB view details)

Uploaded Source

Built Distribution

hera_sim-4.1.2-py2.py3-none-any.whl (2.6 MB view details)

Uploaded Python 2 Python 3

File details

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

File metadata

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

File hashes

Hashes for hera_sim-4.1.2.tar.gz
Algorithm Hash digest
SHA256 c8fa1c03bc29a5a10e3319ad83cfeb4387cf95ed38496221d56a8b9f48017f7c
MD5 dd81bfd6697fac1fa769ba7fdefcf54b
BLAKE2b-256 04e8df36520221fc832ba05b6ee01393a3f83e791fc72bd72b4a6e013b6843ee

See more details on using hashes here.

File details

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

File metadata

  • Download URL: hera_sim-4.1.2-py2.py3-none-any.whl
  • Upload date:
  • Size: 2.6 MB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.9.18

File hashes

Hashes for hera_sim-4.1.2-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 9e40246367e83a0ad83a177fe7712da35692b8a655bdf5acd968c490220bf8a7
MD5 bd9b3bad64faaca9d5a0d281127a622f
BLAKE2b-256 e867299379385e9539cb96ac36c25e3fd050ecb4f3e431eba34c3322482d9dc7

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