Geomag Baseline Calculator

Enter Geomagnetic absolute measurements to calculate baselines to be applied to raw magnetometer data.

Getting Started

Fork the project repository

1. Fork the project into your GitHub user account.

2. Sign in to GitHub.

3. Go to https://github.com/usgs/geomag-baseline-calculator.

4. Click the Fork button near the top right of the page.

5. Make sure you Add an SSH Key to GitHub for the computer you're working on into your GitHub account.

6. Clone from fork (update for your fork).
   Navigate to the HOME directory that you want to use for projects. Replace [your username] with your GitHub username.
   git clone [email protected]:[your username]/geomag-baseline-calculator.git geomag-baseline-calculator
cd geomag-baseline-calculator

7. Add upstream remote for primary (use terminal)

   git remote add upstream [email protected]:usgs/geomag-baseline-calculator.git  
   

   Check your remotes with git remote -v, it should look like this
   origin [email protected]:[your username]/geomag-baseline-calculator.git (fetch) origin [email protected]:[your username]/geomag-baseline-calculator.git (push) upstream [email protected]:usgs/geomag-baseline-calculator.git (fetch) upstream [email protected]:usgs/geomag-baseline-calculator.git (push)

Dependencies

You will need to have the following tools installed in order to run this project:

1. Node
2. Bower
3. Grunt
4. PHP
5. Ruby
6. Sass
7. Compass

Dependency install details for Windows and Mac

Secondary Dependencies

Make sure you are in your geomag-baseline-calculator project directory. Install these packages from your terminal.

1. Use Node to install bower
   npm install -g bower
bower install

2. Use Node to install grunt-cli and PHP
   npm install -g grunt-cli
npm install php

3. Use Ruby to install sass and compass
   gem install sass
gem install compass

4. Use Node to get any missing dependencies
   npm install

Begin Developing

Enter development mode: grunt
If grunt runs with no errors or warnings, and a test web page opens in your default web browser then you are ready to begin development.

---

Files:

• All javascript classes are in the "src/htdocs/js/" directory.
• All matching tests for javascript classes are in the "test/spec" directory.