Skip to content

Commit

Permalink
feat(pip): minor README fixes
Browse files Browse the repository at this point in the history
  • Loading branch information
pmokeev committed Apr 14, 2024
1 parent 7ce7b0f commit 6b23aaf
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 5 deletions.
9 changes: 4 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,26 +1,25 @@
<img align="left" width="10%" height="10%" src="assets/logo.png">
<img src="assets/logo.png">
SOVA is a SLAM on Voxel Alignment and an open-source Python library, designed for fast
and adaptive comparison of different approaches to solving the voxel-based planar SLAM problem.

Our main goal is to provide extendable, simple and efficient interfaces for
testing various hypotheses, which include different subdivision/segmenter/backend criteria.
testing various voxel SLAM hypotheses, which include different subdivision/segmenter/backend criteria.

[![Linters](https://github.com/prime-slam/voxel-slam/actions/workflows/lint.yaml/badge.svg)](https://github.com/prime-slam/voxel-slam/actions/workflows/lint.yaml)
[![License](https://img.shields.io/badge/License-Apache_2.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)

- - -
# Installation

To use this library you need to download this repository and install necessary dependencies.
How to do this:
To use this library you need to:

1. Download and install Python 3.10 from the [official website](https://www.python.org/downloads/).
2. Install pip package:
```bash
pip install sova
```
If you want to use `MROBBackend` robust optimisations, you have to install mrob library manually:
1. Download [wheels](https://drive.google.com/file/d/1rUdbybNvHx80ykr62aceAcBIPtlntWIz/view?usp=sharing) from source
1. Download [wheels from source](https://drive.google.com/file/d/1rUdbybNvHx80ykr62aceAcBIPtlntWIz/view?usp=sharing)
2. Install mrob from wheels
```bash
python -m pip install mrob --no-index --find-links ... --force-reinstall
Expand Down
Binary file modified assets/logo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 6b23aaf

Please sign in to comment.