Welcome to the ScopeSim_Templates Documentation!

ScopeSim Templates#

Another tool from the A* Vienna software team

A library of templates and helper functions for creating scopesim.source.source.Source objects that can be used to run ScopeSim simulations.

In short scopesim.source.source.Source objects contain a description of the spatial and spectral information of the source. For more information see here.

Installation#

This package has been released on PyPi:

pip install scopesim_templates

From basic to advanced helper functions#

ScopeSim Templates is a python package, and is therefore by nature infinitely extendable.

As it is impossible for us to know all the details about your specific science case, we provide a small selection of basic objects (star cluster, elliptical galaxy, etc). A comprehensive list of those can be found below in the API reference (grouped into subpackages). Feel free to start with these to get started with ScopeSim.

However if your needs outgrow the basic objects, we encourage you to extended the objects to fit your specific science case. In this case we strongly encourage you to get in contact with us adding your code in the form of a subpackage. You can do this either by opening an issue on Github, or by emailing one of the developers.

Contact#

If you find an issue with ScopeSim Templates, please let us know via the Github issues page

Contents#

TODO list#

Todo

Set the cube to a different flux level and different pixel scales. Redshift the cube

(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/scopesim-templates/checkouts/stable/scopesim_templates/misc/misc.py:docstring of scopesim_templates.misc.misc.source_from_cube, line 6.)

Todo

Pass the header (or the WCS) to the source object

(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/scopesim-templates/checkouts/stable/scopesim_templates/misc/misc.py:docstring of scopesim_templates.misc.misc.source_from_file, line 3.)

Todo

Check if the image_hdu has WCS

(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/scopesim-templates/checkouts/stable/scopesim_templates/misc/misc.py:docstring of scopesim_templates.misc.misc.source_from_imagehdu, line 48.)

API reference#

scopesim_templates.stellar

Templates to simulate stellar sources.

scopesim_templates.extragalactic

Templates to simulate extragalactic sources.

scopesim_templates.calibration.calibration

Contains simple source functions for testing and calibration.

scopesim_templates.misc.misc

Templates that could be used to simulate more general sources.