.. image:: images/spike_logo.004.png

Easily generated and resampled space-based PSFs.
================================================
.. image:: https://img.shields.io/badge/arXiv-2503.02288-b31b1b
    :target: https://arxiv.org/abs/2503.02288
.. image:: https://joss.theoj.org/papers/744ad03a43040debb962391d1668ea5c/status.svg
    :target: https://joss.theoj.org/papers/744ad03a43040debb962391d1668ea5c
.. image:: https://zenodo.org/badge/235378599.svg
	:target: https://doi.org/10.5281/zenodo.15791924
.. image:: https://img.shields.io/badge/GitHub-avapolzin/spike-74349c
    :target: https://github.com/avapolzin/spike

To install ``spike``, either ``pip install spike-psf`` or install the development version from the distribution on `GitHub <https://github.com/avapolzin/spike>`_. More detailed instructions are available on `this page <https://spike-psf.readthedocs.io/en/latest/install.html>`_.


.. toctree::
	:maxdepth: 1
	:caption: Documentation:

	install.rst
	quickstart.rst
	psf.rst
	psfgen.rst
	tools.rst
	faq.rst
	citation.rst
	changelog.rst

.. toctree::
	:maxdepth: 1
	:caption: Examples:

	acs_example.nblink
	wfc3_example.nblink
	nircam_example.nblink
	psf_generation.nblink


For detailed questions related to the HST, JWST, or Roman calibration pipelines, or any of the individual PSF models, please refer to the original documentation for each software as it will be more comprehensive than what is offered here.

Some common questions related to the functionality of ``spike`` are also covered by the `FAQ <https://spike-psf.readthedocs.io/en/latest/faq.html>`_. 

Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`