⚡ [Refactor]: Organize all example scripts into subdirectories #72
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
- Initializes new subdirectories (`dsc/`, `dilatometry/`, `kinetic_methods/`) within the `examples/` directory to establish a scalable structure. - Adds a `.gitkeep` file to each new directory to ensure they are tracked by Git. - Relocates all existing technique-specific example scripts into their corresponding new subdirectories.
PPeitsch
changed the title
PPeitsch
changed the title
- Renames `dsc_example.py` to `legacy_dsc_analysis_example.py` to mark it as a basic, inherited script. - Removes the local `DSCSegmentAnalyzer` class and its redundant logic. - Simplifies the script to perform a single analysis run on the entire dataset, demonstrating the direct use of the library's core analysis classes. - Adds a note at the top of the file clarifying its legacy status.
PPeitsch
force-pushed
the
feature/add-dsc-examples
branch
from
29ee159 to
a951baf
Compare
Codecov ReportAll modified and coverable lines are covered by tests ✅ ✅ All tests successful. No failed tests found.
|
Updates the version in `__about__.py` and finalizes the CHANGELOG.md for the v0.4.2 release. This version includes robustness improvements to peak detection and a reorganization of the examples directory.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
This pull request implements a complete reorganization of the
examples/directory to improve clarity, organization, and scalability.dsc/,dilatometry/,kinetic_methods/,data_import/,synthetic_data/).examples/folder into their corresponding new subdirectories.dsc_example.pyhas been renamed tolegacy_dsc_analysis_example.pyand its code simplified to serve as a basic, inherited example.This establishes a clean foundation for adding new, use-case-specific examples in the future.
Type of Change
Checklist
black(line length 100)isortfor import sorting⚡ Have you read the Contributing Guidelines?
Fixes #63