diff --git a/docs/index.rst b/docs/index.rst index bae169f..4446e34 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -16,4 +16,5 @@ perception methods in automated driving. :maxdepth: 2 :caption: Contents: + sources/usage/quickstart sources/api/modules diff --git a/docs/sources/usage/quickstart.rst b/docs/sources/usage/quickstart.rst new file mode 100644 index 0000000..f23cdd3 --- /dev/null +++ b/docs/sources/usage/quickstart.rst @@ -0,0 +1,40 @@ +Quickstart +========== + +First clone and enter the repository: + +``git clone https://github.com/ekut-es/LidarAug && cd LidarAug`` + +Local Installation +------------------ + +To install the module locally you need to first install the dependencies. + +- `PyTorch/libtorch `__ +- `boost `__ +- `OpenMP `__ +- `cnpy `__ +- `pybind11 `__ + +Easiest way is to run: + +``python3.11 -m pip install -r requirements.txt`` + +And install `boost `__, `OpenMP `__ and `cnpy `__ by following the installation instructions of the respective project. + +After installing all the necessary dependencies run ``make install``. + +**Optional:** You can test the installation by running ``make testpy``. + +Docker +------ + +Alternatively you can use `Docker `__. + +To build the Docker image simply run ``make docker``. + +This will create a Docker image with the module and all the necessary dependencies. + +You can run it using ``docker run -it lidar_aug:latest bash`` + +**NOTE:** For those using ARM run ``make docker-arm`` instead to build the docker image.