Skip to main content

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.

Release files for ScopeSim_Templates 0.8.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for ScopeSim_Templates 0.8.1
File Size Uploaded
scopesim_templates-0.8.1.tar.gz 1.8 MB Details

Built distribution (wheel)

Table of built distributions (wheels) for ScopeSim_Templates 0.8.1
File Interpreter ABI Platform
scopesim_templates-0.8.1-py3-none-any.whl Python 3 none any Details

Total release size: 3.6 MB

Release files / scopesim_templates-0.8.1.tar.gz

Download URL scopesim_templates-0.8.1.tar.gz
Size 1.8 MB
Tags Source
SHA-256 checksum
How to use checksums
b108b9e84140967775c5e214c0b0f50563c9b878226eacda28585b8489f71f15
BLAKE2b-256 checksum
How to use checksums
b4792f7189fcf48379de5c3054a71ca53d4e78f4344f0bdc82f88eb618a1c519
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via poetry/2.3.0 CPython/3.12.3 Linux/6.14.0-1017-azure

Release files / scopesim_templates-0.8.1-py3-none-any.whl

Download URL scopesim_templates-0.8.1-py3-none-any.whl
Size 1.8 MB
Tags Python 3
SHA-256 checksum
How to use checksums
abebd6e1f7ee40e9c1de56458c94af6b28fedd91589086cff2086d349261a131
BLAKE2b-256 checksum
How to use checksums
e200fd54d1c4b51f68f1c1ed9a324f44423f41bf6a84f9e6a555efa003b2994a
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via poetry/2.3.0 CPython/3.12.3 Linux/6.14.0-1017-azure

Release history Release notifications | RSS feed

This release

0.8.1 This release

2 release files

0.8.0

2 release files

0.7.0

2 release files

0.6.2

2 release files

0.6.1

2 release files

0.6.0

2 release files

0.5.4

2 release files

0.5.3

2 release files

0.5.2

2 release files

0.5.1

2 release files

0.5.0

2 release files

0.4.4

2 release files

0.4.3

2 release files

0.4.2

2 release files

0.4.1

2 release files

0.4.0

2 release files

0.3.1

2 release files

0.3.0

2 release files

0.2.2

2 release files

0.2.1

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page