|
Size: 1397
Comment:
|
Size: 3198
Comment: fix typo
|
| Deletions are marked like this. | Additions are marked like this. |
| Line 5: | Line 5: |
| We support multiple ways of running Fast Downward. The instructions below assume that your PDDL files reside in the directory `$BENCHMARKS`. | Starting with Fast Downward 19.06, we release the planner in four flavours: tarball, Singularity, Docker and Vagrant. We provide below a few instructions to get you started as quickly as possible, but you can find a more detailed description on [[ObtainingAndRunningFastDownward]] and [[PlannerUsage]]. |
| Line 7: | Line 8: |
| == Docker == | == What flavour is for me? == |
| Line 9: | Line 10: |
| Install [[https://docs.docker.com/install/|Docker]] and run | * '''running experiments''': We recommend Singularity or the tarball. Docker is an alternative, but be mindful of its significant overhead. * '''teaching:''' We recommend Vagrant. * '''development:''' We recommend working on a clone of the master repository. See WhatFlavourIsForMe for a more detailed discussion. == Running the Singularity image == Let us assume that you have [[https://www.sylabs.io/guides/3.2/user-guide/quick_start.html#quick-installation-steps|Singularity]] installed on your machine (we have tested this with Singularity 2.6 and 3.2), and want to solve a planning problem located in the `$BENCHMARKS` directory. You can run the same LAMA configuration as before: {{{#!highlight bash singularity pull --name downward.simg shub://aibasel/downward singularity run downward.simg --alias lama-first $BENCHMARKS/gripper/prob01.pddl }}} The first command downloads the Singularity image into the local file `downward.simg`, while the second command is the one running Fast Downward from this image. Unlike Docker, `$BENCHMARKS` does not have to be an absolute path. == Running the Docker image == Let us assume that you have [[https://docs.docker.com/install/|Docker]] installed on your machine and want to solve a planning problem located on the `$BENCHMARKS` directory. You can run the ''satisficing'' LAMA configuration of the planner: |
| Line 15: | Line 37: |
| This makes the local directory `$BENCHMARKS` available in the container under `/benchmarks`. Note that the `$BENCHMARKS` path needs to be absolute. | Note that this mounts the local directory `$BENCHMARKS` of your host machine under the container directory `/benchmarks`, which is the place where the containerized planner reads the problems from. The path stored in the `$BENCHMARKS` variable needs to be absolute. |
| Line 17: | Line 41: |
| == Singularity == | |
| Line 19: | Line 42: |
| Install [[https://www.sylabs.io/guides/2.6/user-guide/quick_start.html#quick-installation-steps|Singularity 2.x]] (we have not tested versions 3.x) and run | == Using a Vagrant machine == |
| Line 21: | Line 44: |
| {{{#!highlight bash singularity run shub://aibasel/downward --alias lama-first $BENCHMARKS/gripper/prob01.pddl }}} |
Assuming that you have [[https://www.vagrantup.com/|Vagrant]] installed on your machine, you can use the Fast Downward Vagrantfile as follows: |
| Line 25: | Line 46: |
| == Vagrant == | * Place the Vagrantfile for the desired [[Releases|release]] into some empty directory. * Put your PDDL files into the same directory as the Vagrantfile, say, under names `domain.pddl` and `problem.pddl`. * Navigate to this directory and type `vagrant up`. * Log into the Vagrant virtual machine by typing `vagrant ssh`. * Run `downward/fast-downward.py --alias lama-first /vagrant/domain.pddl /vagrant/problem.pddl`. * Type `exit` to leave the virtual machine, then `vagrant halt` to stop it. |
| Line 27: | Line 53: |
| * Install [[https://www.vagrantup.com/|Vagrant]]. * Download the Vagrantfile for the latest [[Releases|release]] and put it into some empty directory. * Put your PDDL files into the same directory. * Navigate to this directory in a terminal and type `vagrant up`. * Log into the Vagrant virtual machine by typing `vagrant ssh`. * Navigate to the `/home/vagrant/downward/` directory. * Run `./fast-downward.py --alias lama-first path/to/your/pddl/file`. * To shutdown the machine type `vagrant halt`. |
== Source code == See ObtainingAndRunningFastDownward for a complete description on how to build the planner from source. = Next steps = * See other ways of invoking the planner on [[PlannerUsage]]. * Read about recommended [[ScriptUsage|experiment setups]]. * Go through the full [[../|Documentation]]. |
Back to the HomePage.
Quick start
Starting with Fast Downward 19.06, we release the planner in four flavours: tarball, Singularity, Docker and Vagrant. We provide below a few instructions to get you started as quickly as possible, but you can find a more detailed description on ObtainingAndRunningFastDownward and PlannerUsage.
What flavour is for me?
running experiments: We recommend Singularity or the tarball. Docker is an alternative, but be mindful of its significant overhead.
teaching: We recommend Vagrant.
development: We recommend working on a clone of the master repository.
See WhatFlavourIsForMe for a more detailed discussion.
Running the Singularity image
Let us assume that you have Singularity installed on your machine (we have tested this with Singularity 2.6 and 3.2), and want to solve a planning problem located in the $BENCHMARKS directory. You can run the same LAMA configuration as before:
The first command downloads the Singularity image into the local file downward.simg, while the second command is the one running Fast Downward from this image. Unlike Docker, $BENCHMARKS does not have to be an absolute path.
Running the Docker image
Let us assume that you have Docker installed on your machine and want to solve a planning problem located on the $BENCHMARKS directory. You can run the satisficing LAMA configuration of the planner:
1 docker run --rm -v $BENCHMARKS:/benchmarks aibasel/downward --alias lama-first /benchmarks/gripper/prob01.pddl
Note that this mounts the local directory $BENCHMARKS of your host machine under the container directory /benchmarks, which is the place where the containerized planner reads the problems from. The path stored in the $BENCHMARKS variable needs to be absolute.
Using a Vagrant machine
Assuming that you have Vagrant installed on your machine, you can use the Fast Downward Vagrantfile as follows:
Place the Vagrantfile for the desired release into some empty directory.
Put your PDDL files into the same directory as the Vagrantfile, say, under names domain.pddl and problem.pddl.
Navigate to this directory and type vagrant up.
Log into the Vagrant virtual machine by typing vagrant ssh.
Run downward/fast-downward.py --alias lama-first /vagrant/domain.pddl /vagrant/problem.pddl.
Type exit to leave the virtual machine, then vagrant halt to stop it.
Source code
See ObtainingAndRunningFastDownward for a complete description on how to build the planner from source.
Next steps
See other ways of invoking the planner on PlannerUsage.
Read about recommended experiment setups.
Go through the full Documentation.