Metadata-Version: 2.3
Name: ScopeSim
Version: 0.11.0
Summary: Generalised telescope observation simulator
License: GPL-3.0-or-later
Keywords: astronomy
Author: Kieran Leschinski
Author-email: kieran.leschinski@unive.ac.at
Maintainer: Kieran Leschinski
Maintainer-email: kieran.leschinski@unive.ac.at
Requires-Python: >=3.10,<3.14
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Topic :: Scientific/Engineering :: Astronomy
Requires-Dist: anisocado (>=0.4.0,<1.0)
Requires-Dist: astar-utils (>=0.4.0,<1.0)
Requires-Dist: astropy (>=6.1.7,<7.0.0)
Requires-Dist: beautifulsoup4 (>=4.13.3,<5.0.0)
Requires-Dist: docutils (>=0.19,<1.0)
Requires-Dist: httpx (>=0.28.1,<1.0)
Requires-Dist: lxml (>=5.4.0,<6.0.0)
Requires-Dist: matplotlib (>=3.10.1,<4.0.0)
Requires-Dist: more-itertools (>=10.2.0,<11.0.0)
Requires-Dist: numpy (>=1.26.4,<2.3.0)
Requires-Dist: packaging (>=24.2,<26.0)
Requires-Dist: pooch (>=1.8.2,<2.0.0)
Requires-Dist: pyyaml (>=6.0.2,<7.0.0)
Requires-Dist: scipy (>=1.15.3,<2.0.0)
Requires-Dist: skycalc-ipy (>=0.6.0,<1.0)
Requires-Dist: synphot (>=1.5.0,<2.0.0)
Requires-Dist: tqdm (>=4.66.6,<5.0.0)
Project-URL: Bug Tracker, https://github.com/AstarVienna/ScopeSim/issues
Project-URL: Changelog, https://github.com/AstarVienna/ScopeSim/blob/main/CHANGELOG.md
Project-URL: Documentation, https://scopesim.readthedocs.io/en/latest/
Project-URL: Repository, https://github.com/AstarVienna/ScopeSim
Description-Content-Type: text/markdown

# ScopeSim
## A telescope observation simulator for Python

[![Build Status](https://github.com/AstarVienna/ScopeSim/actions/workflows/tests.yml/badge.svg)](https://github.com/AstarVienna/ScopeSim/actions/workflows/tests.yml/badge.svg)
[![Build Status](https://github.com/AstarVienna/ScopeSim/actions/workflows/notebooks_with_irdb_download.yml/badge.svg)](https://github.com/AstarVienna/ScopeSim/actions/workflows/notebooks_with_irdb_download.yml/badge.svg)
[![Poetry](https://img.shields.io/endpoint?url=https://python-poetry.org/badge/v0.json)](https://python-poetry.org/)
![dev version](https://img.shields.io/badge/dynamic/toml?url=https%3A%2F%2Fraw.githubusercontent.com%2FAstarVienna%2FScopeSim%2Fmain%2Fpyproject.toml&query=%24.project.version&label=dev%20version&color=teal)

[![Documentation Status](https://readthedocs.org/projects/scopesim/badge/?version=latest)](https://scopesim.readthedocs.io/en/latest)
[![codecov](https://codecov.io/gh/AstarVienna/ScopeSim/graph/badge.svg)](https://codecov.io/gh/AstarVienna/ScopeSim)
[![PyPI - Version](https://img.shields.io/pypi/v/ScopeSim)](https://pypi.org/project/ScopeSim/)
![PyPI - Python Version](https://img.shields.io/pypi/pyversions/ScopeSim)
![GitHub Release Date](https://img.shields.io/github/release-date/AstarVienna/ScopeSim)

[![License: GPL v3](https://img.shields.io/badge/License-GPLv3-blue.svg)](https://www.gnu.org/licenses/gpl-3.0)
[![Citation](https://img.shields.io/badge/DOI-10.1117%2F12.2559784-blue)](https://doi.org/10.1117/12.2559784)

## Summary

ScopeSim aims to simulate images of astronomical objects observed with visual
and infrared instruments. It does this by creating models of the optical train
and astronomical objects and then pushing the object through the optical train.
The resulting 2D image is then broadcast to a detector chip and read out into a
FITS file.

This code was originally based on the [SimCADO](https://github.com/astronomyk/simcado) package

## Documentation
The main set of documentation can be found here:
https://scopesim.readthedocs.io/en/latest/

A basic Jupyter Notebook can be found here:
[scopesim_basic_intro.ipynb](docs/source/examples/1_scopesim_intro.ipynb)

### Feature roadmap
Take a look at the [ScopeSim Feature Roadmap](https://github.com/orgs/AstarVienna/projects/21) to see what we're currently working on.

