Skip to content

ogmacorp/PyOgmaNeo2

Repository files navigation

PyOgmaNeo, V2

Join the chat at https://gitter.im/ogmaneo/Lobby

Introduction

Welcome to the Ogma PyOgmaNeo2 library, which contains Python bindings to the OgmaNeo2 library.

There is a deprecated version of OgmaNeo2 that contains an outdated implementation of SPH. Please use OgmaNeo2 (which this repository provides Python bindings for) if possible.

Requirements

An install of OgmaNeo2 is required before installing the bindings. Make sure to build with -DBUILD_SHARED_LIBS=On.

Additionally this binding requires an installation of SWIG v3+

  • Linux requires SWIG installed via, for example sudo apt-get install swig3.0 command (or via yum).
  • Windows requires installation of SWIG (v3). With the SourceForge Zip expanded, and the PATH environment variable updating to include the SWIG installation binary directory (for example C:\Program Files (x86)\swigwin-3.0.8).

Installation

The following example can be used to build the Python package:

python3 setup.py install --user

or create a wheel file for installation via pip:

python3 setup.py bdist_wheel
pip3 install dist/*.whl --user

Installation may fail if an old build directory still exists from a previous build. Make sure to remove such directories before rebuilding.

Importing and Setup

The PyOgmaNeo2 module can be imported using:

import pyogmaneo

Refer to the WavyLinePrediction.py example for further details.

Contributions

Refer to the CONTRIBUTING.md file for information on making contributions to PyOgmaNeo2.

License and Copyright

Creative Commons License
The work in this repository is licensed under the Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International License. See the PYOGMANEO_LICENSE.md and LICENSE.md file for further information.

Contact Ogma via licenses@ogmacorp.com to discuss commercial use and licensing options.

OgmaNeo Copyright (c) 2016-2020 Ogma Intelligent Systems Corp. All rights reserved.