Skip to main content

Python wrapper for ERFA library

Project description

===========
erfa_python
===========

This is a Python wrapper for ERFA, Essential Routines for
Fundamental Astronomy, a library derived and 'freed' from SOFA,
Standards of Fundamental Astronomy.

ERFA : https://github.com/liberfa/erfa

SOFA : http://www.iausofa.org

-----------
requirements
-----------

to use this wrapper, you need:

* Python 2.7 - 3.4

* C compiler to build the module.

. newer version of gcc (4.7+) is prefered.

--------
download
--------

erfa_python is available from Pypi:

https://pypi.python.org/pypi/erfa_python

and from github:

https://github.com/nirinA/erfa_python/


------------
building
------------

* to build the module, unpack the tarball,
cd to ``erfa_python`` directory and do the usual:

```
python setup.py build
```

note for OS X:
**************

* on OSX platform, it seems that ``erfa`` needs to be build as a library,
and some 'compatibility version' needs to be adjusted
thanks to @vhaasteren for reporting and solving this issue, see:

https://github.com/nirinA/erfa_python/issues/4

------------
installing
------------

* if previous version of erfa_python is already installed in ``site-packages``,
be sure to remove all related files before installing the new version.

* install (may need root privilege) with:

```
python setup.py install
```

-------
testing
-------

a test-suite adapted from t_erfa_c.c is provided.
do:

```
python erfa_test.py
```

to validate erfa_python module.

note:
*****
some test fail with older version of gcc (4.5).
thanks to @yanwang2012 for this report, see:

https://github.com/nirinA/erfa_python/issues/6

-------------
documentation
-------------

on-line documentation is available with:

```
pydoc erfa
```

to generate a html version:

```
pydoc -w erfa
```

and, from the interpreter:

```
>>> help(erfa)
>>> help(erfa.<function>)
```

C-api reference of liberfa is available in ``doc/api.rst``.
a html version can be built:

```
cd doc
mkdir _build
sphinx-build . _build
```

you need ``sphinx`` and its dependencies to build the doc.

--------
examples
--------

some examples adapted from SOFA documentation
can be found in ``examples/`` directory.

***********
. ex_ast.py
***********

example of Astrometry Tools

***********
. ex_pn.py
***********

example of tools for Earth Attitude

***********
. ex_ts.py
***********

example of Time Scale and Calendar Tools

***********
. ex_ephem.py
***********

basic example of Ephemerids for Sun and Major planets

----------
what's new
----------

***********
. 20140601
**********

- ``erfa`` source is included, so a pre-installed ``liberfa`` is no longer required.

***********
. 20140530
**********

- update ex_ast.py
- fix _erfamodule.c docstring

***********
. 20140127
**********

- support for Python-3.4.

***********
. 20131226
**********

- completed routines from the latest SOFA release.
- renamed and slightly reworked the C extension to _erfamodule.c

***********
. 20131222
**********

- added a few routines from the latest SOFA release.

***********
. 20130830
**********

- registered to PyPi

***********
. 20130815
**********

- rewrote the wrapper from SOFA to ERFA

Project details


Release history Release notifications

History Node

2018.02.01

History Node

2017.04.21

History Node

2016.12.24

History Node

2016.12.23

History Node

2016.08.03

History Node

2016.06.11

History Node

2016.05.04

History Node

2016.05.03

History Node

2015.02.11

History Node

2014.10.16

History Node

2014.09.21

History Node

2014.09.20

History Node

2014.09.19

This version
History Node

2014.06.17

History Node

2014.06.02

History Node

2014.06.01

History Node

2014.05.30

History Node

2014.01.27

History Node

2014.01.26

History Node

2014.01.25

History Node

2014.01.23

History Node

2014.01.17

History Node

2014.01.16

History Node

2014.01.13

History Node

2013.12.29

History Node

2013.12.28

History Node

2013.12.26

History Node

2013.09.04

History Node

2013.08.30

History Node

2013.08.15

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Filename, size & hash SHA256 hash help File type Python version Upload date
erfa_python-2014.06.17.tar.gz (338.8 kB) Copy SHA256 hash SHA256 Source None Jun 17, 2014

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging CloudAMQP CloudAMQP RabbitMQ AWS AWS Cloud computing Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page