METIS + ScopeSim

METIS + ScopeSim

METIS + ScopeSim#

Introduction#

The METIS data simulator is based on the generic simulator ScopeSim, a descendant of the older SimCado/SimMETIS interface. METIS itself is handled as an instrument package containing configuration files for the various instrument modes and data files describing the instrument components.

The simulator currently supports imaging and long-slit spectroscopy modes. The LM-band high-resolution IFU (LMS) mode is under development.

Note

Bug reports and help desk

If you come across a bug or get stuck with ScopeSim or the METIS package, please open an issue on GitHub or contact us by email (see below).

Your feedback is the only way we know what needs to be changed or improved with the package and the simulator.

Please always include the output of scopesim.bug_report() from your installation.

Downloading the METIS instrument package#

Once ScopeSim is installed, download the METIS instrument package into your working directory:

import scopesim
scopesim.download_packages(["Armazones", "ELT", "METIS"])

This installs the packages into the subdirectory ./inst_pkgs/.

Your working directory should look like this afterwards:

my_simulations/
├── <your notebook>.ipynb
└── inst_pkgs/
    ├── Armazones/
    ├── ELT/
    └── METIS/
        └── docs/
            └── example_notebooks/
                └── <notebook>.ipynb   ← copy to working dir before running

Prerequisites#

  • A working installation of Python 3.8 or newer

  • pip (the Python package installer)

  • Jupyter, if you want to run the example notebooks (recommended)

Installing ScopeSim#

Install the latest release from PyPI:

pip install scopesim

To upgrade an existing installation:

pip install -U scopesim

Setting up a working directory#

Create a dedicated directory where your simulation notebooks will live and where the instrument packages will be downloaded:

mkdir ~/path/to/my_simulations
cd ~/path/to/my_simulations

Running the example notebooks#

The instrument package ships tutorial notebooks inside inst_pkgs/<INSTRUMENT>/docs/example_notebooks/. Copy the desired notebook out of that folder before running it — notebooks should not be run in-place, as their output would modify the package files.

cp ./inst_pkgs/<INSTRUMENT>/docs/example_notebooks/<Notebook.ipynb> .
jupyter notebook <Notebook.ipynb>

Documentation and useful references#

Contact and support#

Example notebooks#

Find the notebooks locally in inst_pkgs/METIS/docs/example_notebooks/ after downloading the package, or download them from the GitHub repository.

Warning

Run notebooks in your working directory, not inside inst_pkgs/. Copy the desired notebook out first.

Introductory notebooks#

Scientific use-case notebooks#

Effect demonstration notebooks#

These notebooks are in docs/example_notebooks/demos/.

Instrument homepage#

METIS at Leiden Observatory