Skip to content

[WIP/ENH] - Update object organization and documentation #356

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
Open
wants to merge 42 commits into
base: main
Choose a base branch
from
Open

[WIP/ENH] - Update object organization and documentation #356

wants to merge 42 commits into from

Conversation

TomDonoghue
Copy link
Member

@TomDonoghue TomDonoghue commented Apr 13, 2025 •
edited
Loading

Updates:

  • add and use ModelComponents and ModelParameters in Results objects
  • drops the trailing underscore for results related attributes (since these are now explicitly organized)

@TomDonoghue
move model components to sub-object
2878076
@TomDonoghue
update BaseModel docs
0057188
@TomDonoghue
modeled_spectrum_ -> modeled_spectrum
38b6734
@TomDonoghue
move ModelComponents
9bb2331
@TomDonoghue
add ModelParameters object
3b2c2c0
@TomDonoghue
update to use results.params
114d20a
@TomDonoghue
add non-default settings to test objects
c5b8f96
@TomDonoghue
extend compare_model_objs
bb3cee9
@TomDonoghue
udpate IO tests to be more stringent
9804529
@TomDonoghue
update add_from_dict to clean up & fix algo settings
d9101d4
@TomDonoghue
finish removing _check_loaded_results
e0cb026
@TomDonoghue
deprecate results fields / add as property to params
ab9d696
@TomDonoghue
bands repr -> str
e4656d9
@TomDonoghue
drop trailing underscores
d0b8831
@TomDonoghue
remove trailing underscores - null
23c1346
@TomDonoghue
clean up data checks
d161992
@TomDonoghue
sweep for docstrings content
08c8961
@TomDonoghue
tweak / update SettingsDefinitions
eb8d39c
@TomDonoghue
tweak Algorithm object for settings
e8f83d1
@TomDonoghue
add SettingsValues
91720a3
@TomDonoghue
use SettingsValues
4418e1f
@TomDonoghue
udpate across code to use algorithm.settings
9803c2f
@TomDonoghue
update spectral fit settings def dict name
47fef97
@TomDonoghue
add private_settings to Algorithm
ad6c0e0
@TomDonoghue
use private settings on spectral fit algorithm object
cabf8af
@TomDonoghue
update process for peak_width_limits -> gaussian std
71cd252
@TomDonoghue
drop reset internal settings - no longer used
f751262
@TomDonoghue
add clear method to settings values
7aaeb42
@TomDonoghue
drop _check_loaded_settings
944e812
@TomDonoghue
update algo to use cf settings
4564872
@fooof-tools fooof-tools deleted a comment from codecov bot Apr 22, 2025
@fooof-tools fooof-tools deleted a comment from codecov bot May 5, 2025
@fooof-tools fooof-tools deleted a comment from codecov bot May 21, 2025
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.
1 participant
@TomDonoghue