From bd2ffbf3433dc83f7b895825bc8fbf872c8258fc Mon Sep 17 00:00:00 2001 From: Calum Chamberlain Date: Wed, 20 Apr 2016 07:37:15 +1200 Subject: [PATCH] Update Readme for Windows pass --- .gitignore | 1 + CHANGES.md | 3 +++ README.md | 20 +++++++++++--------- pytest.ini | 2 +- 4 files changed, 16 insertions(+), 10 deletions(-) diff --git a/.gitignore b/.gitignore index f0f0c01aa..dd336ad1c 100644 --- a/.gitignore +++ b/.gitignore @@ -22,3 +22,4 @@ EQcorrscan.egg-info eqcorrscan/tutorials/*.jpg pytest_runner* .coveralls.yml +.coverage diff --git a/CHANGES.md b/CHANGES.md index 84bab0e71..1d5a18a36 100644 --- a/CHANGES.md +++ b/CHANGES.md @@ -4,6 +4,9 @@ a default match-filter script to the directory. * Add archive reader helper for default script, and parameter classes and definitions for default script. +* Re-write history to make repository smaller, removed trash files that had +been added carelessly. +* Now tested on appveyor, so able to be run on Windows. ## 0.1.1 * Cope with events not always having time_errors in them in eventtoSfile; diff --git a/README.md b/README.md index c83794249..18f000082 100644 --- a/README.md +++ b/README.md @@ -9,9 +9,12 @@ [![DocumentationStatus](http://readthedocs.org/projects/eqcorrscan/badge/?version=latest)](http://eqcorrscan.readthedocs.org/en/latest/?badge=latest) # Installation -Installation has been tested on both OSX and Linux (Ubuntu), we currently do not support -Windows systems, but plan to in the future (check the appveyor status, when it passes we -might be good to go!). Installation for Linux and OS X should be as simple as: +Installation has been tested on both OSX and Linux (Ubuntu), and now +Windows systems. Currently we only support python 2.7, but plan to extend +this coverage in the near future - everything is written to work in python 3.x, +we just need to get the testing going. + +Installation for all systems should be as simple as: ```pip install EQcorrscan``` @@ -23,7 +26,7 @@ This will not try to upgrade your dependencies, which is not needed. You may wi to update your obspy version to 1.0.0 which was recently released. We have tested this and support it, nevertheless, if you find any issues then let us know. -*You will likely need sudo permissions to run this command.* +*You will likely need sudo/root permissions to run this command.* If you have any issues installing please let me know. You will need to install openCV separately using (on Linux): @@ -32,16 +35,15 @@ separately using (on Linux): Or, for Mac users, this is available on Macports or other similar package managers. -For those who want to un the GUIs (in very early development) you will need to +For Windows users, you should follow the instructions [here](http://docs.opencv.org/3.1.0/d5/de5/tutorial_py_setup_in_windows.html#gsc.tab=0), +not that you need to copy the cv2.pyd file. + +For those who want to run the GUIs (in very early development) you will need to install tk, on Windows and OSX this is usually pre-installed, on Linux you may need to run: ```apt-get install python-tk``` -You will also need **Qt** and **PyQT** > 4.4. Installation for these can be -a bit of a dog, you will need to google around - hopefully I can have better -instructions here soon. - ## Updates If you want to be kept informed about releases, bug-tracking and enhancements diff --git a/pytest.ini b/pytest.ini index 49b02e7d4..5442d1f79 100644 --- a/pytest.ini +++ b/pytest.ini @@ -1,3 +1,3 @@ [pytest] norecursedirs=eqcorrscan/doc .* -addopts = -s --cov=eqcorrscan --ignore=setup.py +addopts = --cov=eqcorrscan --ignore=setup.py