Description Logics State Features for Planning Library (dlplan)

Welcome to the dlplan-library.

1. Features of the Dlplan-library

1.1. Core

TODO

We included guide.pdf in the docs folder with further information regarding the available elements with a description of their syntax and semantics.

1.2. Generator

TODO

1.3. Evaluator

TODO

1.4. Policy

TODO

2. Building the Library

2.1. Building the C++ Interface

Run the following from the project root to build the library. By default, the library compiles in Debug mode.

cmake -DCMAKE_INSTALL_PREFIX=/usr/local -S . -B build
cmake --build build -j4

To build the library in Release mode, run

cmake -DCMAKE_BUILD_TYPE=Release -DCMAKE_INSTALL_PREFIX=/usr/local/ -S . -B build
cmake --build build -j4

To install the library, run

cmake --install build

Don't forget to update environment variable CPLUS_INCLUDE_PATH and LD_LIBRARY_PATH if necessary.

2.2. Building the Pyhon Interface

At the moment we recommend building and installing the Python bindings directly into a virtual environment. You can do that by issuing pip install . from the project root, or pip install -e . if you prefer an editable install because you're working on the library code.

3. Running the Examples

The subdirectory examples/ contains a number of helpful examples that illustrate different use cases of this library. You can run the C++ examples with

./build/examples/core/simple
./build/examples/generator/generate_exhaustively

The Python bindings also come with the same examples. Run them with

python3 examples/core/simple.py
python3 examples/generator/generate_exhaustively.py

4. Running the Tests

You can run the C++ tests with:

./build/tests/dlplan_tests

The Python bindings also come with their own set of tests. Run them with

pytest api/python/

5. Modifying/Extending the library (outdated):

1. Adding new elements to core and generator component.

2. Current order and modifying the order of feature generation.

6. Profiling

In the experiments/ directory, we provide code to profile parts of the library. To run the experimental code, it is necessary to install the modified version of tarski that we provide in the respective submodule in the submodules/tarski directory.

7. Citing dlplan

We created a DOI on zenodo under this link. A bibtex entry can look like this:

@software{drexler-et-al-dlplan2022,
  author       = {Drexler, Dominik and
                  Francès, Guillem and
                  Seipp, Jendrik},
  title        = {dlplan-library},
  year         = 2022,
  publisher    = {Zenodo},
  doi          = {10.5281/zenodo.5826140},
  url          = {https://doi.org/10.5281/zenodo.5826140}
}