Metadata-Version: 2.1
Name: planutils
Version: 0.2.2
Summary: General library for setting up linux-based environments for developing, running, and evaluating planners.
Home-page: https://github.com/AI-Planning/planutils
Author: 
Author-email: 
License: MIT
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: POSIX :: Linux
Requires-Python: >=3.6
Description-Content-Type: text/markdown

# planutils

General library for setting up linux-based environments for developing, running, and evaluating planners.

## Usage

This doesn't work yet, but gives a general sense of where the project may be headed.

```bash
$ planutils --install-planners ipc-2018
This will require 3Gb of storage. Proceed? [Y/n]
Fetching all of the planners from IPC-2018 for use on the command line...

$ planutils --setup-server-environment
Setting up a webserver to call the installed planners...

$ planutils --setup-development-environment
Installing common dependencies for building planners...
Installing common planning libraries...

$ planutils install-planning-domains
Installing the command-line utilities...
Installing the python library...
Fetching default benchmarks...

$ planutils --setup-evaluation configuration.json
Installing Lab...
Configuring Lab...
Ready!
Run eval.py to evaluate

$ lama domain.pddl problem.pddl
The lama planner requires the FastDownward to be installed. Install now (30Mb)? [Y/n] Y
Installing FastDownward...
Ready! Please try running the planner again.

$ lama domain.pddl problem.pddl
Parsing...
```

### Docker

The included Docker file will come with planutils pre-installed. Note that in order to
run a number of the planners (all those that are based on singularity), you will need
to run the docker with the `--privileged` option.


