Log in to the competition website with a GitHub account, and we will automatically create a private GitHub submission repo for you.
The repo will be the place where you submit codes. In the My Submission
page, you can click "My Repo" to open your GitHub submission repo page.
Clone your submission repo to your local machine. The repo contains starter codes to help you prepare your submission.
$ git clone [email protected]:your_submission_repo_address
$ cd your_submission_repo
- cmake >= 3.16
- libboost >= 1.49.0
- Python3 and pybind11 (for python interface user)
Install dependencies on Ubuntu or Debian Linux:
sudo apt-get update
sudo apt-get install build-essential libboost-all-dev python3-dev python3-pybind11
Homebrew is recomanded for installing dependencies on Mac OS.
Using compile.sh
:
./compile.sh
Using cmake:
mkdir build
cd build
cmake ../ -DCMAKE_BUILD_TYPE=Release
make -j
Running the start-kit using commands:
./lifelong --inputFile the_input_file_name -o output_file_location
for example:
./lifelong --inputFile ../example_problems/random.domain/random_20.json -o test.json
more info on help:
./lifelong --help
If you are a Windows user, the most straightforward method to utilize our start-kits is by employing the WSL (Windows Subsystem for Linux) subsystem. Follow these steps:
- Install WSL, please refer to https://learn.microsoft.com/en-us/windows/wsl/install
- Open a shell in WSL and execute the following commands to install the necessary tools (CMake, GCC, Boost, pip, Pybind11):
sudo apt-get update
sudo apt-get install cmake g++ libboost-all-dev python3-pip python3-pybind11
- Employ the commands provided above to compile the start-kit.
While it's technically possible to use our start-kit with Cygwin, Mingw, and MSVC, doing so would be more complex compared to using WSL. You would likely need to configure the environment yourself.
If your private start-kit copy repo was created before a start-kit upgrade, you could run the ./upgrade_start_kit.sh
to upgrade your start-kit to the latest version.
You can check version.txt
to know the current version of your start-kit.
The upgrade_start_kit.sh
will check which file is marked as an upgrade needed and pull those files from the start-kit.
The upgrade may overwrite some of your changes to CMakeLists.txt
and apt.txt
, you could compare the difference using git diff
and decide whether to revert some modifications on these files.
The upgrade script will not touch any participants' created file, python/pyMAPFPlanner.py
, inc/MAPFPlanner.h
and src/MAPFPlanner.cpp
. So that participants' implementations should not be influenced by the start-kit upgrade.
Please refer to the Input_Output_Format.md.
Please refer to the Prepare_Your_Planner.md.
We provide a visualisation tool written in Python: https://github.com/MAPF-Competition/MAPF_analysis.
It is able to visualise the output of the start-kit program and help participants to debug the implementations.
Please refer to the Submission_Instruction.md.