Metadata-Version: 2.4
Name: qpoint
Version: 1.13.0
Summary: A lightweight quaternion-based library for efficient telescope pointing
Author-email: Alexandra Rahlin <arahlin@users.noreply.github.com>
License: MIT License
        
        Copyright (c) 2017 Alexandra Rahlin
        
        Permission is hereby granted, free of charge, to any person obtaining a copy
        of this software and associated documentation files (the "Software"), to deal
        in the Software without restriction, including without limitation the rights
        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
        copies of the Software, and to permit persons to whom the Software is
        furnished to do so, subject to the following conditions:
        
        The above copyright notice and this permission notice shall be included in all
        copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
        SOFTWARE.
        
Project-URL: source, https://github.com/arahlin/qpoint
Requires-Python: >=3.8
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: numpy>1.10.0
Requires-Dist: scipy
Requires-Dist: astropy
Dynamic: license-file

# qpoint

[![](https://badge.fury.io/py/qpoint.svg)](https://badge.fury.io/py/qpoint)
[![](https://github.com/arahlin/qpoint/actions/workflows/documentation.yaml/badge.svg)](https://github.com/arahlin/qpoint/actions/workflows/documentation.yaml)
[![](https://github.com/arahlin/qpoint/actions/workflows/release.yaml/badge.svg)](https://github.com/arahlin/qpoint/actions/workflows/release.yaml)
[![pre-commit.ci status](https://results.pre-commit.ci/badge/github/arahlin/qpoint/master.svg)](https://results.pre-commit.ci/latest/github/arahlin/qpoint/master)

A lightweight quaternion-based library for telescope pointing.  This library is
forked from the `libactpol` pointing library, originally written by M. Nolta.

Written and maintained by Alexandra Rahlin.

Documentation can be found [here](https://arahlin.github.io/qpoint/).

Other Contributors:

* Steve Benton
* Anne Gambrel
* Carlo Contaldi
* Ivan Padilla
* Matthew Hasselfield

### Requirements

* GNU, Intel or LLVM C compiler
* Python 2.7, Python 3+
* `numpy` library, version 1.10.0 or newer (for python bindings)
* `astropy` library, version 1.2 or newer (optional, for baking in IERS-A data)
* [ERFA C library](https://github.com/liberfa/erfa) (version 2.0.0, based on
  SOFA issue 2021-05-12 bundled with this package)
* [HEALPix C library](http://healpix.sourceforge.net/) (v. 3.31 bundled with
  this package)

### Installation

For most users, it should be sufficient to install the python library from PyPI:

```
pip install qpoint
```

This will install the python bindings and library code compiled with OpenMP
support, if possible (only available with GCC or Intel compilers).

### Usage

To use the pointing library, initialize a `qpoint.QPoint` instance.  When
installed from PyPI, the internal IERS table is left empty.  Use the
`update_iers` argument to update the internal IERS-A table using the IERS
utilities provided by `astropy` (this of course assumes that you have `astropy`
installed on your system):

```
>>> import qpoint as qp
>>> Q = qp.QPoint(update_iers=True)
```

See the [documentation](https://arahlin.github.io/qpoint/) for more details.
See also some example Python code in `examples/`.
