Skip to content

Commit

Permalink
final commit before release
Browse files Browse the repository at this point in the history
  • Loading branch information
ThomasLecocq committed Mar 20, 2015
1 parent 9fb0d04 commit 55b09e4
Show file tree
Hide file tree
Showing 5 changed files with 40 additions and 13 deletions.
Binary file modified doc/.static/msnoise.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
6 changes: 3 additions & 3 deletions doc/installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@ Quick Start - Windows

.. code-block:: sh
conda traitsui traits
conda install traitsui traits
easy_install obspy click
3. Download and install scikits.samplerate and mysql-python from here: http://www.lfd.uci.edu/~gohlke/pythonlibs/#scikits.samplerate and http://www.lfd.uci.edu/~gohlke/pythonlibs/#mysql-python
Expand All @@ -84,7 +84,7 @@ Quick Start - Windows

.. code-block:: sh
easy_install msnoise
pip install msnoise
8. Check which required packages you are still missing by executing the ``msnoise bugreport`` command. (See :ref:`testing`)

Expand Down Expand Up @@ -136,7 +136,7 @@ Quick Start - Linux

.. code-block:: sh
easy_install msnoise
pip install msnoise
7. Check which required packages you are still missing by executing the ``msnoise bugreport`` command. (See :ref:`testing`)

Expand Down
18 changes: 18 additions & 0 deletions doc/plotting.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,24 @@ Plotting
========
MSNoise comes with some default plotting tools.

All plotting commands accept the ``--outfile`` argument. If provided, the
figure will be saved to the disk. Names can be explicit, or tell the code to
generate the filename automatically (using the `?` question mark), for example:

.. code-block:: sh
# automatic naming, save to PNG
msnoise plot dvv -o ?.png
# automatic naming, save to PDF
msnoise plot dvv -o ?.pdf
# explicit naming, save to JPG
msnoise plot dvv -o mydvv.jpg
.. contents::
:local:


Data Availability Plot
----------------------
Expand Down
25 changes: 17 additions & 8 deletions doc/releasenotes/msnoise-1.3.rst
Original file line number Diff line number Diff line change
Expand Up @@ -28,19 +28,18 @@ workflow. The workflow in itself doesn't change, so experienced users as well as
new users reading the SRL publication will find their way easily!

**MSNoise is now a Python Package**, allowing a single (and easy) install for
all your projects and/or all users. The new top-level ``msnoise`` command
contains all the steps of the workflow, plus new additions, as the very useful
``reset`` command to easily mark all jobs "T"odo. The ``msnoise plot`` command
group which includes seven plots, all directly callable from the command line,
without needing to hack/edit the source codes. About hacking: MSNoise has now a
proper documented API which allows pythonistas to write their own plots,
all your projects and/or all users using ``pip``. The new top-level ``msnoise``
command contains all the steps of the workflow, plus new additions, as the very
useful ``reset`` command to easily mark all jobs "T"odo. The ``msnoise plot``
command group which includes seven plots, all directly callable from the command
line, without needing to hack/edit the source codes. About hacking: MSNoise has
now a proper documented API which allows pythonistas to write their own plots,
computation steps, ..., while interacting with the database and the data
archive! The "dynamic time lag" allows to use parts of the coda that is
dependent from the interstation distance (provided station coordinates are
defined).
Finally, MSNoise is now *tested* and automatically checked by Travis-CI!


This version has benefited from outputs/ideas/pull requests/questions from
several users:

Expand All @@ -62,11 +61,21 @@ several users:
* all others (don't be mad :-) )


Thanks to all for using MSNoise, and please, let us know why/how you use it!
Thanks to all for using MSNoise, and please, let us know why/how you use it
(and please cite it!)!


*Thomas Lecocq & Corentin Caudron*

~~~~

PS: if you use MSNoise for your research and prepare publications, please
consider citing it:

**Lecocq, T., C. Caudron, et F. Brenguier (2014)**, MSNoise, a Python Package
for Monitoring Seismic Velocity Changes Using Ambient Seismic Noise,
*Seismological Research Letters*, 85(3), 715‑726, doi:10.1785/0220130073.



MSNoise is a real Python Package
Expand Down
4 changes: 2 additions & 2 deletions msnoise/default.py
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@
default['maxlag'] = ["Maximum lag (in seconds) [120.0]",'120.']
default['corr_duration'] = ["Data windows to correlate (in seconds) [1800.]",'1800.']
default['overlap'] = ["Amount of overlap between data windows [0:1[ [0.]",'0.0']
default['windsorizing'] = ["Windsorizing at N time RMS (in unit), 0 disables windsorizing [3]",'3']
default['windsorizing'] = ["Windsorizing at N time RMS , 0 disables windsorizing, -1 enables 1-bit normalization [3]",'3']

default['crondays'] = ["Number of days to monitors with cron [-1]",'-1']

Expand All @@ -43,7 +43,7 @@
default['ref_begin'] = ["Beginning or REF stacks. Can be absolute (2012-01-01) or relative (-100) days",'-100']
default['ref_end'] = ["End or REF stacks. Same as ref_begin",'0']

default['mov_stack'] = ["Number of days to stack for the Moving-window stacks ([5]= [day-4:day]), can be a comma-separated list 2,5,10","5"]
default['mov_stack'] = ["Number of days to stack for the Moving-window stacks ([5]= [day-4:day]), can be a comma-separated list 1,2,5,10","5"]

default['export_format'] = ["Export stacks in which format(s) ? SAC/MSEED/[BOTH]","MSEED"]
default['sac_format'] = ["Format for SAC stacks ? [doublets]/clarke","doublets"]
Expand Down

0 comments on commit 55b09e4

Please sign in to comment.