oskarpy documentation

This is the documentation for the Python bindings to OSKAR. The main motivations for providing Python bindings are:

1. to make it easier to run OSKAR from a scripting environment, and;
2. to allow access to data products and functions directly without having to resort to writing parameter files, or saving and loading data to and from disk where this is unnecessary.

See the Quick Start guide for installation instructions.

Contents:

• Quick Start
  • Installation
    • Linux and macOS
    • Windows
  • Using Pipenv
  • Uninstallation
  • Usage
• Using Containers
  • Docker, Podman & Kubernetes
    • Docker
    • Podman
    • Kubernetes
  • Singularity
• Example Scripts
  • Simple “hello world” example
  • Beam errors at spot frequencies
    • Summary
    • The simulation script
  • Ionospheric phase screen
    • Summary
    • Using ARatmospy to generate the TEC screen
    • The simulation script
• Class Reference
  • Input Data & Settings
    • Settings Tree
    • Sky Model
    • Telescope Model
  • Processors
    • Interferometer
    • Imager
  • Visibility Data
    • Measurement Set
    • Binary Files
    • Visibility Header
    • Visibility Block

OSKAR is made available under the 3-clause BSD License. Please see the License page for details of third-party software used by OSKAR.

• License
  • Third-party Licenses
  • Python
  • Python Modules

Indices and tables

• Index
• Search Page