These instructions only need to be completed if you plan on developing new code for this project.
If developing on windows, see the Windows section below.
-
Use npm to install
grunt-cli
npm install -g grunt-cli
-
Install
numpy
,scipy
,obspy
, andflake8
if they aren't already installed. -
Clone this project (or fork and clone your fork)
git clone https://github.com/usgs/geomag-algorithms.git
-
From root directory of project, install npm dependencies
npm install
-
Run grunt to run unit tests, and watch for changes to python files
grunt
-
Install the newest release of Node (http://nodejs.org/download/) for Windows, using the Windows Installer (.msi).
-
Close and re-open your terminal so that your new PATH is loaded.
This project adheres to PEP8 standards in most cases: https://www.python.org/dev/peps/pep-0008
-
Hanging/Visual indents (E126, E127, E128, E131)
- line continuations should use two indentations (8 spaces).
- do not use visual indents.