https://github.com/aibasel/pyperplan
A lightweight STRIPS planner written in Python.
Science Score: 23.0%
This score indicates how likely this project is to be science-related based on various indicators:
-
○CITATION.cff file
-
○codemeta.json file
-
○.zenodo.json file
-
✓DOI references
Found 5 DOI reference(s) in README -
○Academic publication links
-
✓Committers with academic emails
3 of 6 committers (50.0%) from academic institutions -
○Institutional organization owner
-
○JOSS paper metadata
-
○Scientific vocabulary similarity
Low similarity (14.9%) to scientific vocabulary
Repository
A lightweight STRIPS planner written in Python.
Basic Info
- Host: GitHub
- Owner: aibasel
- License: gpl-3.0
- Language: PDDL
- Default Branch: main
- Size: 959 KB
Statistics
- Stars: 117
- Watchers: 12
- Forks: 46
- Open Issues: 4
- Releases: 6
Metadata Files
README.md
Pyperplan is a lightweight STRIPS planner written in Python.
Please note that Pyperplan deliberately prefers clean code over fast code. It is designed to be used as a teaching or prototyping tool. If you use it for paper experiments, please state clearly that Pyperplan does not offer state-of-the-art performance.
It was developed during the planning practical course at Albert-Ludwigs-Universität Freiburg during the winter term 2010/2011 and is published under the terms of the GNU General Public License 3 (GPLv3).
Pyperplan supports the following PDDL fragment: STRIPS without action costs.
Requirements
Pyperplan requires Python >= 3.7.
Installation
From the Python package index (PyPI):
pip install pyperplan
From inside a repository clone:
pip install --editable .
This makes the pyperplan command available globally or in your virtual
environment (recommended).
Usage
The pyperplan executable accepts two arguments: a PDDL domain file and a
PDDL problem file. Example:
pyperplan benchmarks/tpp/domain.pddl benchmarks/tpp/task01.pddl
The domain file can be omitted, in which case the planner will attempt to guess its name based on the problem file. If a plan is found, it is stored alongside the problem file with a .soln extension.
By default, the planner performs a blind breadth-first search, which does not scale very well. Heuristic search algorithms are available. For example, to use greedy-best-first search with the FF heuristic, run
pyperplan -H hff -s gbf DOMAIN PROBLEM
For a list of available search algorithms and heuristics, run
pyperplan --help
For more information on using the planner and how to extend it to do more fancy stuff, see the documentation.
FAQs
PDDL types
Pyperplan follows the semantics that all types other than the universal supertype object (which is mentioned as such in the PDDL 1.2 paper) need to be explicitly introduced.
Contact
Pyperplan is hosted on GitHub: https://github.com/aibasel/pyperplan
The original authors of Pyperplan are, in alphabetical order:
- Yusra Alkhazraji
- Matthias Frorath
- Markus Grützner
- Thomas Liebetraut
- Manuela Ortlieb
- Jendrik Seipp
- Tobias Springenberg
- Philip Stahl
- Jan Wülfing
The instructors of the course in which Pyperplan was created were Malte Helmert and Robert Mattmüller.
For questions and feedback, please start a new discussion.
Citing Pyperplan
Please cite Pyperplan using
@Misc{alkhazraji-et-al-zenodo2020,
author = "Yusra Alkhazraji and Matthias Frorath and Markus Gr{\"u}tzner
and Malte Helmert and Thomas Liebetraut and Robert Mattm{\"u}ller
and Manuela Ortlieb and Jendrik Seipp and Tobias Springenberg and
Philip Stahl and Jan W{\"u}lfing",
title = "Pyperplan",
publisher = "Zenodo",
year = "2020",
doi = "10.5281/zenodo.3700819",
url = "https://doi.org/10.5281/zenodo.3700819",
howpublished = "\url{https://doi.org/10.5281/zenodo.3700819}"
}
Owner
- Name: Artificial Intelligence Group - University of Basel
- Login: aibasel
- Kind: organization
- Location: Basel, Switzerland
- Website: https://ai.dmi.unibas.ch/
- Repositories: 4
- Profile: https://github.com/aibasel
GitHub Events
Total
- Issues event: 3
- Watch event: 26
- Issue comment event: 3
- Pull request event: 1
- Fork event: 7
Last Year
- Issues event: 3
- Watch event: 26
- Issue comment event: 3
- Pull request event: 1
- Fork event: 7
Committers
Last synced: over 2 years ago
Top Committers
| Name | Commits | |
|---|---|---|
| Jendrik Seipp | j****p@u****h | 82 |
| Jendrik Seipp | j****p@l****e | 17 |
| Malte Helmert | m****t@u****h | 4 |
| Robert Mattmüller | m****l@i****e | 2 |
| Blai Bonet | b****i@g****m | 1 |
| Tom Silver | t****r | 1 |
Committer Domains (Top 20 + Academic)
Issues and Pull Requests
Last synced: 11 months ago
All Time
- Total issues: 17
- Total pull requests: 10
- Average time to close issues: 4 months
- Average time to close pull requests: about 9 hours
- Total issue authors: 7
- Total pull request authors: 5
- Average comments per issue: 3.76
- Average comments per pull request: 0.7
- Merged pull requests: 6
- Bot issues: 0
- Bot pull requests: 0
Past Year
- Issues: 0
- Pull requests: 3
- Average time to close issues: N/A
- Average time to close pull requests: 10 minutes
- Issue authors: 0
- Pull request authors: 2
- Average comments per issue: 0
- Average comments per pull request: 0.0
- Merged pull requests: 1
- Bot issues: 0
- Bot pull requests: 0
Top Authors
Issue Authors
- jendrikseipp (4)
- guicho271828 (4)
- bonetblai (3)
- tomsilver (3)
- InesaDiamond (1)
- matgreco (1)
- MATTYGILO (1)
Pull Request Authors
- jendrikseipp (5)
- bonetblai (2)
- guicho271828 (2)
- DanielPlatnick (1)
- tomsilver (1)
Top Labels
Issue Labels
Pull Request Labels
Packages
- Total packages: 1
-
Total downloads:
- pypi 12,324 last-month
- Total dependent packages: 2
- Total dependent repositories: 9
- Total versions: 6
- Total maintainers: 1
pypi.org: pyperplan
A lightweight STRIPS planner written in Python.
- Homepage: https://github.com/aibasel/pyperplan
- Documentation: https://pyperplan.readthedocs.io/
- License: GPL3+
-
Latest release: 2.1
published over 4 years ago
Rankings
Maintainers (1)
Dependencies
- wheel *
- actions/checkout v2 composite
- actions/setup-python v1 composite