Skip to content

Commit

Permalink
Merge pull request #65 from maxspahn/ft-project-info
Browse files Browse the repository at this point in the history
ft[docs]: Updates readme and creates website link for pypi package.
  • Loading branch information
maxspahn authored Dec 6, 2023
2 parents 1e6188c + 30590f3 commit 82efa89
Show file tree
Hide file tree
Showing 3 changed files with 23 additions and 15 deletions.
32 changes: 19 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,34 +1,40 @@
# Motion Planning Scenes

Motion planning consists of finding a path from a state A to a goal state B while avoiding
obstacles.
Motion planning consists of finding a path from a state A to a goal state B
while avoiding obstacles.

There is a wide range of motion planning libraries that focus mostly on motion planning problems
formulated in the configuration space [OMPL](https://ompl.kavrakilab.org/). This approach
is usually based on inverse kinematics to transform real-world goals into suitable
configurations.
There is a wide range of motion planning libraries that focus mostly on motion
planning problems formulated in the configuration space
[OMPL](https://ompl.kavrakilab.org/). This approach is usually based on inverse
kinematics to transform real-world goals into suitable configurations.

This repository formulates a generic motion planning scene, including both moving and
static obstacles and a generic formulation of goals.
This repository formulates a generic motion planning scene, including both
moving and static obstacles and a generic formulation of goals.

## Obstacles

Obstacles can be roughly split into two categories, moving and static.
Obstacles are split into dynamic and static obstacles. Dynamic obstacles are
further split into movable and fixed obstacles. Movable obstacles can be pushed
by robots while fixed ones act as walls or static parts of the environment.

## Goals

Goals for motion planning should not depend on the robot's structure, neither should they
involve orientation that are generally hard to obtain and hardly human understandable.

## Structure (Beta)

![Structure (by mermaid)](./assets/overview.svg)

## Installation

I have decided to change the name of the package on pypi to `mpscenes` as it
seems more convenient a name. Early versions were published under the name
`motion_planning_scenes`.

```bash
pip3 install .
```
or
```bash
pip3 install mpscenes
```

## Poetry
This package is build using [poetry](https://python-poetry.org/docs/).
Expand Down
1 change: 0 additions & 1 deletion assets/overview.svg

This file was deleted.

5 changes: 4 additions & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
@@ -1,8 +1,11 @@
[tool.poetry]
name = "mpscenes"
version = "0.4.4"
version = "0.4.5"
description = "Generic motion planning scenes, including goals and obstacles."
authors = ["Max <[email protected]>"]
readme = "README.md"
homepage = "https://github.com/maxspahn/motion_planning_scenes.git"
repository = "https://github.com/maxspahn/motion_planning_scenes.git"


[tool.poetry.dependencies]
Expand Down

0 comments on commit 82efa89

Please sign in to comment.