CI | status |
---|---|
conda.recipe | |
pip builds |
- A compiler with C++11 support
- Pip 10+ or CMake >= 3.4 (or 3.14+ on Windows, which was the first version to support VS 2019)
- Ninja or Pip 10+
- Eigen3
Just clone this repository and pip install. Note the --recursive
option which is
needed for the pybind11 and fgt submodules:
git clone --recursive https://github.com/hochshi/pyfgt.git
pip install ./pyfgt
With the setup.py
file included in this example, the pip install
command will
invoke CMake and build the pybind11 module as specified in CMakeLists.txt
.
Documentation for the project is generated using Sphinx. Sphinx has the ability to automatically inspect the signatures and documentation strings in the extension module to generate beautiful documentation in a variety formats. The following command generates HTML-based reference documentation; for other formats please refer to the Sphinx manual:
cd pyfgt/docs
make html
pyfgt is provided under a BSD-style license that can be found in the LICENSE file. By using, distributing, or contributing to this project, you agree to the terms and conditions of this license.
import pyfgt
pyfgt.direct
For usage see: fgt