Skip to main content

On-sky source templates for ScopeSim

Project description

ScopeSim Templates

Poetry Build Status Documentation Status Codecov

PyPI - Version PyPI - Python Version GitHub Release Date dev 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.8.0.tar.gz (1.8 MB view details)

Uploaded Source

Built Distribution

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

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

Uploaded Python 3

File details

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

File metadata

  • Download URL: scopesim_templates-0.8.0.tar.gz
  • Upload date:
  • Size: 1.8 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/2.3.0 CPython/3.12.3 Linux/6.11.0-1018-azure

File hashes

Hashes for scopesim_templates-0.8.0.tar.gz
Algorithm Hash digest
SHA256 482b78a1ca2b955c37fe66a5b17ef71306f6e7afbd581d4a5840b3784960bf04
MD5 2587b9c850ccf741da3004a506ef067c
BLAKE2b-256 1a7e3b9fa94d2366451f38c44ad40539f3e632444343021d897bff0cdfda30ed

See more details on using hashes here.

File details

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

File metadata

  • Download URL: scopesim_templates-0.8.0-py3-none-any.whl
  • Upload date:
  • Size: 1.8 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/2.3.0 CPython/3.12.3 Linux/6.11.0-1018-azure

File hashes

Hashes for scopesim_templates-0.8.0-py3-none-any.whl
Algorithm Hash digest
SHA256 baf9ec8f6802cf8fca82c3d991d9761762d377c50d0b3d62f42e6b576a0a8b72
MD5 57a7776f2b5888ce3c14f653b65efd40
BLAKE2b-256 f0c134fd70284f6268c0b8427702a77230ae021025266c030761964c3f596a5b

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