Skip to main content
Join the official Python Developers Survey 2018 and win valuable prizes: Start the survey!

An interface to Normaliz

Project description

# PyNormaliz - An interface to Normaliz


## What is PyNormaliz

PyNormaliz provides an interface to Normaliz (https://www.normaliz.uni-osnabrueck.de) via libNormaliz.
It offers the complete functionality of Normaliz, and can be used interactively from python. For a first example,
see [this introduction](examples/PyNormaliz_Tutorial.ipynb) by Richard Sieg.

## Requirements

* python 2.7 or higher or python 3.4 or higher
* Normaliz 3.2.1 Oor higher (https://github.com/Normaliz/Normaliz/releases)

## Installation

You need to have Normaliz properly installed and libNormaliz in your gcc's include path.
On most systems, installing Normaliz via
```
\> make install
```
is enough. If you prefer or are not able to install it, you need to set CPATH and
LD_LIBRARY_PATH accordingly.

After that, you can install PyNormaliz via
```
\> pip install PyNormaliz
```

## Usage

The main command is Cone to create a cone, and the member functions
of the cone class to compute properties. For a full list of input and output
properties, see the Normaliz manual.

To create a cone, use
```
import PyNormaliz
C := PyNormaliz.Cone( cone = [[1,0],[0,1]] )
```

All possible Normaliz input properties can be given as keyword arguments.

To compute a property of the cone, use the provided getters, which corresponds to Normaliz compute
goals.

```
C.HilbertBasis()
```

You can pass options to the compute functions
```
C.HilbertSeries( HSOP = True )
```

## Low level commands

There is also a low-level API, directly using C functions:

To create a cone, use
```
C := NmzCone( "cone", [[1,0],[0,1]] )
```
or, equivalently,
```
C := NmzCone( [ "cone", [[1,0],[0,1]] ] )
```
NmzCone can take an arbitrary number of arguments, either as separated arguments or in a list.
First is always a string, describing an input property for Normaliz, followed by a (possibly empty)
matrix.

NmzCompute takes a cone as first argument, followed by arbitrary many strings, or a list of strings,
describing Normaliz output properties. NmzCompute lets Normaliz compute the necessary values, and
returns true if everything was computed properly, false otherwise.
```
NmzCompute( C, "HilbertBasis" )
```
or
```
NmzCompute( C, [ "HilbertBasis" ] )
```

NmzIsComputed takes a cone and a string representing an output property, and returns true if the
property is already computed for the cone, false otherwise.
```
NmzIsComputed( C, "HilbertBasis" )
```

NmzResult takes a cone and a string representing an output property, and returns the computed
value of this property as a matrix, a list, or as a bool.
```
NmzResult( C, "HilbertBasis" )

Project details


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
PyNormaliz-1.5.tar.gz (16.5 kB) Copy SHA256 hash SHA256 Source None Feb 23, 2017

Supported by

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