diff --git a/README.md b/README.md index 8015148b45e10437652fb69944a8976587250547..286eb5c172d5f27f1bbae9d92c2cb1117cc335b8 100644 --- a/README.md +++ b/README.md @@ -1,22 +1,24 @@ +[](https://git.ligo.org/gwinc/pygwinc/commits/master) + # Python port of GW Interferometer Noise Calculator - + ## tests -To compare pygwinc vs. MATLAB gwinc, run the included test command -(requires a local installation of MATLAB and it's python interface): +To compare pygwinc vs. matlab gwinc, run the included test command +(requires a local installation of matlab and its python interface): -* checkout, or create a link existing checkout of, matlab gwinc in +* checkout, or link an existing checkout of, matlab gwinc in the test directory: - $ cd pygwin/gwinc/test + $ cd pygwinc/gwinc/test $ ln -s ~/ligo/src/iscmodeling/gwinc -* Execute the test command (specifying path to MATLAB python +* Execute the test command (specifying path to matlab python interface if needed): $ PYTHONPATH=/opt/matlab/python/lib/python2.7/site-packages python -m gwinc.test -This will produce difference plots of noises calculated from MATLAB +This will produce difference plots of noises calculated from matlab gwinc and pygwinc.