Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Connor Goddard committed May 21, 2015
1 parent b5f50a3 commit 51f13e0
Showing 1 changed file with 18 additions and 23 deletions.
41 changes: 18 additions & 23 deletions README.md
@@ -1,24 +1,5 @@
# *Estimation of Terrain Shape Using a Monocular Vision-based System* (CS39440 Major Project) [![Build Status](https://travis-ci.org/cgddrd/CS39440-major-project.svg)](https://travis-ci.org/cgddrd/CS39440-major-project) [![Stories in Ready](https://badge.waffle.io/cgddrd/cs39440-major-project.png?label=ready&title=Ready)](https://waffle.io/cgddrd/cs39440-major-project) [![Coverage Status](https://coveralls.io/repos/cgddrd/CS39440-major-project/badge.svg?branch=develop)](https://coveralls.io/r/cgddrd/CS39440-major-project?branch=develop) [![Code Climate](https://codeclimate.com/github/cgddrd/CS39440-major-project/badges/gpa.svg)](https://codeclimate.com/github/cgddrd/CS39440-major-project)

## Installation

**Please note:** Instructions should be followed at a **project-level** (i.e. not at repo root). Please ```cd``` into the appropiate project folder within the `src` folder.

1. Install dependencies using **pip**.

**Please note:** Due to Cython requiring installation **prior to running** `setup.py`, this step must be followed (i.e. do not simply try to install dependencies as part of the `setup.py` installation).

pip install -r requirements.txt

2. Compile 'C' extension modules (`.pyx`) using [Cython](https://github.com/cython/cython).

python setup.py build_ext --inplace

3. Install project module.

python setup.py install


## Background

Accurate navigation allows for robot requiring autonomous motion capabilities to make safe, yet objective
Expand All @@ -30,7 +11,7 @@ mobile robot to possess in order to help to maximise its own chances of survival

Combining recent advances in camera technology with appropriate computer vision algorithms and
technique, the proposed project aims to design and implement a **vision-based software application capable
of estimating the general “shape” of the terrain currently in front of a moving robot as it follows
of estimating the **gradient conditions** of the terrain currently in front of a moving robot as it follows
a route through its environment**.

Through this system, it should be possible to identify the presence of
Expand All @@ -41,6 +22,20 @@ In addition, it is predicted that such a system will also be able to provide an
and change in rotation/orientation of the robot as it traverses along a path. These will be calculated as
by-products of the terrain inference mechanism, and could form part of a larger visual odometry system.

While the primary aims of the proposed project are research-focussed, the ultimate goal of the project
will be to implement the system onto a working mobile robot, such as the ‘IDRIS’ all-terrain wheeled
robot currently in use by the Aberystwyth University Computer Science department.
## Installation

**Please note:** Instructions should be followed at a **project-level** (i.e. not at repo root). Please ```cd``` into the appropiate project folder within the `src` folder.

1. Install dependencies using **pip**.

**Please note:** Due to Cython requiring installation **prior to running** `setup.py`, this step must be followed (i.e. do not simply try to install dependencies as part of the `setup.py` installation).

pip install -r requirements.txt

2. Compile 'C' extension modules (`.pyx`) using [Cython](https://github.com/cython/cython).

python setup.py build_ext --inplace

3. Install project module.

python setup.py install

0 comments on commit 51f13e0

Please sign in to comment.