https://github.com/leggedrobotics/lunar_planner
https://github.com/leggedrobotics/lunar_planner
Last synced: about 1 year ago
JSON representation
- Host: GitHub
- URL: https://github.com/leggedrobotics/lunar_planner
- Owner: leggedrobotics
- License: mit
- Created: 2024-05-23T15:15:36.000Z (about 2 years ago)
- Default Branch: master
- Last Pushed: 2024-10-17T11:52:33.000Z (over 1 year ago)
- Last Synced: 2025-04-06T20:46:35.072Z (about 1 year ago)
- Language: Python
- Size: 23.7 MB
- Stars: 25
- Watchers: 2
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Lunar Planner
The Lunar Planner is a tool developed for planetary researchers to simplify mission planning for lunar exploration. This repository includes:
* A path planning tool to create paths for a quadruped robot on the lunar surface
* A path analysis tool to analyze paths and extract interesting statistics
This repo comes with examples for a quadruped robot and three different map locations (Aristarchus Irregular Mare Patch, Aristarchus Central Peak and Herodotus Mons).
**Main Contact:** Julia Richter ([jurichter@ethz.ch](mailto:jurichter@ethz.ch?subject=[GitHub:LunarPlanner]))
**Link to Paper:** [Link](https://arxiv.org/abs/2406.16376)
**Documentation:** [Wiki](https://github.com/leggedrobotics/lunar_planner/wiki)
## Getting Started
The planner is easily compatible with Linux, MacOS and Windows. However, for Windows the binaries of GDAL need to be installed (The installation will give errors, but Chat GPT can help with this).
### Installation
#### Normal Installation
To install the Lunar Planner with full functionality, follow these steps:
* Cloning the repository: `git clone https://github.com/leggedrobotics/lunar_planner.git`
* Navigating to the repository: `cd lunar_planner`
* Creating a virtual environment: `python3.8 -m venv env`
* Activating the virtual environment: `source env/bin/activate` (Linux, MacOS) or `env/Scripts/Activate` (Windows)
* Installing dependencies: `pip install -r requirements.txt`
* Installing the Lunar Planner package: `pip3 install -e .`
#### Executables (Ubuntu, Windows)
In order to easily try this tool, you can directly download the executables with these steps:
* Cloning the repository: `git clone https://github.com/leggedrobotics/lunar_planner.git`
* Navigating to the repository: `cd lunar_planner`
* Switching to branch with executables: `git checkout executables/ubuntu` or `git checkout executables/windows`
* Download the executables from Git Large File Storage: `pip install git-lfs && git lfs pull`
* You will now find two files `PathCreator` and `PathAnalysis` in the main directory, which you can run by clicking on them.
### Usage
#### Entering and Leaving the Virtual Environment
* Activate with `source env/bin/activate`
* Deactivate with `deactivate`
#### Run GUI
* To create a database, run: `python src/user_interface/path_creator.py`
* To analyze paths, run: `python src/user_interface/path_analysis.py`
* To create paths manually, run: `python src/user_interface/path_planning_widget.py`
## Wiki
For more detailed information, please refer to our [wiki](https://github.com/leggedrobotics/lunar_planner/wiki), which includes:
* [Downloading Map Data](https://github.com/leggedrobotics/lunar_planner/wiki/Downloading-Map-Data)
* [Scripts for Map Preprocessing (Optional)](https://github.com/leggedrobotics/lunar_planner/wiki/Scripts-for-Map-Preprocessing-(Optional))
* [Adding Further Maps and Robot Files](https://github.com/leggedrobotics/lunar_planner/wiki/Adding-Further-Maps-and-Robot-Files)
## Citation
If you find this work useful or use it for your research, please consider citing the corresponding work:
```
@inproceedings{richter2024multi,
title={Multi-Objective Global Path Planning for Lunar Exploration With a Quadruped Robot},
author={Richter, Julia and Kolvenbach, Hendrik and Valsecchi, Giorgio and Hutter, Marco},
booktitle={Proceedings of the 2024 iSpaRo Conference},
year={2024},
organization={IEEE}
}
```