/Hydra.Python

Python bindings for Hydra

Primary LanguageCMakeGNU General Public License v3.0GPL-3.0

GPL Licence Documentation Status Gitter

Hydra.Python

Python 2.7+ and 3.x bindings for the Hydra C++ library The bindings are produced with pybind11. The project makes use of CMAKE.

You can find the Hydra.Python GSoC2017-release here.

Documentation

Comprehensive documentation is can be found under the docs/ folder. The docs/ folder also contains the GSoC 2017 project report.

The manual of the project is generated using Sphinx and is hosted in ReadTheDocs. Find below the links for the different versions available for the manual:

  1. latest html
  2. latest pdf
  3. latest epub

Other versions, generated from different branches can be found on the here.

Doxygen reference documentation is underway.

Getting started

Work-in-progress instructions:

  1. when cmake'ing pybind11, make sure to specify the correct major Python version. For example cmake -DPYTHON_EXECUTABLE:FILEPATH=/usr/bin/python to make sure Python 2 is picked up. (Or provide the path to python3)
  2. clone the git repository: git clone https://github.com/AAAlvesJr/Hydra.git
  3. go to the Hydra.Python directory just retrieved: cd Hydra.Python
  4. create a build directory: mkdir build
  5. go to build directory: cd build
  6. cmake -DHYDRA_INSTALL_PATH=/path2sw/Hydra/ -DTHRUST_INSTALL_PATH=/path2sw/Hydra/ -DPYBIND11_INSTALL_PATH=/path2sw/pybind11/include/ ..
  7. make

These instructions create a library .so to be imported from Python.

Authors

Antonio Augusto Alves Jr , Deepanshu Tharkur and Eduardo Rodrigues