Skip to content

Commit

Permalink
Moved marimapper to UV.
Browse files Browse the repository at this point in the history
Fixed merge bug
  • Loading branch information
TheMariday committed Jan 10, 2025
1 parent 6c81a80 commit c6837f4
Show file tree
Hide file tree
Showing 3 changed files with 18 additions and 13 deletions.
22 changes: 13 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,18 +25,22 @@ Above example data folder can be found under [docs/highbeam_example/](docs/highb

## Step 0: Install

```shell
pip --version # Ensure that it is //not// python 3.12, see above
pip install pipx
pipx ensurepath
pipx install "git+https://github.com/themariday/marimapper"
```
If you're on Windows, first install UV with

If you have Python 3.12 installed, install 3.11 and add `--python /path/to/python3.11` to the above `pipx install` command
`powershell -c "irm https://astral.sh/uv/install.ps1 | iex"`

[PIPx not working](https://github.com/TheMariday/marimapper/issues/42)? You can also download this repo and run `pip install .` from inside it!
Or if you're using Linux or Mac

You can run the scripts anywhere by just typing them into a console
`curl -LsSf https://astral.sh/uv/install.sh | sh`

Once UV is installed, install marimapper with

`uv tool install marimapper --from git+https://github.com/TheMariday/marimapper`

You can run the scripts anywhere by just typing them into a console.


If you don't want to use UV, then Marimapper also supports PipX and pip

## Step 1: Test your camera

Expand Down
6 changes: 5 additions & 1 deletion docs/backends/custom.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,11 @@ Fill out the blanks and check it by running `marimapper_check_backend --backend

Once you've checked it works, you can run marimapper in the same directory with `marimapper --backend my_backend.py` and it will use your backend!

If your backend needs any external libraries for example, `requests`, add them to marimapper with `pipx inject marimapper requests`
But my backend requires a library! Like `requests`! What do?

Pip: `pip install requests`
PipX:`pipx inject marimapper requests`
UV: `uv tool install marimapper --with requests`

If you think others would find your backend useful (behave), please drop me a Github Issue,
find me on Telegram or open a pull request so we can add it into marimapper!
3 changes: 0 additions & 3 deletions marimapper/sfm_process.py
Original file line number Diff line number Diff line change
Expand Up @@ -141,9 +141,6 @@ def run(self):
for queue in self._output_info_queues:
queue.put(led_info)

for queue in self._output_queues:
queue.put(self.leds_3d)

if (print_reconstructed or needs_initial_reconstruction) and len(
self.leds_3d
) > 0:
Expand Down

0 comments on commit c6837f4

Please sign in to comment.