Skip to content

⚡ [Feature]: Add examples for specific DSC analysis tasks #64

@PPeitsch

Description

@PPeitsch

Problem Description

Following the refactoring of the examples/ directory (as proposed in a separate issue), there is a need to populate the new examples/dsc/ subdirectory with high-quality, focused examples that demonstrate the full capabilities of the DSC analysis module. The legacy dsc_example.py is insufficient as it does not showcase the module's versatility or produce optimal results.

Proposed Solution

Create a series of new, self-contained example scripts, each dedicated to a specific DSC analysis task. These scripts should generate realistic synthetic data, apply the relevant analysis functions, print clear results to the console, and generate publication-quality plots.

The following initial examples should be created:

  1. polymer_analysis_example.py: Simulates the complete thermal analysis of a semi-crystalline polymer, demonstrating the detection of Tg, cold crystallization, and melting events.
  2. heat_capacity_example.py: Details the process of calculating specific heat capacity (Cp) using the three-step method, including data generation and visualization.
  3. baseline_comparison_example.py: Provides a direct visual comparison of the different baseline correction algorithms available in BaselineCorrector.
  4. smoothing_effects_example.py: An educational example showing how different smoothing levels impact a noisy signal and its derivative, highlighting the importance of preprocessing.

Alternative Solutions

  • This work directly addresses the need for better user guidance and showcases the new features introduced in v0.4.0.
  • These examples will serve as a foundation for tutorials in the project's documentation.
  • Each example should be self-contained and easy to run.

Additional Context

  • All new example files will be placed in the examples/dsc/ directory.
  • Synthetic data should be generated within each script to ensure they are runnable out-of-the-box.
  • Plots should be clearly labeled and titled, following best practices for scientific visualization.

Implementation Details

No response

Guidelines

  • I agree to follow this project's Contributing Guidelines
  • I have searched for similar feature requests
  • I understand that this is a request and implementation is not guaranteed

Metadata

Metadata

Assignees

No one assigned

    Labels

    enhancementNew feature or request

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions