Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Removed b5 from project #314

Merged
merged 1 commit into from
Oct 8, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 1 addition & 15 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,26 +23,12 @@ As the project is still in early development, these requirements are subject to

## Installation

To run the project you have to install [b5](https://github.com/team23/b5)
and [docker](https://docs.docker.com/engine/install/) with NVIDIA GPU support,
To run the project you have to install [docker](https://docs.docker.com/engine/install/) with NVIDIA GPU support,
[nvidia-docker](https://docs.nvidia.com/datacenter/cloud-native/container-toolkit/install-guide.html#docker).
`b5` is used to simplify some of the docker commands and to provide a more user-friendly interface.
`docker` and `nvidia-docker` are used to run the project in a containerized environment with GPU support.

Afterwards, you can set up and execute the project with the following two commands:

```bash
# Setup project
b5 install

# Run project
b5 run
```

More detailed instructions about setup and execution can be found [here](./doc/01_general/Readme.md).

More available b5 commands are documented [here](./doc/01_general/03_commands.md).

## Development

If you contribute to this project please read the guidelines first. They can be found [here](./doc/02_development/Readme.md).
Expand Down
76 changes: 0 additions & 76 deletions build/Taskfile

This file was deleted.

4 changes: 0 additions & 4 deletions build/config.yml

This file was deleted.

12 changes: 0 additions & 12 deletions build/hooks/pre-commit.d/10-flake8.sh

This file was deleted.

12 changes: 0 additions & 12 deletions build/hooks/pre-commit.d/20-markdown.sh

This file was deleted.

114 changes: 0 additions & 114 deletions build/tasks/ros.sh

This file was deleted.

46 changes: 3 additions & 43 deletions doc/01_general/02_installation.md
Original file line number Diff line number Diff line change
@@ -1,38 +1,12 @@
# 🛠️ Installation

To run the project you have to install [b5](https://github.com/team23/b5) and [docker](https://docs.docker.com/engine/install/) with NVIDIA GPU support, [nvidia-docker](https://docs.nvidia.com/datacenter/cloud-native/container-toolkit/install-guide.html#docker).
To run the project you have to install [docker](https://docs.docker.com/engine/install/) with NVIDIA GPU support, [nvidia-docker](https://docs.nvidia.com/datacenter/cloud-native/container-toolkit/install-guide.html#docker).

For development, we further recommend PyCharm Professional. More information about its installation can be found in [PyCharm Setup](../02_development/06_pycharm_setup.md)
For development, we recommend Visual Studio Code with the plugins that are recommended inside the `.vscode` folder.

## Installation

If not yet installed first install b5 and docker as described in section [b5 installation](#b5-installation) and [Docker with NVIDIA GPU support](#docker-with-nvidia-gpu-support).

After that setting up the project and executing it is as easy as that:

```shell
# Setup project
b5 install

# Run project
b5 run
```

## b5 installation

Make sure you have installed python and pip. If not yet installed, you can do by the following (Ubuntu):

```shell
# Install python3
sudo apt install python3
```

Afterwards just install b5 by running:

```shell
# Install b5
pip install b5
```
If not yet installed first install docker as described in section [Docker with NVIDIA GPU support](#docker-with-nvidia-gpu-support).

## Docker with NVIDIA GPU support

Expand Down Expand Up @@ -90,20 +64,6 @@ sudo systemctl restart docker

## 🚨 Common Problems

### `b5: command not found`

---

1. If you already installed b5 (`pip install b5`) try to log out and log back in.

2. If that doesn't help add this line to your `~/.bash_profile` or `~/.bashrc`:

```shell
export PATH=$PATH:$HOME/.local/bin
```

([possible reason](https://stackoverflow.com/a/73256004))

### Vulkan device not available

Cannot find a compatible Vulkan Device.
Expand Down
Loading
Loading