The Planimation API provides programmatic access to Planimation, an online PDDL problem solver and visualiser. Planimation with user interface can be accessed through here. A python library and a python-based command line utility are provided to easily access the API. They provide the same functionalities as the user interface.
Simply fork this repository and you can have access to the source code. Unfortunately, there are no pip or conda installation options available at this stage.
The planimation_api.py library provides following methods:
| Method | Description |
|---|---|
pddl_visualise(path of domain, path of problem, path of animation, output format) |
Submit 3 pddl files which corresponds to domain, problem, animation profile respectively and receive response in one of 5 supported formats (vfg, png, gif, webm, mp4). Similar to "Build visualisation from problem" on user interface |
vfg_visualise(path of vfg, output format) |
Submit a vfg file and receive response in one of 4 supported formats (png, gif, webm, mp4). Similar to "Build visualisation from solution VFG" on user interface |
An example of usage is demonstrated below:
import planimation_api as api
result = api.pddl_visualise("domain.pddl", "problem.pddl", "ap.pddl", "mp4")
print(result) # display the name of the received file or an error messageThe planimation.py command-line utility provides exactly the same functionalities as the planimation_api.py library:
submitPDDL submits 3 pddl files which corresponds to domain, problem, animation profile respectively and receive response in one of 5 supported formats (vfg, png, gif, webm, mp4)
$ planimation.py submitPDDL [path of domain] [path of problem] [path of animation profile] [output format]submitVFG submits a vfg file and receive response in one of 4 supported formats (png, gif, webm, mp4)
$ planimation.py submitVFG [path of VFG] [output format] The urls in planimation_api.py need to be changed to the actual urls in use.
https://github.com/planimation/api-tools/blob/bac3d948ffb7f0ceb6de389bf8f7dc38e57328be/planimation_api.py#L6-L8
A malicious or careless user can easily spam requests using the python library and there is no mechanism at the server to handle such situation. Until relevant mechanism is implemented, it may not be safe to publish this python library.
The first version of Planimation API is developed by Changyuan Liu, Lingfeng Qiang, Mengyi Fan, Xinzhe Li and Zhaoqi Fang under Nir Lipovetzky's guidance.