From b697d43ea72ba6def0a776887988c845eaba43e4 Mon Sep 17 00:00:00 2001
From: Eddie McWhirter <emcwhirter@usgs.gov>
Date: Wed, 4 Mar 2015 15:25:34 -0700
Subject: [PATCH] Add Windows specifics and some other details to Readme.
---
README.md | 24 ++++++------
readme_dependency_install.md | 74 ++++++++++++++++++++++++++++++++++++
2 files changed, 85 insertions(+), 13 deletions(-)
create mode 100644 readme_dependency_install.md
diff --git a/README.md b/README.md
index ee699224..9d60c364 100644
--- a/README.md
+++ b/README.md
@@ -7,7 +7,7 @@ Geomag algorithms includes tools to fetch, process, and output geomag data.
Install
-------
-We recommend using virtual environments ( http://docs.python-guide.org/en/latest/dev/virtualenvs/ )
+We recommend using [virtual environments][]
1. Install `python` (2.7.X)
@@ -27,31 +27,27 @@ We recommend using virtual environments ( http://docs.python-guide.org/en/latest
- Use the xyz main script, `xyz.py -h`.
- In python scripts, `import geomagio` or `import geomagio.iaga2002`.
+[virtual environments]: http://docs.python-guide.org/en/latest/dev/virtualenvs/
+
Developing
----------
-1. Install `node` and `python` (2.7.X)
-
- - On OS X, we recommend using Homebrew ( http://brew.sh/ )
-
-2. Use npm to install `grunt-cli`
+1. Use npm to install `grunt-cli`
`npm install -g grunt-cli`
-3. Use pip to install `numpy`, `scipy`, `obspy`, and `flake8`
-
- `pip install numpy scipy obspy flake8`
+2. Install `numpy`, `scipy`, `obspy`, and `flake8`
-4. Clone this project (or fork and clone your fork)
+3. Clone this project (or fork and clone your fork)
- `git checkout https://github.com/usgs/geomag-algorithms.git`
+ `git clone https://github.com/usgs/geomag-algorithms.git`
-5. From root directory of project, install npm dependencies
+4. From root directory of project, install npm dependencies
`npm install`
-6. Run grunt to run unit tests, and watch for changes to python files
+5. Run grunt to run unit tests, and watch for changes to python files
`grunt`
@@ -68,3 +64,5 @@ 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)
diff --git a/readme_dependency_install.md b/readme_dependency_install.md
new file mode 100644
index 00000000..9b4247f4
--- /dev/null
+++ b/readme_dependency_install.md
@@ -0,0 +1,74 @@
+Readme dependencies
+
+### 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**.
+
+---
+### Windows ###
+
+1. You will need a terminal tool for Windows. I used [Git Bash][] to test these
+ steps, but [Cygwin][] or another unix-like editor should work fine too.
+ - PATH environment. I recommend the __last option__ here to include Unix
+ tools, but if you don't understand what that entails then use the
+ _second option_ which still adds Git to your system PATH then click
+ **Next**.
+ - Besides that, keep all of the defaults.
+
+1. Install the newest release of [Node][] for Windows, using the Windows
+ Installer (.msi).
+ - Use all of the defaults.
+
+1. Install [Anaconda][], which includes `numpy`, `scipy` and `flake8`.
+ - We recommend using "Just Me" for the install to avoid potential admin
+ issues.
+
+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.
+ `easy_install obspy`
+
+1. Run 'python' to verify that Anaconda's version of Python is being used.
+ If it isn't, update your PATH so that Conda's HOME is before any other
+ versions of Python.
+
+
+[Git Bash]: http://git-scm.com/download/win
+[Cygwin]: http://cygwin.com/install.html
+[Node]: http://nodejs.org/download/
+[Anaconda]: http://continuum.io/downloads
+
+---
+### Mac ###
+
+1. Install `node`, `git` and `python` (2.7.X)
+ - On OS X, we recommend using [Homebrew][]
+ ```brew install node```
+ ```brew install git```
+
+1. Use pip to install `numpy`, `scipy`, `obspy`, and `flake8`
+ `pip install numpy scipy obspy flake8`
+
+1. Update paths as needed in your `~/.bash_profile`:
+ ```# brew installed binaries```
+ ```export PATH=$PATH:/usr/local/bin```
+ ```# npm installed binaries```
+ ```export PATH=$PATH:/usr/local/share/npm/bin```
+ ```# gem installed binaries```
+ ```export PATH=$PATH:/usr/local/opt/ruby/bin```
+
+1. Close and re-open your terminal so that your new PATH is loaded.
+ Make sure to navigate back to your `geomag-baseline-calculator` project directory.
+
+[Homebrew]: http://brew.sh/
--
GitLab