Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Mention Polyhedra wrapper in README #7

Merged
merged 3 commits into from
Oct 12, 2023
Merged
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 15 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,11 @@
|:-------------:|:-------------:|:---------:|:-------:|:-------:|
|[![Dev](https://img.shields.io/badge/docs-dev-blue.svg)](https://JuliaPolyhedra.github.io/XPORTA.jl/dev) | [![Coverage Status](https://coveralls.io/repos/github/JuliaPolyhedra/XPORTA.jl/badge.svg?branch=main)](https://coveralls.io/github/JuliaPolyhedra/XPORTA.jl?branch=main)[![codecov](https://codecov.io/gh/JuliaPolyhedra/XPORTA.jl/branch/main/graph/badge.svg)](https://codecov.io/gh/JuliaPolyhedra/XPORTA.jl) | [![Linux/Mac Build Status](https://travis-ci.org/JuliaPolyhedra/XPORTA.jl.svg?branch=main)](https://travis-ci.org/github/JuliaPolyhedra/XPORTA.jl) | [![Windows Build status](https://ci.appveyor.com/api/projects/status/2kjsbavtulwhsamu?svg=true)](https://ci.appveyor.com/project/bdoolittle/xporta-jl) | [![FreeBSD Build Status](https://api.cirrus-ci.com/github/JuliaPolyhedra/XPORTA.jl.svg)](https://cirrus-ci.com/github/JuliaPolyhedra/XPORTA.jl) |

It has two components:
blegat marked this conversation as resolved.
Show resolved Hide resolved

- a thin wrapper around the complete PORTA API
- an interface to [Polyhedra](https://github.com/JuliaPolyhedra/Polyhedra.jl)

## Documentation

* XPORTA.jl documentation: [JuliaPolyhedra.github.io/XPORTA.jl/dev/](https://JuliaPolyhedra.github.io/XPORTA.jl/dev/)
Expand All @@ -16,6 +21,16 @@

PORTA and XPORTA.jl are licensed under the GNU General Public License (GPL) v2.0.

## Use with Polyhedra

To use XPORTA with Polyhedra, use `XPORTA.Library`:

```julia
using Polyhedra, XPORTA
h = hrep(...)
p = polyhedron(h, XPORTA.Library())
```

## Acknowledgments

Development of XPORTA.jl was made possible by the advisory of Dr. Eric Chitambar
Expand Down
Loading