Pycapacity

[](https://joss.theoj.org/papers/73f155afc0dfa7730792639ac374b348)

This release corresponds to the version of the package published in [JOSS](https://joss.theoj.org/)

The full paper review is available here: openjournals/joss-reviews5670
The published paper is available here: https://joss.theoj.org/papers/73f155afc0dfa7730792639ac374b348

What's changed
- [Polytope](https://auctus-team.github.io/pycapacity/pycapacity.polytope.html#pycapacity.objects.Polytope) class - [see API docs](https://auctus-team.github.io/pycapacity/pycapacity.polytope.html#pycapacity.objects)
- Added Minkowski sum (operator `+`) and intersection operations (operator `&`)
- Added inner approximation using the Chebyshev ball (`chebyshev_ball` method)
- Visualisation tools - [see API docs](https://auctus-team.github.io/pycapacity/pycapacity.visual.html#pycapacity.visual)
- `plot_polytope` function now has `color` parameter that can be used to set `face_color` and `edge_color` and `vertex_color` at once - [see docs](https://auctus-team.github.io/pycapacity/pycapacity.visual.html#pycapacity.visual.plot_polytope)
- Algorithms: - [see API docs](https://auctus-team.github.io/pycapacity/pycapacity.algorithms.html#pycapacity.algorithms)
- Added Chebyshev ball algorithm (`chebyshev_ball`) - [see docs](https://auctus-team.github.io/pycapacity/pycapacity.algorithms.html#pycapacity.algorithms.chebyshev_ball)
- Human metrics - [see API docs](https://auctus-team.github.io/pycapacity/pycapacity.human.html#pycapacity.human)
- Added ellipsoid: metrics acceleration, velocity and force
- New module added: `pycapacity.examples` - [see API docs](https://auctus-team.github.io/pycapacity/pycapacity.examples.html#pycapacity.examples)
- Contains 4 dof planar robot model - [see docs](https://auctus-team.github.io/pycapacity/pycapacity.examples.html#pycapacity.examples.planar_robot)
- In future it will contain more toy models, for jump starting the library usage
- More examples
- `examples` folder now contains more examples on how to use the library
- python scripts - [see scripts](https://github.com/auctus-team/pycapacity/tree/master/examples/scripts)
- jupyter notebooks - [see notebooks](https://github.com/auctus-team/pycapacity/tree/master/examples/scripts)
- benchmarking scripts - [see scripts](https://github.com/auctus-team/pycapacity/tree/master/examples/scripts/benchmarking/)
- More example in the docs - [see docs](examples/index.html)
- Journal of OpenSource software submission:
- `pycapacity` paper is submitter to the Journal of OpenSource software - [see paper](https://joss.theoj.org/papers/73f155afc0dfa7730792639ac374b348)
- Improved the docs with more information about the library
- Implemented polytope algorithms and their performance - [see docs](https://auctus-team.github.io/pycapacity/algorithms.html)
- Implemented capacity metrics - [see docs](https://auctus-team.github.io/pycapacity/README.html)


PRs
- Update human english.py by laisnegautier in https://github.com/auctus-team/pycapacity/pull/2
- Fix affiliation index for the JOSS draft paper by Kevin-Mattheus-Moerman in https://github.com/auctus-team/pycapacity/pull/3
- [JOSS Review] Fix typos by sea-bass in https://github.com/auctus-team/pycapacity/pull/8

New Contributors
- laisnegautier made their first contribution in https://github.com/auctus-team/pycapacity/pull/2
- Kevin-Mattheus-Moerman made their first contribution in https://github.com/auctus-team/pycapacity/pull/3
- sea-bass made their first contribution in https://github.com/auctus-team/pycapacity/pull/8

--Full Changelog--: https://github.com/auctus-team/pycapacity/compare/v2.0.0...v2.1

Changelog v2.0 (05-2023)
- polyope and ellipsoid algorithms now return `Polytope` and `Ellipsoid` objects (see [api docs](https://auctus-team.github.io/pycapacity/pycapacity.polytope.html))
- `Polytope` class can be used as a standalone class to find vertex, halfplane and face representation of a polytope
- Visualisation tools improved: (see [api docs](https://auctus-team.github.io/pycapacity/pycapacity.visual.html))
- new `plot_polytope` function for plotting polytopes
- functions `plot_polytope_vertex` and `plot_polytope_faces` now can receive a polyope object
- function `plot_ellipsoid` now can receive a ellipsoid object
- better management of the `matplotlib` figures and axes, now user can provide an `ax`, `plt` or `figure` to the plotting functions
- Added support for robot reachable workspace approximation using convex polytopes (see [api docs](https://auctus-team.github.io/pycapacity/pycapacity.robot.html#pycapacity.robot.reachable_space_approximation))
- Added unit testing + continuous integration
- improved docs with sphinx

**Github Changelog**: https://github.com/auctus-team/pycapacity/compare/v1.2.17...v2.0.0

**Full Changelog**: https://github.com/auctus-team/pycapacity/compare/v1.2.16...v1.2.17

- A lot of code restructuring
- Added better check for None when LP does not have a solution
- docs updated