Skip to content

Commit

Permalink
updated readme
Browse files Browse the repository at this point in the history
  • Loading branch information
JonasFrey96 committed Nov 3, 2023
1 parent 9f67a47 commit 5c1db97
Showing 1 changed file with 23 additions and 11 deletions.
34 changes: 23 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,19 @@ Checkout out also our other works.
<img align="right" width="40" height="40" src="https://github.com/leggedrobotics/wild_visual_navigation/blob/main/assets/images/dino.png" alt="Dino">

## Setup
### Installation and Dependencies
### Dependencies

The repository is tested with:
- GPU Driver Version: `535.129.03`
- Torch: `2.1.0+cu121`
- GPUs: RTX3080 Laptop; RTX3090
- ROS: Noetic (ROS1)
- Ubuntu: 20.04.6 LTS (Focal Fossa)
- Kernel: 5.15.0-88-generic

Generally the code should also work with older version of torch.

### Installation

Clone the repository.
```shell
Expand All @@ -54,6 +66,7 @@ venv_wvn
pip3 install -e ~/git/wild_visual_navigation
```


#### Conda Installation (Not tested)
Install the conda environment. (Currently the conda environment file is not tested and most likely outdated)
```shell
Expand All @@ -70,16 +83,6 @@ pip3 install -e ./wild_visual_navigation
```


# Before running now the python ros nodes simply source correct envrionment
```shell

echo 'alias ros="source /opt/ros/noetic/setup.bash"' >> ~/.bashrc
echo 'alias catkin_ws="ros; source $HOME/catkin_ws/devel/setup.bash"' >> ~/.bashrc
source ~/.bashrc

venv_wvn; catkin_ws
```


### Configuration Overview
- The general configuration files can be found under: `wild_visual_navigation/cfg/experiment_params.py`
Expand Down Expand Up @@ -139,10 +142,19 @@ catkin build procman_ros
catkin build wild_visual_navigation_ros

# Source
echo 'alias ros="source /opt/ros/noetic/setup.bash"' >> ~/.bashrc
echo 'alias catkin_ws="ros; source $HOME/catkin_ws/devel/setup.bash"' >> ~/.bashrc
source ~/.bashrc
source /opt/ros/noetic/setup.bash
source ~/catkin_ws/devel/setup.bash
```

When using the virtual environment make sure that your shell correctly sources the virtual envrionment and then the catkin workspace.
```shell
venv_wvn; catkin_ws
... # Run the wild_visual_navigation code
```

After successfully building the ros workspace you can run the full pipeline by either using the launch file (this requires all packages to be installed into your system python installation), or by running the nodes from the conda environment as plain python scripts.
We are currently working on the instructions using a `virtualenv` which eases this process.

Expand Down

0 comments on commit 5c1db97

Please sign in to comment.