Skip to content

Commit a9fdd0f

Browse files
authored
Merge pull request #2 from jpvantassel/dev
In preparation for v0.1.1
2 parents d7ea1e7 + fe0b434 commit a9fdd0f

59 files changed

Lines changed: 692 additions & 336 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

.circleci/config.yml

Lines changed: 24 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -16,14 +16,17 @@ workflows:
1616
- test-38:
1717
context:
1818
- docker
19-
# - test-39:
20-
# context:
21-
# - docker
19+
- test-39:
20+
context:
21+
- docker
22+
- test-310:
23+
context:
24+
- docker
2225

2326
jobs:
2427
test-36: &test-template
2528
docker:
26-
- image: circleci/python:3.6.9
29+
- image: cimg/python:3.6.9
2730
auth:
2831
username: jpvantassel
2932
password: $DOCKER_PASS
@@ -75,23 +78,31 @@ jobs:
7578
test-37:
7679
<<: *test-template
7780
docker:
78-
- image: circleci/python:3.7.5
81+
- image: cimg/python:3.7.5
7982
auth:
8083
username: jpvantassel
8184
password: $DOCKER_PASS
8285

8386
test-38:
8487
<<: *test-template
8588
docker:
86-
- image: circleci/python:3.8.0
89+
- image: cimg/python:3.8.10
8790
auth:
8891
username: jpvantassel
8992
password: $DOCKER_PASS
9093

91-
# test-39:
92-
# <<: *test-template
93-
# docker:
94-
# - image: circleci/python:3.9.0
95-
# auth:
96-
# username: jpvantassel
97-
# password: $DOCKER_PASS
94+
test-39:
95+
<<: *test-template
96+
docker:
97+
- image: cimg/python:3.9.6
98+
auth:
99+
username: jpvantassel
100+
password: $DOCKER_PASS
101+
102+
test-310:
103+
<<: *test-template
104+
docker:
105+
- image: cimg/python:3.10.2
106+
auth:
107+
username: jpvantassel
108+
password: $DOCKER_PASS

LICENSE.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
This license applies to swprocess a Python package for surface wave processing.
2-
Copyright (C) 2020 Joseph P. Vantassel (jvantassel@utexas.edu)
2+
Copyright (C) 2020 Joseph P. Vantassel (joseph.p.vantassel@gmail.com)
33

44
GNU GENERAL PUBLIC LICENSE
55
Version 3, 29 June 2007

README.md

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
> Joseph P. Vantassel, The University of Texas at Austin
44
55
[![DOI](https://zenodo.org/badge/202217252.svg)](https://zenodo.org/badge/latestdoi/202217252)
6-
[![PyPI - License](https://img.shields.io/pypi/l/swprocess)](https://github.com/jpvantassel/swprocess/blob/master/LICENSE.txt)
6+
[![PyPI - License](https://img.shields.io/pypi/l/swprocess)](https://github.com/jpvantassel/swprocess/blob/main/LICENSE.txt)
77
[![CircleCI](https://circleci.com/gh/jpvantassel/swprocess.svg?style=svg)](https://circleci.com/gh/jpvantassel/swprocess)
88
[![Documentation Status](https://readthedocs.org/projects/swprocess/badge/?version=latest)](https://swprocess.readthedocs.io/en/latest/?badge=latest)
99
![PyPI - Python Version](https://img.shields.io/pypi/pyversions/swprocess)
@@ -30,10 +30,9 @@ the following:
3030
> Vantassel, J. P. (2021). jpvantassel/swprocess: latest (Concept). Zenodo.
3131
> [https://doi.org/10.5281/zenodo.4584128](https://doi.org/10.5281/zenodo.4584128)
3232
33-
> Vantassel, J. P. & Cox, B. R. (2021). "SWprocess: A workflow for developing robust
34-
> estimates of surface wave dispersion uncertainty". Submitted to a special edition of the
35-
> Journal of Seismology organized by the Consortium of Organizations for Strong Motion
36-
> Observation Systems (COSMOS)
33+
> Vantassel, J. P. & Cox, B. R. (2022). "SWprocess: a workflow for developing robust
34+
> estimates of surface wave dispersion uncertainty". Journal of Seismology.
35+
> [https://doi.org/10.1007/s10950-021-10035-y](https://doi.org/10.1007/s10950-021-10035-y)
3736
3837
_Note: For software, version specific citations should be preferred to
3938
general concept citations, such as that listed above. To generate a version
@@ -96,7 +95,7 @@ last few lines of the text displayed in the console.
9695
### Using _swprocess_
9796

9897
1. Download the contents of the
99-
[examples](https://github.com/jpvantassel/swprocess/tree/master/examples)
98+
[examples](https://github.com/jpvantassel/swprocess/tree/main/examples)
10099
directory to any location of your choice.
101100

102101
2. Start by processing the provided active-source data using the

benchmarks/model_0/vis_model_0.ipynb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@
1111
"\n",
1212
"This file is distributed as part of _swprocess_, a Python package for surface wave processing.\n",
1313
"\n",
14-
" Copyright (C) 2020 Joseph P. Vantassel (jvantassel@utexas.edu)\n",
14+
" Copyright (C) 2020 Joseph P. Vantassel (joseph.p.vantassel@gmail.com)\n",
1515
"\n",
1616
" This program is free software: you can redistribute it and/or modify\n",
1717
" it under the terms of the GNU General Public License as published by\n",

benchmarks/model_1/vis_model_1.ipynb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@
1111
"\n",
1212
"This file is distributed as part of _swprocess_, a Python package for surface wave processing.\n",
1313
"\n",
14-
" Copyright (C) 2020 Joseph P. Vantassel (jvantassel@utexas.edu)\n",
14+
" Copyright (C) 2020 Joseph P. Vantassel (joseph.p.vantassel@gmail.com)\n",
1515
"\n",
1616
" This program is free software: you can redistribute it and/or modify\n",
1717
" it under the terms of the GNU General Public License as published by\n",

benchmarks/model_2/vis_model_2.ipynb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@
1111
"\n",
1212
"This file is distributed as part of _swprocess_, a Python package for surface wave processing.\n",
1313
"\n",
14-
" Copyright (C) 2020 Joseph P. Vantassel (jvantassel@utexas.edu)\n",
14+
" Copyright (C) 2020 Joseph P. Vantassel (joseph.p.vantassel@gmail.com)\n",
1515
"\n",
1616
" This program is free software: you can redistribute it and/or modify\n",
1717
" it under the terms of the GNU General Public License as published by\n",

benchmarks/model_3/vis_model_3.ipynb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@
1111
"\n",
1212
"This file is distributed as part of _swprocess_, a Python package for surface wave processing.\n",
1313
"\n",
14-
" Copyright (C) 2020 Joseph P. Vantassel (jvantassel@utexas.edu)\n",
14+
" Copyright (C) 2020 Joseph P. Vantassel (joseph.p.vantassel@gmail.com)\n",
1515
"\n",
1616
" This program is free software: you can redistribute it and/or modify\n",
1717
" it under the terms of the GNU General Public License as published by\n",

docs/conf.py

Lines changed: 13 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -13,12 +13,21 @@
1313
import os
1414
import sys
1515

16-
meta = {}
17-
with open("../swprocess/meta.py") as f:
18-
exec(f.read(), meta)
19-
2016
sys.path.insert(0, os.path.abspath('../swprocess'))
2117

18+
19+
def parse_meta(path_to_meta):
20+
with open(path_to_meta) as f:
21+
meta = {}
22+
for line in f.readlines():
23+
if line.startswith("__version__"):
24+
meta["__version__"] = line.split('"')[1]
25+
return meta
26+
27+
28+
meta = parse_meta("../swprocess/meta.py")
29+
30+
2231
# -- Project information -----------------------------------------------------
2332
project = 'swprocess'
2433
copyright = '2020, Joseph P. Vantassel'

docs/index.rst

Lines changed: 17 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -2,14 +2,23 @@ swprocess Documentation
22
=======================
33

44
`swprocess` is a Python package for surface wave processing.
5-
It includes features for performing active-source surface wave
6-
processing [i.e., mulitchannel analysis of surface wave (MASW)],
7-
post-processing passive-wavefield surface wave data
8-
[i.e., microtremor array measurements (MAM)] processed using
9-
the open-source software Geopsy, and combining active-source
10-
and/or passive-wavefield data to calculate rigorous statistics
11-
on the surface wave dispersion data, which account for epistemic
12-
and aleatory uncertainty.
5+
6+
`swprocess` supports:
7+
8+
* processing of active-source surface wave data (i.e., MASW),
9+
* post-processing of passive-wavefield surface wave data (i.e., MAM) processed using Geopsy,
10+
* combining active-source and/or passive-wavefield dispersion data from different arrays, and
11+
* calculation of rigorous surface wave dispersion statistics.
12+
13+
If you use `swprocess` in your research or consulting please cite the following:
14+
15+
* Vantassel, J. P. (2021). jpvantassel/swprocess: latest (Concept). Zenodo. `https://doi.org/10.5281/zenodo.4584128 <https://doi.org/10.5281/zenodo.4584128>`_
16+
* Vantassel, J. P. & Cox, B. R. (2022). "SWprocess: a workflow for developing robust estimates of surface wave dispersion uncertainty". Journal of Seismology. `https://doi.org/10.1007/s10950-021-10035-y <https://doi.org/10.1007/s10950-021-10035-y>`_
17+
18+
*Note: For software, version specific citations should be preferred to
19+
general concept citations, such as that listed above. To generate a version
20+
specific citation for swprocess, please use the citation tool on the swprocess*
21+
`archive <https://doi.org/10.5281/zenodo.4584128>`_.
1322

1423
This package is actively being developed, so if you do not see a feature you
1524
would like it may very well be under development and released in

docs/license.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
License Information
44
===================
55

6-
Copyright (C) 2020 Joseph P. Vantassel (jvantassel@utexas.edu)
6+
Copyright (C) 2020 Joseph P. Vantassel (joseph.p.vantassel@gmail.com)
77

88
This program is free software: you can redistribute it and/or modify
99
it under the terms of the GNU General Public License as published by
@@ -16,4 +16,4 @@ License Information
1616
GNU General Public License for more details.
1717

1818
You should have received a copy of the GNU General Public License
19-
along with this program. If not, see <https: //www.gnu.org/licenses/>.
19+
along with this program. If not, see `<https: //www.gnu.org/licenses/> <https: //www.gnu.org/licenses/>`_.

0 commit comments

Comments
 (0)