Skip to content

Latest commit

 

History

History
171 lines (122 loc) · 6.26 KB

README.md

File metadata and controls

171 lines (122 loc) · 6.26 KB
Raw

SHOP2

Welcome to SHOP2!

Contents

About ↟

SHOP2 -- Simple Hierarchical Ordered Planner 2 -- is a domain-independent planning system based on Hierarchical Task Network (HTN) planning. In the 2002 International Planning Competition, SHOP2 received one of the top four awards, one of the two awards for distinguished performance.

For more information, see the papers section below and the UMD SHOP site.

Git Fork ↟

Branch Organization ↟

The git fork repo maintains the following branches of SHOP2:

  • cvs/mirror - The original CVS repo hosted on Source Forge (preserved for historical and pristine comparison purposes)
  • cvs/mirror-with-updates - Updates made to the CVS mirror (mostly a README and some updates for Quicklisp)
  • svn/mirror - The mirror maintained by synching with the upstream git repo
  • svn/mirror+csv-history - The upstream SVN repo mirror combined with the original CVS VCS history
  • master - The CVS+SVN codebase+history with a top-level, Github-friendly README and changes fur using SBCL with Quicklisp

Original Sources ↟

This git fork was created from the SHOP2 SourceForce CVS repository using the following command:

$ git cvsimport -v \
    -d:pserver:anonymous@shop.cvs.sourceforge.net:/cvsroot/shop \
    -C . shop2

That covered the years 2004-2006.

Furthermore, subsequent history was incorporated from the following repo:

This README file is part of the fork and provided for users of the Github web UI more than anything else. The actual project README is located in the docs directory:

That file contains more detailed info, historical changes, etc.

Installation ↟

To install and load, QuickLisp is used. If you don't have QuickLisp installed, you can do so with the following make target:

$ make quicklisp

This will help you get QuickLisp downloaded and installed for your Lisp, if you haven't done so already. It will also set up the local QuickLisp shop2 directory for you.

If you already have QuickLisp installed, you can set up the local directory with the following:

$ make install

Usage ↟

To begin, start SBCL (e.g.), and use QuickLisp to load shop2:

* (ql:quickload "shop2")
To load "shop2":
  Load 1 ASDF system:
    shop2
; Loading "shop2"
.............................

SHOP2 version 1.3 alpha with SIFT mods (May 26, 2005)
Copyright (C) 2002  University of Maryland.
Robert Goldman's modifications Copyright (C) 2004,2005 SIFT, LLC.
This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
KIND, either express or implied.  This software is distributed under an
MPL/GPL/LGPL triple license.  For details, see the software source file.

("shop2")
*

To load an example:

* (load "examples/toy/basic-example.lisp")
Defining domain ...
Defining problem PROBLEM1 ...
---------------------------------------------------------------------------
Problem PROBLEM1 with :WHICH = :FIRST, :VERBOSE = :PLANS
Totals: Plans Mincost Maxcost Expansions Inferences  CPU time  Real time
           1     2.0     2.0          4          2     0.000      0.000
Plans:
(((!DROP BANJO) (!PICKUP KIWI)))

T
*

Papers ↟

Reporting Issues ↟

We would be particularly interested in getting bug reports (or, better yet, patches!) from people who have tried to use SHOP2 with Lisps other than Allegro and SBCL and on platforms other than Linux. We would also be interested in hearing from people who have run the regression test suite.

License

Copyright © 2002 University of Maryland.

Robert Goldman's modifications Copyright © 2004,2005 SIFT, LLC.

This software is distributed under an MPL/GPL/LGPL triple license. For details, see the software source file.

This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY KIND, either express or implied.