Skip to content

Commit

Permalink
Bump version number and sort licences in __init__ files
Browse files Browse the repository at this point in the history
  • Loading branch information
calum-chamberlain committed Oct 9, 2016
1 parent 2c82d3c commit 71b4e0a
Show file tree
Hide file tree
Showing 5 changed files with 38 additions and 100 deletions.
41 changes: 9 additions & 32 deletions eqcorrscan/__init__.py
Original file line number Diff line number Diff line change
@@ -1,43 +1,20 @@
#!/usr/bin/python
r"""
EQcorrscan is a python module designed to run match filter routines for
seismology, within it are routines for integration to seisan and obspy.
With obspy integration (which is necessary) all main waveform formats can be
read in and output.
This main section contains a script, LFE_search.py which demonstrates the usage
of the built in functions from template generation from picked waveforms
through detection by match filter of continuous data to the generation of lag
times to be used for relative locations.
The match-filter routine described here was used a previous Matlab code for the
Chamberlain et al. 2014 G-cubed publication. The basis for the lag-time
generation section is outlined in Hardebeck & Shelly 2011, GRL.
Code generated by Calum John Chamberlain of Victoria University of Wellington,
2015.
EQcorrscan is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
EQcorrscan is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with EQcorrscan. If not, see <http://www.gnu.org/licenses/>.
"""
:copyright:
EQcorrscan developers.
:license:
GNU Lesser General Public License, Version 3
(https://www.gnu.org/copyleft/lesser.html)
"""
import sys
import importlib
import warnings

__all__ = ['core', 'utils']
__all__ = ['core', 'utils', 'tutorials']


__version__ = '0.1.4rc'
__version__ = '0.1.4'


# Cope with changes to name-space to remove most of the camel-case
Expand Down
33 changes: 6 additions & 27 deletions eqcorrscan/core/__init__.py
Original file line number Diff line number Diff line change
@@ -1,31 +1,10 @@
"""EQcorrscan is a python module designed to run match filter routines for \
seismology, within it are routines for integration to seisan and obspy.
With obspy integration (which is necessary) all main waveform formats can be
read in and output.
This main section contains a script, LFE_search.py which demonstrates the usage
of the built in functions from template generation from picked waveforms
through detection by match filter of continuous data to the generation of lag
times to be used for relative locations.
The match-filter routine described here was used a previous Matlab code for the
Chamberlain et al. 2014 G-cubed publication. The basis for the lag-time
generation section is outlined in Hardebeck & Shelly 2011, GRL.
Code generated by Calum John Chamberlain of Victoria University of Wellington,
2015.
All rights reserved.
"""
:copyright:
EQcorrscan developers.
Pre-requisites:
gcc - for the installation of the openCV correlation routine
python-joblib - used for parallel processing
python-obspy - used for lots of common seismological processing
- requires:
numpy
scipy
matplotlib
python-pylab - used for plotting
:license:
GNU Lesser General Public License, Version 3
(https://www.gnu.org/copyleft/lesser.html)
"""

__all__ = ['template_gen', 'match_filter', 'bright_lights', 'lag_calc',
Expand Down
8 changes: 8 additions & 0 deletions eqcorrscan/tutorials/__init__.py
Original file line number Diff line number Diff line change
@@ -1,3 +1,11 @@
"""
:copyright:
EQcorrscan developers.
:license:
GNU Lesser General Public License, Version 3
(https://www.gnu.org/copyleft/lesser.html)
"""
if __name__ == '__main__':
import doctest
doctest.testmod(exclude_empty=True)
35 changes: 7 additions & 28 deletions eqcorrscan/utils/__init__.py
Original file line number Diff line number Diff line change
@@ -1,31 +1,10 @@
"""EQcorrscan is a python module designed to run match filter routines for \
seismology, within it are routines for integration to seisan and obspy. \
With obspy integration (which is necessary) all main waveform formats can be \
read in and output.
This main section contains a script, LFE_search.py which demonstrates the usage
of the built in functions from template generation from picked waveforms
through detection by match filter of continuous data to the generation of lag
times to be used for relative locations.
The match-filter routine described here was used a previous Matlab code for the
Chamberlain et al. 2014 G-cubed publication. The basis for the lag-time
generation section is outlined in Hardebeck & Shelly 2011, GRL.
Code generated by Calum John Chamberlain of Victoria University of Wellington,
2015.
All rights reserved.
Pre-requisites:
gcc - for the installation of the openCV correlation routine
python-joblib - used for parallel processing
python-obspy - used for lots of common seismological processing
- requires:
numpy
scipy
matplotlib
python-pylab - used for plotting
"""
:copyright:
EQcorrscan developers.
:license:
GNU Lesser General Public License, Version 3
(https://www.gnu.org/copyleft/lesser.html)
"""
import sys
import importlib
Expand Down
21 changes: 8 additions & 13 deletions setup.py
Original file line number Diff line number Diff line change
@@ -1,17 +1,11 @@
"""A setuptools based setup module for EQcorrscan package.
EQcorrscan is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
EQcorrscan is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with EQcorrscan. If not, see <http://www.gnu.org/licenses/>.
:copyright:
EQcorrscan developers.
:license:
GNU Lesser General Public License, Version 3
(https://www.gnu.org/copyleft/lesser.html)
"""

# Always prefer setuptools over distutils
Expand Down Expand Up @@ -50,7 +44,7 @@

try:
import cv2 # NOQA
except:
except ImportError:
print(sys.path)
msg = '##### No cv2 module, openCV, you need to install this yourself'
warnings.warn(msg)
Expand Down Expand Up @@ -130,6 +124,7 @@
# that you indicate whether you support Python 2, Python 3 or both.
'Programming Language :: Python :: 2.7',
'Programming Language :: Python :: 3.5',
'Programming Language :: Python :: 3.4',
],

# What does your project relate to?
Expand Down

0 comments on commit 71b4e0a

Please sign in to comment.