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.

Sign up for GitHub

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

Jump to bottom

Mention Polyhedra wrapper in README #7

Merged
merged 3 commits into from
Oct 12, 2023
Merged

Mention Polyhedra wrapper in README #7

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
df07706
Mention Polyhedra wrapper in README
blegat Oct 6, 2023
9988dc2
Update README.md
blegat Oct 6, 2023
013da6b
Update README.md
bdoolittle Oct 12, 2023
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
19 changes: 16 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,12 @@

*A julia wrapper for the [PORTA](http://porta.zib.de/) polyhedral analysis software.*

| Documentation | Test Coverage | Linux/Mac | Windows | FreeBSD |
|:-------------:|:-------------:|:---------:|:-------:|:-------:|
|[![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) |
[![Dev](https://img.shields.io/badge/docs-dev-blue.svg)](https://JuliaPolyhedra.github.io/XPORTA.jl/dev)[![Test Status](https://github.com/JuliaPolyhedra/XPORTA.jl/actions/workflows/run_tests.yml/badge.svg)](https://github.com/JuliaPolyhedra/XPORTA.jl/actions/workflows/run_tests.yml)

XPORTA provides two features:

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

## Documentation

Expand All @@ -16,6 +19,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