Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/anowacki/seis.jl
An open, fast and flexible framework for analysing seismic data in Julia
https://github.com/anowacki/seis.jl
julia seis-jl seismology
Last synced: 29 days ago
JSON representation
An open, fast and flexible framework for analysing seismic data in Julia
- Host: GitHub
- URL: https://github.com/anowacki/seis.jl
- Owner: anowacki
- Created: 2018-06-08T16:40:48.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2024-11-04T21:52:56.000Z (about 2 months ago)
- Last Synced: 2024-11-04T22:32:33.062Z (about 2 months ago)
- Topics: julia, seis-jl, seismology
- Language: Julia
- Size: 24.3 MB
- Stars: 23
- Watchers: 3
- Forks: 4
- Open Issues: 9
-
Metadata Files:
- Readme: README.md
- Changelog: NEWS.md
Awesome Lists containing this project
README
# Seis.jl
[](https://github.com/anowacki/Seis.jl/actions)
[](https://codecov.io/gh/anowacki/Seis.jl)
Seis.jl is an open, fast and flexible framework for analysing seismic
data in [Julia](https://julialang.org).
For detailed instructions on using Seis, see the documentation via the
links below.
[](https://anowacki.github.io/Seis.jl/stable)
[](https://anowacki.github.io/Seis.jl/dev)
This readme file gives a brief introduction to installing and using
Seis.
## Installation
At present, Seis is unregistered and it and its dependencies must be
installed manually. This will change once Seis is registered in
the General registry.
To install Seis, do:
```julia
julia> ] # As soon as you press ']', you enter Pkg mode...
(v1.3) pkg> add https://github.com/anowacki/Geodesics.jl https://github.com/anowacki/Seis.jl
```
## Basic introduction
`Seis` is based around single traces of evenly-sampled continuous data where
time is the independent variable. (In future we may support unevenly-sampled
data and traces with gaps, and we plan to soon support frequency-domain traces.)
Each trace holds its sampling interval (the property `.delta`) and a start time
(`.b`). Traces have the type `Trace`.
`Trace`s also optionally hold information about the event (`.evt`) and station
(`.sta`) associated with this recording. `Event`s and `Station`s are the
corresponding types, which also contain useful properties.
For more information, see the docstrings for `Trace`, `Event` and `Station`.
This is easily done in the Julia REPL like so:
```julia
julia> using Seis
julia> ? # As soon as you press '?', the prompt changes to 'help?>'
help?> Trace
search: Trace trace backtrace AbstractSet AbstractVector AbstractVecOrMat
Trace
Evenly-sampled time series recorded at a single seismic station. The start
time of the trace, in s, is in the b field, whilst the sampling interval, in
s, is delta. The trace itself is accessed using the trace method, like
trace(t).
[...]
```
All three types above also hold a `.meta` property, which contains any extra
metadata you want to associate with the trace, event or station.
## Common conventions
### `f` vs `f!`
`Trace`s are `mutable struct`s, and therefore for all functions which
potentially modify a trace, there are two versions. Firstly, an in-place
function (e.g., `bandpass!`) which as per Julia convention ends with an
exclamation mark, and modifies the trace. Secondly, for convenience, there
is always a copying version without the exclamation mark (e.g., `bandpass`)
which returns a modified copy of the input trace.
### Arrays of traces
There is no special type for holding multiple traces. Instead, we operate
on arrays of traces. For instance, reading multiple traces from the same
event, we can access all the station names like so:
```julia
julia> t = sample_data(:array);
julia> t.sta.sta
60-element Array{String,1}:
"ABA"
"APA"
"AWI"
"BBH"
"BBO"
"BDL"
"BTA"
"BWH"
"CRA"
"CSF"
"EAB"
"EAU"
"EBH"
⋮
"PMS"
"TSA"
"WAL"
"WCB"
"WME"
"WPM"
"XAL"
"XDE"
"YEL"
"YLL"
"YRC"
"YRE"
```
Or to get the full channel code from available header information:
```julia
julia> channel_code.(t)
60-element Array{String,1}:
".ABA..SHZ"
".APA..SHZ"
".AWI..SHZ"
".BBH..SHZ"
".BBO..SHZ"
".BDL..SHZ"
".BTA..SHZ"
".BWH..SHZ"
".CRA..SHZ"
".CSF..SHZ"
".EAB..SHZ"
".EAU..SHZ"
".EBH..SHZ"
⋮
".PMS..SHZ"
".TSA..SHZ"
".WAL..SHZ"
".WCB..SHZ"
".WME..SHZ"
".WPM..SHZ"
".XAL..SHZ"
".XDE..SHZ"
".YEL..SHZ"
".YLL..SHZ"
".YRC..SHZ"
".YRE..SHZ"
```
Note the use of the broadcasted `.` operation (`channel_code.(t)`) which applied
the 'scalar' function (`channel_code`) to each trace in the array `t`.
## IO
Currently, SAC data are read or written (and may be either bigendian
(SAC/BRIS convention) or little-endian (usual IRIS SAC convention)), and
miniSEED files are read.
Use the `read_sac` and `write_sac` functions for SAC-formatted IO,
and `read_mseed` function for miniSEED reading.
Future work will add support for reading many more formats and format
auto-detection.
## Plotting
Plotting is available when `using Plots`. Seis.jl
makes use of [RecipesBase.jl](https://github.com/JuliaPlots/RecipesBase.jl)
so that if you do not need plotting, the package does not introduce this
dependency. If you do want plots, simply install
[Plots.jl](https://github.com/JuliaPlots/Plots.jl)
by `import Pkg; Pkg.add("Plots")`. You then need to do `using Plots` when you
want to start using Seis.jl's plotting routines.
By default,
plotting functionality is not exported, so you must also do `using Seis.Plot`
before the routines `section` (plot record sections) and `hodogram` (particle
motion plots) are available. (`plot` to show traces is available as soon
as `Plots` is loaded.)
As an example:
```julia
julia> using Seis, Seis.Plot, Plots
julia> t = sample_data(:array);
julia> section(t)
```
produces:
See the help for the `Seis.Plot` module for more information.
## Basic processing
Basic time series processing of traces is possible using functions such as
`integrate`, `bandpass`, `remove_trend`. See the online documentation
for a full description of the functions available and how to use them.
## Maintainers
At present, [Andy Nowacki](mailto:[email protected]) (@anowacki) is
the primary maintainer of Seis.jl.
## Contributing
Contributions to Seis are most welcome. Please open issues in this
repo with bug reports or feature requests. Pull requests for the same
are also very welcome.