README.md 1.32 KB
Newer Older
Martin Reinecke's avatar
Martin Reinecke committed
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
pyHealpix - minimalistic Python interface for Healpix C++
=========================================================

Summary
-------

### Description

This library tries to provide Python bindings for the most important
functionality in Healpix C++. The design goals are
- similarity to the C++ interface (while respecting some Python peculiarities)
- simplicity (no optional function parameters)
- low function calling overhead

The package is implemented purely in C++, making use of the pybind11 package
(https://github.com/pybind/pybind11). It can be compiled for both Python 2 and
3.


Installation
------------

### Requirements

25
- no library dependencies, all required code is contained in the package
Martin Reinecke's avatar
Martin Reinecke committed
26
27
28
29
30
31
32
- for building, a modern C++ compiler is required (successfully tested with
  g++ 5.4 clang 4.0 and Intel icpc 17.0)

### System-wide installation

-   Install dependencies for building:

33
        sudo apt-get install g++ git python
Martin Reinecke's avatar
Martin Reinecke committed
34
35
36

-   Install pyHealpix:

Martin Reinecke's avatar
Martin Reinecke committed
37
        git clone https://gitlab.mpcdf.mpg.de/ift/pyHealpix.git
38
        (cd pyHealpix && python setup.py install)
Martin Reinecke's avatar
Martin Reinecke committed
39
40
41
42
43

### Local installation for a single user

-   Install dependencies for building:

44
        sudo apt-get install g++ git python
Martin Reinecke's avatar
Martin Reinecke committed
45
46
47

-   Install pyHealpix:

Martin Reinecke's avatar
Martin Reinecke committed
48
        git clone https://gitlab.mpcdf.mpg.de/ift/pyHealpix.git
49
        (cd pyHealpix && python setup.py install --user)