Skip to content
Snippets Groups Projects
Commit dab15c8a authored by Eddie McWhirter's avatar Eddie McWhirter
Browse files

Separate development dependencies from others.

parent b825761a
No related branches found
No related tags found
No related merge requests found
......@@ -3,19 +3,14 @@ Geomag Algorithms
Geomag algorithms includes tools to fetch, process, and output geomag data.
[Documentation](./docs/README.md)
Install
[First Time Install](readme_dependency_install.md)
-------
We recommend using [virtual environments][].
__Windows__: begin with the Windows dependencies in the
[Dependency install](readme_dependency_install.md#windows).
[Development Dependencies](readme_develop_install.md)
-------
__Mac/Linux__: begin with required dependencies in the
[Dependency install](readme_dependency_install.md#mac).
Usage
-------
1. Install geomagio
......@@ -26,28 +21,13 @@ __Mac/Linux__: begin with required dependencies in the
- Use the main script, `geomag.py -h`.
- In python scripts, `import geomagio`.
[virtual environments]: http://docs.python-guide.org/en/latest/dev/virtualenvs/
Developing
----------
1. Use npm to install `grunt-cli`
npm install -g grunt-cli
2. Install `numpy`, `scipy`, `obspy`, and `flake8`
3. Clone this project (or fork and clone your fork)
git clone https://github.com/usgs/geomag-algorithms.git
4. From root directory of project, install npm dependencies
npm install
5. Run grunt to run unit tests, and watch for changes to python files
Supported Algorithms
-------
[XYZ Algorithm](./XYZ.md)
------
grunt
[Documentation](./docs/README.md)
-------
Coding Standards
......@@ -63,4 +43,3 @@ This project adheres to PEP8 standards in most cases:
- line continuations should use two indentations (8 spaces).
- do not use visual indents.
[Dependency install details for Windows and Mac](readme_dependency_install.md)
Readme dependencies
Readme install dependencies
## Install ##
We recommend using [virtual environments][].
[virtual environments]: http://docs.python-guide.org/en/latest/dev/virtualenvs/
### Windows ###
#### Install ####
1. You will need a terminal tool for Windows. We used [Git Bash][] to test these
steps, but [Cygwin][] or another unix-like editor should work fine too.
......@@ -22,25 +27,8 @@ Readme dependencies
1. Head back over to the main [install](README.md#install) and complete the
instructions there.
#### Develop ####
These instructions only need to be completed if you plan on developing new
code for this project.
1. Install the newest release of [Node][] for Windows, using the Windows
Installer (.msi).
- Use all of the defaults.
1. Close and re-open your terminal so that your new PATH is loaded.
Make sure to navigate back to your `geomag-algorithms` project directory.
1. Install `obspy` from the terminal.
easy_install obspy
[Git Bash]: http://git-scm.com/download/win
[Cygwin]: http://cygwin.com/install.html
[Node]: http://nodejs.org/download/
[Anaconda]: http://continuum.io/downloads
---
......@@ -79,23 +67,3 @@ code for this project.
instructions there.
[Homebrew]: http://brew.sh/
---
### Add an SSH Key to GitHub ###
This only needs to be completed if you plan on developing and pushing new code
to this project.
1. `ssh-keygen -t rsa -b 2048` (in terminal)
2. Press **Enter** to accept the default save location.
3. Enter a passphrase that you will remember.
4. `cat ~/.ssh/id_rsa.pub`
Copy the text block that is displayed.
This is your SSH key.
If you're on Window and can't copy the text from the terminal, go
to `C:\Users\[your username here]\.ssh` and open the `id_rsa.pub` file
with notepad.
5. In GitHub, click **Edit Your Profile**.
6. Select **SSH Keys** on the left.
7. Click **Add SSH key**. Give it a meaningful title.
8. Copy your SSH Key into the Key, and click **Add key**.
Readme development dependencies
## Develop ##
These instructions only need to be completed if you plan on developing new
code for this project.
If developing on windows, see the [Windows](#windows) section below.
Developing
----------
1. Use npm to install `grunt-cli`
npm install -g grunt-cli
2. Install `numpy`, `scipy`, `obspy`, and `flake8`
3. Clone this project (or fork and clone your fork)
git clone https://github.com/usgs/geomag-algorithms.git
4. From root directory of project, install npm dependencies
npm install
5. Run grunt to run unit tests, and watch for changes to python files
grunt
---
### Windows ###
1. Install the newest release of [Node][] for Windows, using the Windows
Installer (.msi).
- Use all of the defaults.
1. Close and re-open your terminal so that your new PATH is loaded.
Make sure to navigate back to your `geomag-algorithms` project directory.
1. Install `obspy` from the terminal.
easy_install obspy
[Node]: http://nodejs.org/download/
---
### Add an SSH Key to GitHub ###
1. `ssh-keygen -t rsa -b 2048` (in terminal)
2. Press **Enter** to accept the default save location.
3. Enter a passphrase that you will remember.
4. `cat ~/.ssh/id_rsa.pub`
Copy the text block that is displayed.
This is your SSH key.
If you're on Window and can't copy the text from the terminal, go
to `C:\Users\[your username here]\.ssh` and open the `id_rsa.pub` file
with notepad.
5. In GitHub, click **Edit Your Profile**.
6. Select **SSH Keys** on the left.
7. Click **Add SSH key**. Give it a meaningful title.
8. Copy your SSH Key into the Key, and click **Add key**.
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment