Metadata-Version: 2.4
Name: rms-psfmodel
Version: 1.0.1
Summary: PSF model fitting
Author-email: "Robert S. French" <rfrench@seti.org>
Maintainer-email: "Robert S. French" <rfrench@seti.org>
License: Apache-2.0
Project-URL: Homepage, https://github.com/SETI/rms-psfmodel
Project-URL: Documentation, https://rms-psfmodel.readthedocs.io/en/latest
Project-URL: Repository, https://github.com/SETI/rms-psfmodel
Project-URL: Source, https://github.com/SETI/rms-psfmodel
Project-URL: Issues, https://github.com/SETI/rms-psfmodel/issues
Keywords: psf,point-spread-function,astronomy,gaussian,fitting
Classifier: Development Status :: 5 - Production/Stable
Classifier: Natural Language :: English
Classifier: Topic :: Scientific/Engineering
Classifier: Topic :: Scientific/Engineering :: Astronomy
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Topic :: Utilities
Classifier: License :: OSI Approved :: Apache Software License
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: Operating System :: MacOS :: MacOS X
Classifier: Operating System :: POSIX :: Linux
Classifier: Operating System :: Microsoft :: Windows
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: astropy>=5.3
Requires-Dist: numpy>=1.24
Requires-Dist: scipy>=1.10
Provides-Extra: dev
Requires-Dist: rms-psfmodel; extra == "dev"
Requires-Dist: coverage>=7.0; extra == "dev"
Requires-Dist: mypy>=1.0; extra == "dev"
Requires-Dist: pymarkdownlnt>=0.9.35; extra == "dev"
Requires-Dist: pytest>=7.0; extra == "dev"
Requires-Dist: pytest-cov>=4.0; extra == "dev"
Requires-Dist: pytest-xdist>=3.8.0; extra == "dev"
Requires-Dist: ruff>=0.8; extra == "dev"
Requires-Dist: bandit[toml]>=1.8; extra == "dev"
Requires-Dist: pyroma>=4.2; extra == "dev"
Requires-Dist: vulture>=2.14; extra == "dev"
Requires-Dist: rms-psfmodel[docs]; extra == "dev"
Provides-Extra: docs
Requires-Dist: myst-parser; extra == "docs"
Requires-Dist: sphinx>=7; extra == "docs"
Requires-Dist: sphinxcontrib-mermaid; extra == "docs"
Requires-Dist: sphinx-rtd-theme; extra == "docs"
Provides-Extra: characterize
Requires-Dist: matplotlib>=3.7; extra == "characterize"
Requires-Dist: pyyaml>=6.0; extra == "characterize"
Dynamic: license-file

# rms-psfmodel

<!-- pyml disable MD025 -->

[![GitHub release; latest by date](https://img.shields.io/github/v/release/SETI/rms-psfmodel)](https://github.com/SETI/rms-psfmodel/releases)
[![GitHub Release Date](https://img.shields.io/github/release-date/SETI/rms-psfmodel)](https://github.com/SETI/rms-psfmodel/releases)
[![Test Status](https://img.shields.io/github/actions/workflow/status/SETI/rms-psfmodel/run-tests.yml?branch=main)](https://github.com/SETI/rms-psfmodel/actions)
[![Documentation Status](https://readthedocs.org/projects/rms-psfmodel/badge/?version=latest)](https://rms-psfmodel.readthedocs.io/en/latest/?badge=latest)
[![Code coverage](https://img.shields.io/codecov/c/github/SETI/rms-psfmodel/main?logo=codecov)](https://codecov.io/gh/SETI/rms-psfmodel)
<br />
[![PyPI - Version](https://img.shields.io/pypi/v/rms-psfmodel)](https://pypi.org/project/rms-psfmodel)
[![PyPI - Format](https://img.shields.io/pypi/format/rms-psfmodel)](https://pypi.org/project/rms-psfmodel)
[![PyPI - Downloads](https://img.shields.io/pypi/dm/rms-psfmodel)](https://pypi.org/project/rms-psfmodel)
[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/rms-psfmodel)](https://pypi.org/project/rms-psfmodel)
<br />
[![GitHub commits since latest release](https://img.shields.io/github/commits-since/SETI/rms-psfmodel/latest)](https://github.com/SETI/rms-psfmodel/commits/main/)
[![GitHub commit activity](https://img.shields.io/github/commit-activity/m/SETI/rms-psfmodel)](https://github.com/SETI/rms-psfmodel/commits/main/)
[![GitHub last commit](https://img.shields.io/github/last-commit/SETI/rms-psfmodel)](https://github.com/SETI/rms-psfmodel/commits/main/)
<br />
[![Number of GitHub open issues](https://img.shields.io/github/issues-raw/SETI/rms-psfmodel)](https://github.com/SETI/rms-psfmodel/issues)
[![Number of GitHub closed issues](https://img.shields.io/github/issues-closed-raw/SETI/rms-psfmodel)](https://github.com/SETI/rms-psfmodel/issues)
[![Number of GitHub open pull requests](https://img.shields.io/github/issues-pr-raw/SETI/rms-psfmodel)](https://github.com/SETI/rms-psfmodel/pulls)
[![Number of GitHub closed pull requests](https://img.shields.io/github/issues-pr-closed-raw/SETI/rms-psfmodel)](https://github.com/SETI/rms-psfmodel/pulls)
<br />
![GitHub License](https://img.shields.io/github/license/SETI/rms-psfmodel)
[![Number of GitHub stars](https://img.shields.io/github/stars/SETI/rms-psfmodel)](https://github.com/SETI/rms-psfmodel/stargazers)
![GitHub forks](https://img.shields.io/github/forks/SETI/rms-psfmodel)
[![DOI](https://zenodo.org/badge/rms-psfmodel.svg)](https://zenodo.org/badge/latestdoi/rms-psfmodel)
<!-- start-after-point -->

# Introduction

`psfmodel` provides abstract and concrete classes for modeling point spread functions (PSFs)
and fitting them to image data. It includes an analytic 2-D Gaussian PSF with optional
rotation, pixel integration, motion smearing, and background polynomial fitting, plus helpers
for astrometric position estimation via bounded optimization.

`psfmodel` is a product of the [PDS Ring-Moon Systems Node](https://pds-rings.seti.org).

# Installation

The `psfmodel` module is available via the `rms-psfmodel` package on PyPI and can be installed with:

```sh
pip install rms-psfmodel
```

# Getting Started

Details of each class are available in the [module documentation](https://rms-psfmodel.readthedocs.io/en/latest/module.html).

After installation, an optional Tkinter-based PSF explorer is available as the `psf_gui` command (or `python -m psf_gui` with `src` on `PYTHONPATH`). A working Tcl/Tk installation is required (for example, install the `python3-tk` package on Debian/Ubuntu).

A characterization tool that systematically measures Gaussian PSF fitting accuracy across a wide parameter space is available in the repository. Clone the repo, install with `pip install -e ".[characterize]"`, and run it with `python -m characterize_gauss_fit`.

# Contributing

Information on contributing to this package can be found in the
[Contributing Guide](https://github.com/SETI/rms-psfmodel/blob/main/CONTRIBUTING.md).

# Links

- [Documentation](https://rms-psfmodel.readthedocs.io)
- [Repository](https://github.com/SETI/rms-psfmodel)
- [Issue tracker](https://github.com/SETI/rms-psfmodel/issues)
- [PyPi](https://pypi.org/project/rms-psfmodel)

# Licensing

This code is licensed under the [Apache License v2.0](https://github.com/SETI/rms-psfmodel/blob/main/LICENSE).
