Metadata-Version: 2.4
Name: lentil
Version: 0.8.6
Summary: Heart-healthy physical optics
Author: Andy Kee
License: Copyright (c) 2020-2023, California Institute of Technology ("Caltech"). 
        U.S. Government sponsorship acknowledged.
        
        All rights reserved.
        
        Redistribution and use in source and binary forms, with or without
        modification, are permitted provided that the following conditions are met:
        
        1. Redistributions of source code must retain the above copyright notice, this
           list of conditions and the following disclaimer.
        
        2. Redistributions in binary form must reproduce the above copyright notice,
           this list of conditions and the following disclaimer in the documentation
           and/or other materials provided with the distribution.
        
        3. Neither the name of the copyright holder nor the names of its
           contributors may be used to endorse or promote products derived from
           this software without specific prior written permission.
        
        THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
        AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
        IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
        DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
        FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
        DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
        SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
        CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
        OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
        OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
        
Project-URL: Homepage, https://github.com/andykee/lentil
Project-URL: Documentation, https://andykee.github.io/lentil/
Project-URL: Bug Tracker, https://github.com/andykee/lentil/issues
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: BSD License
Classifier: Programming Language :: Python :: 3
Classifier: Topic :: Scientific/Engineering
Classifier: Topic :: Scientific/Engineering :: Astronomy
Classifier: Topic :: Scientific/Engineering :: Physics
Requires-Python: >=3.8
Description-Content-Type: text/x-rst
License-File: LICENSE.rst
Requires-Dist: numpy>=1.17
Requires-Dist: scipy
Dynamic: license-file

Lentil
======

Lentil is a Python library for modeling the imaging chain of an optical system.
It was originally developed at NASA's Jet Propulsion Lab by the Wavefront Sensing and
Control group (383E) to provide an easy to use framework for simulating point spread
functions of segmented aperture telescopes.

Lentil provides classes for representing optical elements with a simple interface for
including effects like wavefront error, radiometric properties, and various noise and
aberration sources. Lentil also provides numerical methods for performing Fraunhofer
(far-field) diffraction calculations. The collection of classes provided by Lentil can
be used to simulate imagery for a wide variety of optical systems.

Lentil is still under active development and new features continue to be added. Until
Lentil reaches version 1.0, the API is not guaranteed to be stable, but changes breaking
backwards compatibility will be noted.

Installing
----------
Install and update using `pip`_:

.. code-block:: text

    pip install lentil

Links
-----
* Documentation: https://andykee.github.io/lentil/
* Releases: https://pypi.org/project/lentil/
* Code: https://github.com/andykee/lentil/
* Issue tracker: https://github.com/andykee/lentil/issues/

.. _pip: https://pip.pypa.io/en/stable/quickstart/


