Skip to content

Commit

Permalink
StackSplit_files.txt: Convert to Markdown, remove release dates, and …
Browse files Browse the repository at this point in the history
…use table (#8)
  • Loading branch information
yvonnefroehlich authored Jan 16, 2025
1 parent 0a2a803 commit b848ab1
Show file tree
Hide file tree
Showing 2 changed files with 28 additions and 37 deletions.
28 changes: 28 additions & 0 deletions 02_stacksplit/StackSplit/Doc/StackSplit_files.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
The following functions are essential to run StackSplit (besides the SplitLab package).
If any problem occurs or you have suggestions to make StackSplit better please don't hesitate to
open a new issue or PR on GitHub to give comments or address suggestions for improvements etc.

| Function | Description |
| --- | --- |
| install_StackSplit.m | Run in command wdw to start installation process of StackSplit |
| SS_basic_settings.m | Set/change basic settings |
| SS_calc_RH.m | Apply the RH method, calculate SNR-weight and BAZ-normalization |
| SS_calc_SIMW.m | Apply SIMW on selected waveforms using the predefined methods (RC,SC,EV) |
| SS_check_inputs.m | Check consistency of input data like sampling rate (apply resampling if necessary), phi-dt grid parameters etc. |
| SS_check_matlab_version.m | Check current MATLAB version to avoid problems in some functions with R2014b or newer |
| SS_disp_Esurf_single.m | Display single error surface of selected list entry |
| SS_gen_legends.m | Subfunction to generate the GUI legends with splits and nulls above listbox |
| SS_gen_stackresplot.m | Generate output plot after using SAVE button in the surface stacking procedure |
| SS_gen_worldmap.m | Subfunction to generate the GUI world map for displaying the selected event locations |
| SS_geterrorbars_stack_Esurf.m | Calculate errors for stacked surfaces |
| SS_layout.m | Generate GUI layout |
| SS_plates.mat | File containing the plate boundaries for the world map |
| SS_prep_SIMW.m | Display single and concatenated waveforms after selection in listbox |
| SS_read_SLresults.m | Read individual single event results saved from SplitLab |
| SS_saveresults.m | Save multi-event results (error surfaces, SIMW) to mat-file |
| SS_splitdiagnosticLayout.m | Generate layout for diagnostic plot using SIMW |
| SS_splitdiagnosticplot.m | Make diagnostic plot using SIMW |
| SS_splitdiagnosticSetHeader.m | Set header values for diagnostic plot using SIMW |
| SS_stack_Esurf.m | Calculate stacked error surface |
| SS_stacksplit_start.m | Main function of StackSplit that is called by button Stacking via SplitLab |
| unistall_StackSplit.m | Run in command wdw to uninstall StackSplit from your system |
37 changes: 0 additions & 37 deletions 02_stacksplit/StackSplit/Doc/StackSplit_files.txt

This file was deleted.

0 comments on commit b848ab1

Please # to comment.