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.

Sign up for GitHub

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

Jump to bottom

V2 clean state #64

Open
wants to merge 73 commits into
base: v2
Choose a base branch
from
Open

V2 clean state #64

wants to merge 73 commits into from

Conversation

krisvanneste
Copy link
Collaborator

Claudio,

Here is a branch with a first version of a ssp_clear_state function.
It resets some global variables caching information in different submodules. Optionally, config.options can be cleared and config can be reset to the default values.
More testing is still needed (involving multiple runs with different data/settings).
Can you have a look and improve it?

@claudiodsf
Modernize the build system using pyproject.toml
73c6fc7 
Also, remove vendored `versioneer.py`
@claudiodsf
Temporarily rename project to sourcespec2
9a18e89 
Also add "2" suffix to all console scripts.
@claudiodsf
Replace absolute imports with relative imports
d5d78cc 
This allows for actually using "sourcespec2"
modules instead of "sourcespec" modules.
@claudiodsf
Move all config-related files to a "config" directory
cb6647f
@claudiodsf
Move library version check to its own module
1463ab2
@claudiodsf
Move configure() to config.py
67fef92
@claudiodsf
Make it possible to call configure() without any arguments
81ee077
@claudiodsf
Export a global config object
8da0db4 
TODO: not yet used in the rest of the code
@claudiodsf
Move validation and deprecation checks to the Config class
f213df8
@claudiodsf
Rename configure() to configure_cli()
32bb403 
Also, split the code into multiple submodules.
@claudiodsf
Use the global config object in ssp_setup.py and ssp_read_traces.py
4a33674
@claudiodsf
Use the global config object in ssp_read_event_metadata.py and ssp_…
100f72e 
…read_sac_header.py
@claudiodsf
Use the global config object in ssp_process_traces.py.
6f3fa52
@claudiodsf
Use the global config object in ssp_wave_arrival.py
0c2de67
@claudiodsf
Use the global config object in ssp_build_spectra.py, ssp_correctio…
fd8408e 
…n.py, and ssp_radiation_pattern.py
@claudiodsf
Use the global config object in ssp_plot_traces.py
ef62e07
@claudiodsf
Use the global config object in ssp_inversion.py, ssp_grid_sampling…
cc8720d 
….py and ssp_data_types.py
@claudiodsf
Use the global config object in ssp_radiated_energy.py
f2cebc9
@claudiodsf
Use the global config object in ssp_local_magnitude.py
644d275
@claudiodsf
Use the global config object in ssp_summary_statistics.py
d950d50
@claudiodsf
Use the global config object in ssp_output.py, ssp_qml_output.py, a…
fc86bef 
…nd ssp_sqlite_output.py
@claudiodsf
Use the global config object in ssp_residuals.py
8367bf3
@claudiodsf
Use the global config object in ssp_plot_spectra.py
840309a
@claudiodsf
Use the global config object in ssp_plot_stacked_spectra.py
f8612b2
@claudiodsf
Use the global config object in ssp_plot_params_stats.py
7d0fd3d
@claudiodsf
Use the global config object in ssp_plot_stations.py
fc07b44
@claudiodsf
Use the global config object in ssp_html_report.py
652e367
@claudiodsf
Use the global config object in ssp_read_station_metadata.py
61f2429
@claudiodsf
Use the global config object in ssp_util.py
56c3397
@claudiodsf
Use the global config object in ssp_geom_spreading.py
fb3dabe
claudiodsf and others added 17 commits January 10, 2025 09:20
@claudiodsf
Make it possible to read event, picks, traces and metadata from multi…
6cfe38a 
…ple ASDF files
@claudiodsf
_Config() class: use the term "paramter" instead of "option"
f90cc3f
@claudiodsf
Custom _Options class, with builtin checks for API users.
13cea57
@claudiodsf
Move sac_header.py to `station_metadata_parsers/sac_station_metadat…
dd78cd6 
…a.py
@claudiodsf
Move instrument metadata parsing from SAC header to read_traces and…
c820df2 
… `read_station_metadata`.
@claudiodsf
Make _Options a subclass of dict. Clear _Options when clearing …
b773bcf 
…`_Config`.
@claudiodsf
Move trace selection from config to traces.py
d53f323
@claudiodsf
ssp_exit: error messages and raise exception
c3302be 
This commit changes the ssp_exit function to accept a string as an error
message. If the status is a string, it is used as an error message and
the exit status is set to 1 (failure). The function now also accepts an
extra_message parameter, which is printed to stderr before exiting.

If the program is not running from the command line and the status
corresponds to an error, the function raises a RuntimeError exception.
@claudiodsf
Manage more cases of missing options in config
1a8c991
@krisvanneste @claudiodsf
Allowed 'tag' argument of parse_asdf_traces function to contain wildc…
600af3e 
…ards.

Added 'header_key' argument to _parse_asdf_headers function, and allowed 'tag' argument to be list.
Improved error catching when trying to deserialize header values in _parse_asdf_headers function.
@krisvanneste @claudiodsf
Added support for separate tags for each ASDF file in _read_asdf_trac…
9bff212 
…es function.
@claudiodsf
Small cosmetic changes in asdf parsing
7305030 
Most important change is log message when no ASDF tag is specified.
@claudiodsf
Update docstrings in asdf_traces.py for consistency
203c86a
@claudiodsf
Remove unused import in event_and_picks.py
714e088
@claudiodsf
Better logging for when no event or pick information is found
cd83411
@claudiodsf
Update copyright year to 2025
029158b
@krisvanneste
Added ssp_clear_state function.
c6e9218 
Clear state from possible previous run at beginning of ssp_run function.
@claudiodsf claudiodsf changed the base branch from main to v2 January 10, 2025 13:05
@claudiodsf
Copy link
Member

Thanks Kris!

I'll look into that later today or early next week.

Could you please send me by email the latest version of your working notebook example?

P.S. I changed the destination branch of this PR from main to v2 😉

@krisvanneste
Copy link
Collaborator Author

P.S. I changed the destination branch of this PR from main to v2 😉

Sorry, that's causing the conflicts of course. Github presented me with a PR proposal and I clicked on it...

@krisvanneste
Copy link
Collaborator Author

Could you please send me by email the latest version of your working notebook example?

OK, I will clean up some stuff first.
Shall I send it by mail or in this thread?

@krisvanneste
Copy link
Collaborator Author

Could you please send me by email the latest version of your working notebook example?

OK, I will clean up some stuff first. Shall I send it by mail or in this thread?

What is the name of the notebook I sent you earlier?

@claudiodsf
Copy link
Member

I think it was run_ssp_from_asdf.ipynb.

Maybe we can iterate by mail on the notebook (and the required data)

@claudiodsf claudiodsf force-pushed the v2 branch 6 times, most recently from 86135f1 to df850d5 Compare January 27, 2025 22:11
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@krisvanneste @claudiodsf