Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

PySEP v0.6.0 #143

Merged
merged 31 commits into from
Apr 19, 2024
Merged

PySEP v0.6.0 #143

merged 31 commits into from
Apr 19, 2024

Conversation

bch0w
Copy link
Member

@bch0w bch0w commented Apr 19, 2024

Spring cleaning version release, PySEP v0.6.0.

Changelog

bch0w and others added 30 commits August 17, 2023 10:30
…GLOBE format, previously could only handle 3D_CARTESIAN. adds more detailed docstring for the function
…'origin_time' to match other read functions and be slightly more intuitive
…an a PySEP SOURCE object, so that it can be parsed and used by Pyflex which is expecting ObsPy Event or Catalog objects to define sources
…h provides additional file format support to ObsPy's read_events function
… in FORCESOLUTION and SOURCE files from SPECFEM2D/3D. the revised method simply returns barebones ObsPy Event objects which is much cleaner and avoids requiring having to define an entirely new class. Does not affect PySEP routines, these were mainly used by external libraries calling PySEP
…ix zero trace length (#121)

* bumping version numbers to 0.5.0-dev to signify backwards-incompatible changes and that this is the 'dev' version of the code

* Issue #120 single-sourcing version number from pyproject.toml and sourcing version number in docs and __init__ directly from this value

* code fix conf finding version number,
update 'how_to_version_release' to only bump pyproject.toml version number

* #117 added a new pre-preprocessing curtail function that removes Traces whose trace lenght is 0

* #116 RecSec now logs amplitude and amplitude ratios if both obs and syn are plotted together

* amp ratio log messages now for abs max

* update CHANGELOG
…by setting default origin time to 1970-01-01T00:00:00 directly in the input variables
* bugfix: xlim_s was using time and not sample to index the waveform when selecting max amplitudes for normalization, causing incorrect normalization to occur

* tests caught edge case where indicies were None and could not be converted to integer samples. fixing
* BUGFIX: in read_events_plus, read_specfem3d_cmtsolution_cartesian was returning an Event and not a catalog object. This was probably fine but not consistent with the other returns

* new recsec.read_data function that replaces the old generate_synthetic_data function, contains logic for taking paths and return streams and can handle both obs and syn data as well as SAC formatted syn data (#122)
bugfix: added a catch in recsec to kill the object if no stream data are found

* API CHANGE: RecSec parameter 'cmtsolution' has been changed to 'source' for generality because the file does not need to be a cmtsolution, can be a forcesolution or source as well

* small bugfixes to get synthetic stream reading working

* adding Cartesian generated synthetics to test data and added new test data to make sure read_sem can handle these appropriately

* removing some of the test data, only need a few traces

* update API recsec cmtsolution -> source

* update changelog
…parameter added '--srcfmt' which allows the User to set the file format manually. If srcfmt is not provided, RecSec will attempt to guess the file format based on the file name, checking against a list of common SPECFEM source file format types
…ss strict about how it expects the incoming file to be formatted
… and not samples, to index the visible portion of the waveform for use in determining the local max amplitude within the time window. This would have led to incorrectly scaled waveforms when using the option 'xlim_s'. This bugfix sets the correct index unit, and ensures that all indices coming out of getter function 'get_xlim' are integers so that they directly be used to index waveform data
Accommodating parameter name change from 'cmtsolution' to 'source' in the docs to match recent update in #124
…ow user to determine which files are read in
…onfig writing function, remade the template config, added new test to check the example config files are still in order and removed some unncessary parameters from example configs
added logger warning about zero amplitude scaling
feature: user can now set kwargs for obs_color and syn_color
* extending read_sem_cartesian test to check for evdp related to #132
adding warning messages to sac header append when evdp or mag not
present

* extended cartesian sac headers to match all normal sac header values except for cmpinc and cmpaz
added better warning message for missing sac header values in normal sac header reading
extended tests to cover new functionalities
* reorganizing docstring, restructuring preprocess flag
default value for overwrite is now set True so User does not have to unset
changed default preprocess flag to True, removed 'both' option

* fixed up check function to reflect new preprocess flag

* restructuring preprocessing function to put each individual feature behind a boolean flag so that they can be turned on/off at will
also expose some key arguments as keyword arguments so the User has more control

* all preprocessing now behind tunable knobs

* moved kwargs to args of process_st
reorganized init parameter input to organize a bit better
added new parameters to main docstring

* allow preprocess=True to be more flexible and just take st and st_syn if available, removed hard check on preprocess=True requireing st_syn to be more intutive by users
bugfix move fill value to after assignment of trace in loop

* moved parameters back to internal kwargs to match recsec structure and allow passing them in through command line
@bch0w bch0w merged commit 9e77ad3 into master Apr 19, 2024
1 check passed
@bch0w bch0w deleted the devel branch April 19, 2024 23:03
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant