Skip to main content

On-sky source templates for ScopeSim

Project description

ScopeSim Templates

Build Status Documentation Status Codecov PyPI - Version

License: GPL v3

This packages contain a number of templates to generate Source objects to be used in simulations with the ScopeSim Simulator

The Documentation can be found here: https://scopesim-templates.readthedocs.io/en/latest

Installation

The best way to install the software is to use pip

pip install scopesim_templates

To install the development version you can clone the repository

git clone https://github.com/AstarVienna/ScopeSim_Templates/
cd ScopeSim_Templates
pip install -e .

Requirements

The Source object

The above functions are created to easy the creation of standard sources but the power of the Source object doesn't end there and can be used to create endless sources possibilities.

In a nutshell a Source object contains a spacial and spectral description of the sources. The spectral description are in the form of synphot spectra and the spacial description can be an astropy table referencing the spectra or a fits image. Source can also accept datacubes. The speXtra package contains an extensive library of spectral templates that can be used with the sources. Please check the relevant documentation.

Source templates included

Currently, the package covers the most typical sources used in astronomy:

  • stellar

    • star: Places a single star on the field
    • stars: Places a list of stars on the field
    • star_field: Creates field of stars with random positions
    • star_grid: Creates a field of stars with regular positions
    • cluster: Creates an age=0 cluster with a user selected mass
  • extragalactic

    • galaxy: A simple sersic model with a user selected SED from the speXtra database
    • galaxy3D: A more complex model that includes a velocity field and velocity dispersion field
    • spiral_two_component: Simple two component model with an outer spiral young SED and an old SED bulge
    • elliptical: Another sersic model using the Brown SEDs
  • misc

    • point_source: similar to star but using any SED from the speXtra database
    • uniform_source: Creates a uniform source with any SED from speXtra
    • source_from_file: Load the source from a fits file. Depending on the characteristics othe functions may be more suitable
    • source_from_imagehdu: creates a source from an ImageHDU with an arbitrary flux and scale
    • source_from_imagehdu_with_flux: creates a source from an ImageHDU where the flux/pixel is known
    • source_from_array: General function to create a source from a 2D numpy array
    • source_from_cube: Wrapper to create a source from a 3D datacube
  • calibration

    • lamp: Simulates a calibration lamp, i.e. a homogenous source with emissions lines
    • flat_field: Simulates a flat field
    • empty_sky: To simulate a sky without no other sources

Please see the documentation how to use each particular source and contact us (raise an issue or submit a pull request) if more specialized sources are needed.

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

scopesim_templates-0.5.4.tar.gz (1.8 MB view details)

Uploaded Source

Built Distribution

scopesim_templates-0.5.4-py3-none-any.whl (1.8 MB view details)

Uploaded Python 3

File details

Details for the file scopesim_templates-0.5.4.tar.gz.

File metadata

  • Download URL: scopesim_templates-0.5.4.tar.gz
  • Upload date:
  • Size: 1.8 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.3 CPython/3.11.10 Linux/6.5.0-1025-azure

File hashes

Hashes for scopesim_templates-0.5.4.tar.gz
Algorithm Hash digest
SHA256 d49d3df9e42fec39e51affcf3bbc1d891a4501c292b883923dedcc207a8dcfe8
MD5 2a061eed830e33249bfdd5f6dc7bcb08
BLAKE2b-256 cca799d67bab125d41a598cee822db9b132d477526aa70c20be20ccddbe78b5b

See more details on using hashes here.

File details

Details for the file scopesim_templates-0.5.4-py3-none-any.whl.

File metadata

  • Download URL: scopesim_templates-0.5.4-py3-none-any.whl
  • Upload date:
  • Size: 1.8 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.3 CPython/3.11.10 Linux/6.5.0-1025-azure

File hashes

Hashes for scopesim_templates-0.5.4-py3-none-any.whl
Algorithm Hash digest
SHA256 e499742cfcbadd3fd706e75daa0aac3cc0fe36b8b05522b8b3b288152a105233
MD5 c8647fcd106eb6290d4f444cabf7bd55
BLAKE2b-256 bc0395ef61d7b4965392fd472f6b358a98b05de2fce1707d9ccc27b78729efe9

See more details on using hashes here.

Supported by

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