Skip to content

Commit

Permalink
Fix some typos
Browse files Browse the repository at this point in the history
  • Loading branch information
nachovizzo committed Mar 29, 2021
1 parent b9784ee commit a890812
Show file tree
Hide file tree
Showing 3 changed files with 20 additions and 19 deletions.
10 changes: 5 additions & 5 deletions INSTALL.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,12 +33,12 @@ bash 3rdparty/Open3D.sh
```

That should give you the power of `Open3D` with the Generalized ICP algorithm
implementation. If you can't install `Open3D` please reffer to the [original
implementation. If you can't install `Open3D` please refer to the [original
documentation](http://www.open3d.org/docs/release/compilation.html)

### Embree

Just run the installation script provied by the author of `trimesh`:
Just run the installation script provided by the author of `trimesh`:

```sh
bash 3rdparty/embree.sh
Expand All @@ -48,7 +48,7 @@ That should give you the pyembree library

### puma

There are different ways of intalling this package, probably the most easy is to
There are different ways of installing this package, probably the easiest is to
clone this source and just run

```shell
Expand All @@ -58,13 +58,13 @@ pip install --user .

## Testing Installation

Just `cd` out of the source dir and run a interactive python shell:
Just `cd` out of the source dir and run an interactive python shell:

```python
import puma
```

If that doesn't fail then you can assume you've installed puma succesfully.
If that doesn't fail then you can assume you've installed puma successfully.

<!-- References -->

Expand Down
13 changes: 7 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ The main application of our research is intended for autonomous driving vehicles

## Running the code

**NOTE:** All the commands assume you are working on this shared worksspace,
**NOTE:** All the commands assume you are working on this shared workspace,
therefore, first `cd apps/` before running anything.

### 0) Requirements
Expand All @@ -48,7 +48,7 @@ to visit the [Installation Instructions](./INSTALL.md)

### 1) Datasets

First you need to indicate where are all your datasets, for doing so just:
First, you need to indicate where are all your datasets, for doing so just:

```sh
export DATASETS=<full-path-to-datasets-location>
Expand All @@ -58,8 +58,8 @@ This env variable is shared between the docker container and your host
system(in a read-only fashion).

So far we've only tested our approach on the [KITTI Odometry
benchmark][kitti] dataset and on the [Mai city dataset][mai-city]. Both
datasets are using a 64-beam velodyne like LiDAR.
benchmark][kitti] dataset and the [Mai city dataset][mai-city]. Both
datasets are using a 64-beam Velodyne like LiDAR.

### 2) Converting from `.bin` to `.ply`

Expand All @@ -76,12 +76,13 @@ docker-compose run --rm apps bash -c '\
--sequence 07
'
```

Please change the `--dataset` option to point to where you have the KITTI
dataset.

### 3) Runing the `puma` pipeline

Go grab a coffe/mate, this will take some time...
Go grab a coffee/mate, this will take some time...

```sh
docker-compose run --rm apps bash -c '\
Expand Down Expand Up @@ -109,7 +110,7 @@ You can open the `.ply` with [Open3D][open3d], [Meshlab][meshlab],
## Where to go next

If you already installed [puma](./INSTALL.md) then it's time to look for the
[standalone apps](./apps/). Theese apps are basically executable command line
[standalone apps](./apps/). These apps are executable command line
interfaces (CLI) to interact with the core puma code:

```sh
Expand Down
16 changes: 8 additions & 8 deletions docker/README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
# Docker containers

The easiest way to try out our code without pulling all the depdendencies is
by running our docker container. For that you need to install `docker` and
The easiest way to try out our code without pulling all the dependencies is
by running our docker container. For that, you need to install `docker` and
`docker-compose`.

## `builder` container

To actually build this container, in case you need to modify the base image or
To build this container, in case you need to modify the base image or
because you don't have access to the registry provided, just run this command
from the `puma` root directory:

Expand All @@ -15,7 +15,7 @@ docker-compose up --build builder
```

That will build the base image and tag it with the same tag that the `apps`
container is using it. Ideally you should never do this unless you need to
container is using it. Ideally, you should never do this unless you need to
change something from the dependencies.

If you plan to update the registry, you can do so by just running:
Expand All @@ -26,17 +26,17 @@ docker-compose push builder

## `apps` container

This container needs to be built locally since it will use information of your
This container needs to be built locally since it will use the information of your
current user. This looks tricky and complicated but it's the easiest way to
share data between the container and the host-machine without needing to run
unnecessary long commands.

Additionally an env variable called `$DATASETS` is also shared with the docker
Additionally, an env variable called `$DATASETS` is also shared with the docker
container in case you have your data already somewhere else and you don't want
to duplicate it on the [data](../apps/data) directory.

Your user information is encoded in the [.env](../.env) file. If your user id
and group id are not `1000` (defaults in debian-based sytem) then you need to
Your user information is encoded in the [.env](../.env) file. If your user-id
and group id are not `1000` (defaults in debian-based system) then you need to
change this file.

Using this container is trivial, plus it also comes packaged with nice tools
Expand Down

0 comments on commit a890812

Please sign in to comment.