Skip to content

Getting Started

SpencerFleming edited this page May 29, 2019 · 5 revisions

LidarDataProcessing Wiki

This wiki is a guide for developers on this project, who need help understanding the workflow, or setting up their development environment.

Running and developing on a local machine

./configure --prefix=/usr
make
make check
sudo make install

gsl-config --lib
./configure --prefix=/usr
make
sudo make install
  • test that gdal installed with gdalinfo --version

  • add the library path for the linker export LD_LIBRARY_PATH=/usr/lib:$LD_LIBRARY_PATH

Planning & Coordinating with SCRUM

We try to manage stories tasks and bugs as described in CS 471, with a few changes to suit our needs.
CS 471 Github Conventions Document

Zenhub

Issues are tracked using the ZenHub extension available at https://www.zenhub.com/extension

Issue Templates

Issues should generally follow these formats; variations can be made when applicable.

Story template (Click me)

As a TypeOfUserOrRole, I need to TBDGoal so that TBDBenefit

**Acceptance Criteria:**
- [ ] Given TBDContext, when TBDTrigger, then TBDSomeResult
- [ ] Given TBDContext, when TBDTrigger, then TBDSomeResult
- [ ] Given TBDContext, when TBDTrigger, then TBDSomeResult
Bug report template (Click me)

TBDDescription

**Steps to Reproduce:**
1. TBD
2. 
3. 
4. 

**Actual Results:**
TBD

**Expected Results:**
TBD

**Other notes:**
TBD

More details on how we use SCRUM on the How We Use SCRUM page.

Testing and QA

I've made this mistake a few times: Always try compiling and running your program on R2 before you push it-- Sometimes your local machine might not run into the same errors that R2 does, and knowing there's a machine everyone can use that definitely runs the program is convenient.

Working on R2

Get access to R2 by following instructions at https://rcs.boisestate.edu/request-support/

More information is available on the R2 Guide page.

C++ Project coding guidelines

  • naming: snake_case
  • no global objects
  • reduce coupling (avoid adding new dependencies)
  • avoid Object Oriented style for this code, especially inheritance.

Testing the code

  • Think about how you can test your function
  • Refactor tests as you code
  • Red (failing) tests shouldn't be ignored