The fmrbenchmark repository is part of a project to develop benchmark problems for research in so-called formal methods for robotics. This effort is stimulated by competitions, and the main website is http://fmrchallenge.org
Topical README files are provided in some directories. For example,
domains/dubins_traffic/README.md
. In the documentation, $FMRBENCHMARK
represents an absolute path to your copy of the fmrbenchmark repository.
Summary of organization
-
doc/
: Documentation sources, including benchmark APIs, the User's Guide, and competition rules. -
domains/
: Problem domains, e.g.,domains/integrator_chains/
contains code for the scaling chains of integrators setting. -
tools/fmrb-pkg/
: Python package providing code for both common and domain-specific needs. -
examples/
: contains example controllers and other demonstrations. An introduction to the examples is given below. -
remote/
: scripts, configurations, etc. for running some or all of the benchmarks and supporting infrastructure remotely.
Documentation
The directory doc/
contains sources for several components of documentation.
-
doc/norm/
: Normative problem domain descriptions and competition rules. Building requires LaTeX. Releases are available at http://fmrchallenge.org/norm -
doc/api/
: API manual. Building requires Doxygen. Releases are available at http://api.fmrchallenge.org -
doc/usersguide/
: User's Guide. Building requires Sphinx. Releases are available at http://docs.fmrchallenge.org
If the appropriate tools are installed, as noted above, then go to the desired
directory and run make
.
Examples
There is a ROS meta-package for each problem domain that has name of the form
DOMDIR_examples
, where the "DOMDIR" is the name of the directory under
domains/
dedicated to that problem domain (benchmark).
License
This is free software released under the terms of [the BSD 3-Clause License] (http://opensource.org/licenses/BSD-3-Clause). There is no warranty; not even for merchantability or fitness for a particular purpose. Consult LICENSE for copying conditions.