Metadata-Version: 1.1
Name: pois
Version: 0.2.0
Summary: Python optical interferometer simulation
Home-page: http://github.com/dbuscher/pois/
Author: David Buscher
Author-email: dfb@mrao.cam.ac.uk
License: UNKNOWN
Description: Python optical interferometry simulation (pois)
        ===============================================
        
        |beampath.png| This is a python package for simulating the data from a
        ground-based astronomical optical interferometer perturbed by
        atmospheric seeing perturbations. It is provided as supplementary
        material for the book `“Practical Optical Interferometry”`_, and is
        derived from the code which was used to provide data for many of the
        figures in the book.
        
        Introduction
        ------------
        
        This python package provides the building blocks to simulate the
        operation of a multi-telescope interferometer. These include functions
        to:
        
        -  generate simulated atmospheric turbulent wavefront perturbations
        -  correct these perturbations using adaptive optics
        -  combine beams from an arbitrary number of telescopes, with or without
           spatial filtering, to provide complex fringe visibility measurements.
        
        The code has been written following a functional-programming style (in
        other words minimising side-effects in the code where possible) in order
        to try and make it modular and extensible.
        
        Example code using the package is in the `tests`_ directory. The file
        `tests/test\_visibility.py`_ includes a complete simulation for
        determining visibility losses and single-mode fibre coupling losses as a
        function of the diameter of the telescopes.
        
        Requirements
        ------------
        
        The simulator runs under Python3 and requires ``numpy``. Some of the
        demonstration code uses ``astropy`` for manipulating and saving data
        tables.
        
        Installation
        ------------
        
        On unix-like systems do
        
        ::
        
            pip3 install pois
        
        Alternatively download and unpack a copy of this repository and then use
        
        ::
        
            python3 setup.py install
        
        This should install the package into Python path and so it can be
        imported using
        
        .. code:: python
        
            from pois import *
        
        or
        
        .. code:: python
        
            import pois
        
        Pronunciation
        -------------
        
        The package name should be pronounced as it would be in the phrase
        “petits pois”.
        
        Licencing
        ---------
        
        The code is licenced under a 2-clause BSD licence (see `LICENCE`_).
        
        .. _“Practical Optical Interferometry”: https://dbuscher.github.io/practical-optical-interferometry/
        .. _tests: tests
        .. _tests/test\_visibility.py: tests/test_visibility.py
        .. _LICENCE: LICENCE
        
        .. |beampath.png| image:: SNR-vs-diameter.png
        
        
        
Platform: any
Classifier: Programming Language :: Python :: 3
Classifier: Development Status :: 4 - Beta
Classifier: Natural Language :: English
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: BSD License
Classifier: Operating System :: OS Independent
Classifier: Topic :: Scientific/Engineering :: Astronomy
Classifier: Topic :: Scientific/Engineering :: Physics
