Skip to main content

Tool for simulating MAVIS images

Project description

MAVISIM

GitHub contributors License PyPI - Python Version PyPI version Tests

Image simulating tool for the next generation ESO instrument MAVIS. If you use MAVISIM please cite Monty et al. 2021.

Getting started

For full documentation, see mavisim.readthedocs.io. To get started, install via pip:

pip install mavisim

and use the CLI:

mavisim --help

which should output something like:

usage: mavisim [-h] [-o OUTPUT] [-d DISTS] [--static STATIC] [--header HEADER] field psfs

mavis image simulator

positional arguments:
  field                 file containing source field to simulate
  psfs                  specify PSFs fits file on disk to use in simulation

options:
  -h, --help            show this help message and exit
  -o OUTPUT, --output OUTPUT
                        specify name for output fits file
  -d DISTS, --dists DISTS
                        specify distortion file on disk to pre-distort sources with
  --static STATIC, -s STATIC
                        use only 1 psf (not field varying), at the given psf fits hdu index
  --header HEADER       dict to be parsed as header for saved fits file

Current Version

1.1 - EtE PSF - more accurate representation of the PSF, suitable for photometric and astrometric science cases

Documentation can be found here

Past Versions

1.0 - Fourier PSF - fast, most flexibility for astrometric modeling

Documentation can be found here

General Features

  1. Can simulate full stellar field (eg. Milky Way Globular Cluster) from an input catalogue
  2. Models three major sources of astrometric error introduced by the AO system:
    1. Tip-tilt residuals originating from uncorrected LO aberrations (dependent on the NGS constellation brightness and geometry) field variable
    2. HO aberrations originating from the LGS constellation and characteristics field variable
    3. Static field distortion originating from the AO module optics

Current Limitations

  1. Monochromatic images only
  2. Only compatible with input point source catalogues only

Future Versions

MAVISIM 1.2: Broadband End-to-End PSF

Broadband images! Starting with the V band

MAVISIM 2.0

Extended object version, not yet in development.

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

mavisim-1.1.20.tar.gz (42.0 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

mavisim-1.1.20-py3-none-any.whl (35.9 kB view details)

Uploaded Python 3

File details

Details for the file mavisim-1.1.20.tar.gz.

File metadata

  • Download URL: mavisim-1.1.20.tar.gz
  • Upload date:
  • Size: 42.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.0 CPython/3.12.2

File hashes

Hashes for mavisim-1.1.20.tar.gz
Algorithm Hash digest
SHA256 b6390764cce1eb1fcf3b9d3d3cbb6e1cff3ad17fac933949d43e74edc51b2311
MD5 d9eca4c17aadc6e3d2bb06e41b605b38
BLAKE2b-256 87759b7705e948dbfec1b5bccdf0fc03929e9de0b8addd4be82525eb12d364f2

See more details on using hashes here.

File details

Details for the file mavisim-1.1.20-py3-none-any.whl.

File metadata

  • Download URL: mavisim-1.1.20-py3-none-any.whl
  • Upload date:
  • Size: 35.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.0 CPython/3.12.2

File hashes

Hashes for mavisim-1.1.20-py3-none-any.whl
Algorithm Hash digest
SHA256 b9096f7615f8578ca771a9de12783f5a1c00a374dccfb7c7602bada3cd306504
MD5 35c65bb2177c907a4f75feafc1835543
BLAKE2b-256 36453ac86aa1920d67840a74a4be699ae70649da2a46995a8246571da205b190

See more details on using hashes here.

Supported by

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