pyuvsim 1.2.0

A comprehensive simulation package for radio interferometers in python

pyuvsim

pyuvsim is a comprehensive simulation package for radio interferometers in python.

A number of analysis tools are available to simulate the output of a radio interferometer (CASA, OSKAR, FHD, PRISim, et al), however each makes numerical approximations to enable speed ups. pyuvsim's goal is to provide a simulated instrument output which emphasizes accuracy and extensibility, and can represent the most general simulator design.

A comparison to other simulators may be found at ReadTheDocs.

Motivation and Approach

pyuvsim's two primary goals are interferometer simulation accuracy at the level of precision necessary for 21cm cosmology science, and maximum flexibility in use cases. Key elements of this approach include:

1. High level of test coverage including accuracy (design goal is 97%).
2. Include analytic tests in unittests.
3. Comparison with external simulations.
4. Design for scalability across many cpus.
5. Fully-polarized instrument response, floating-point source position accuracy, full-sky field of view, and exact antenna positions.
6. Support for varied beam models across the array.
7. Defining a clear, user-friendly standard for simulation design.

Installation

Simple installation via pip is available for users, developers should follow the directions under Developer Installation below.

A user-installation is achieved simply with pip install pyuvsim, or to get the bleeding-edge: pip install https://github.com/RadioAstronomySoftwareGroup/pyuvsim.

By default, mpi capabilities are not enabled -- many of the utilities provided in pyuvsim do not require it. To use the simulator within pyuvsim, you should install pyuvsim with pip install pyuvsim[sim]. Note that the pyuvsim simulator is intended to run on clusters running the linux operating system, but we do test against Mac OSX as well.

There are a few more optional dependencies for pyuvsim which enable some features, such as line_profiler to use the built-in profiling. If you would like these tools as well as the full simulator, install pyuvsim with pip install pyuvsim[all]

If you wish to manage dependencies manually read on.

Dependencies

If you are using conda to manage your environment, you may wish to install the following packages before installing pyuvsim:

Required:

• numpy>=1.15
• astropy>=4.0
• scipy>1.0.1
• pyyaml>=5.1
• pyuvdata>=1.3.7
• pyradiosky
• setuptools_scm

Optional:

• mpi4py>=3.0.0
• psutil
• line_profiler
• lunarsky

Developer Installation

If you are developing pyuvsim, you will need to download and install the repository using git clone https://github.com/RadioAstronomySoftwareGroup/pyuvsim.git.

If you use conda, you may wish to use a fresh environment, in which case you can use the included environment.yaml file to make a conda environment with all the extra dependencies required for testing/development as well as the standard ones using conda env create -f environment.yml. If you do not wish to make a fresh dedicated environment, you should verify that the environment you are using contains the packages listed in that file. Then do a developer install of pyuvsim using pip install -e . (or pip install --no-deps -e . if you do not want pip to install any missing requirements).

If you do not use conda, after downloading the repository, install using pip install -e .[dev] to install all the extra dependencies required for testing/development as well as the standard ones.

Finally, install the pre-commit hook using pre-commit install to help prevent committing code that does not meet our style guidelines.

Inputs

A simulation requires sets of times, frequencies, source positions and brightnesses, antenna positions, and direction-dependent primary beam responses. pyuvsim specifies times, frequencies, and array configuration via a UVData object (from the pyuvdata package), source positions and brightnesses via Source objects, and primary beams either through UVBeam or AnalyticBeam objects.

• All sources are treated as point sources, with flux specified in Stokes parameters and position in right ascension / declination in the International Celestial Reference Frame (equivalently, in J2000 epoch).
• Primary beams are specified as full electric field components, and are interpolated in angle and frequency. This allows for an exact Jones matrix to be constructed for each desired source position.
• Multiple beam models may be used throughout the array, allowing for more complex instrument responses to be modeled.

These input objects may be made from a data file or from a set of yaml configuration files. See Running a simulation.

Outputs

Data from a simulation run are written out to a file in any format accessible with pyuvdata. This includes:

• uvfits
• MIRIAD
• uvh5

When read into a UVData object, the history string will contain information on the pyuvsim and pyuvdata versions used for that run (including the latest git hash, if available), and details on the catalog used.

Quick start guide

Example obsparam configuration files may be found in the reference_simulations directory.

1. Install from github or pip.
2. Run off of a parameter file with 20 MPI ranks:

mpirun -n 20 run_param_pyuvsim.py reference_simulations/obsparam_1.1.yaml

Documentation

Documentation on how to run simulations and developer API documentation is hosted on ReadTheDocs.

Testing

pyuvsim uses the pytest package for unit testing. If you've cloned the source into a directory pyuvsim/, you may verify it as follows:

1. Install pytest from anaconda or pip.
2. Run the pytest from pyuvsim/

pytest

You can alternatively run python -m pytest pyuvsim or python setup.py test. You will need to have all dependencies installed.

Where to find Support

Please feel free to submit new issues to the issue log to request new features, document new bugs, or ask questions.

How to contribute

Contributions to this package to add new features or address any of the issues in the issue log are very welcome. Please submit improvements as pull requests against the repo after verifying that the existing tests pass and any new code is well covered by unit tests.

Bug reports or feature requests are also very welcome, please add them to the issue log after verifying that the issue does not already exist. Comments on existing issues are also welcome.

Versioning Approach

We use a generation.major.minor format.

• Generation - Release combining multiple new physical effects and or major computational improvements. Testing: Backed by unittests, internal model validation, and significant external comparison.
• Major - Adds new physical effect or major computational improvement. Small number of improvements with each release. Testing: Backed by unittests, internal model validation and limited external comparison.
• Minor - Bug fixes and small improvements not expected to change physical model. Testing: Backed by unittests

Some helpful definitions

• Physical effects: things like polarization effects, noise, ionospheric modeling, or nonterrestrial observing positions.
• Major computational improvement: Support for new catalog types (e.g, diffuse maps), new analysis tools, changes to parallelization scheme
• Small improvements: Better documentation or example code, outer framework redesign.