From 34ef6651b2cb412918929251c5b1b68235597fd2 Mon Sep 17 00:00:00 2001 From: Eddie McWhirter <emcwhirter@usgs.gov> Date: Mon, 29 Jun 2015 14:35:06 -0600 Subject: [PATCH] Small clean up on Readme. --- README.md | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index dd7dd6d7..1901fdc7 100644 --- a/README.md +++ b/README.md @@ -9,12 +9,15 @@ Geomag algorithms includes tools to fetch, process, and output geomag data. Install ------- -We recommend using [virtual environments][] +We recommend using [virtual environments][]. Make sure you are in your +`geomag-algorithms` project directory. 1. Install `python` (2.7.X) - On OS X, we recommend using Homebrew ( http://brew.sh/ ) + - On Windows, go to the [Windows details](readme_dependency_install.md) + first 2. Install numpy, obspy requires this be installed separately. @@ -26,8 +29,8 @@ We recommend using [virtual environments][] 4. Use geomagio - - Use the xyz main script, `xyz.py -h`. - - In python scripts, `import geomagio` or `import geomagio.iaga2002`. + - Use the main script, `geomag.py -h`. + - In python scripts, `import geomagio`. [virtual environments]: http://docs.python-guide.org/en/latest/dev/virtualenvs/ -- GitLab