Release Notes - v1.1.0 - Codename: BOLD Boson

This release introduces significant enhancements to the ASL (Arterial Spin Labeling) processing pipeline, focusing on improved image rescaling, memory management, and expanded support for calibration options. These updates are particularly relevant for high-precision neuroimaging workflows like those utilized by the LOAMRI group and similar academic research environments.

---

🚀 New Features & Enhancements

ASL Mapping & Data Handling

• Average Support: Introduced the average M0 parameter in the ASLData class. This allows for more flexible CBF (Cerebral Blood Flow) quantification by enabling the use of averaged equilibrium magnetization data.
• Ultra-Long TE ASL Improvements: Enhanced the UltraLongTE_ASLMapping module with updated parameter initialization and more robust image limit adjustments.
• Memory Efficiency: Refactored output map creation across CBFMapping and other modules to use clone_image. This improves memory handling and ensures that metadata and header information are preserved accurately during map generation.

Image Processing Refinement

• Enhanced Outlier Removal: Improved the _adjust_image_limits method to specifically rescale values. This results in cleaner data by better identifying and handling statistical outliers in the neuroimaging volumes.

---

🧪 Testing & Quality Assurance

• Validation Updates: Added new test cases for averaging in both MultiTE_ASLMapping and ASLData.
• Stricter Assertions: Updated test_multite_asl_object_create_map_success to ensure that output values are strictly greater than zero, preventing the generation of non-physical negative mapping values.
• Refactored Tests: Renamed test functions for UltraLongTE_ASLMapping to follow consistent naming conventions, making the CI/CD pipeline easier to debug.

---

🛠️ Maintenance & Documentation

• Version Bump: Significant update from v1.0.1 through v1.0.2 to the current v1.1.0.
• Documentation: Fixed typos in TODO comments regarding map dimensions and updated FUNDING.yml to reflect current project support.

---

📦 Technical Summary

• Tag: v1.1.0
• Repository: LOAMRI
• Primary Focus: ASL quantification, memory optimization, and outlier robustification.

🌀 Release Note – v1.0.0 - *Anisotropic Atom*

We are excited to announce a new release of ASLtk, packed with powerful new features, major refactoring, expanded compatibility, and improved documentation. This release strengthens the library’s foundations for arterial spin labeling (ASL) MRI analysis, with a special focus on performance, reliability, and usability.

To upgrade to the latest version:

pip install --upgrade asltk

📚 Documentation is available at: [Read the Docs](https://asltk.readthedocs.io)

---

✨ New Features

• Added UltraLongTE ASL Mapping (UltraLongTE_ASLMapping) with advanced multi-echo analysis and T1 relaxometry support.
• Introduced get_optimal_core_count for smarter CPU usage based on available memory.
• Added --average_m0 option for improved M0 handling in CLI workflows.
• Introduced suppress_warnings option in mapping methods for cleaner outputs.
• New resolution parameter in BrainAtlas initialization, supporting finer atlas control.
• Added rate limiting in BrainAtlas API calls to prevent 429 Kaggle errors.
• Enhanced test coverage with unit tests for UltraLongTE mapping, atlas resolution handling, and more.

---

🐛 Bug Fixes

• Fixed ImageIO string representation test for better Windows compatibility.
• Improved error handling in head movement correction and Kaggle API-related tests.
• Correct handling of ASLData initialization in multi-echo/multi-dw tests.

---

⚡ Enhancements / Improvements

• Refactored ImageIO integration across the codebase (registration, normalization, masks, smoothing, image analysis).
• Optimized T2 map stacking for performance and clarity.
• Improved asl_template_registration with better atlas reference handling and extended map support.
• More robust error messages across pipelines for easier debugging.
• Refined handling of brain masks in CBFMapping, MultiDW_ASLMapping, and MultiTE_ASLMapping.
• Smarter default CPU core handling (CBFMapping.create_map now defaults to half available cores).

---

📖 Documentation

• Updated README with new supported Python versions and project badge.
• Improved contribution guidelines (commit messages, pre-commit hooks, PR template).
• Enhanced docs for ImageIO and navigation updates in mkdocs.yml.
• Clarified usage examples for mapping functions and error handling.

---

🎨 Style / Refactoring

• Removed unused imports and commented code.
• Reformatted long lines and functions for better readability.
• Refactored tests to adopt ImageIO consistently.
• Code cleanup in space_normalization, isotropic Gaussian, median, and orientation functions.

---

⚙️ Continuous Integration / DevOps

• CI now supports Python 3.10 → 3.13.
• Reduced supported Python versions to start from 3.10 only (dropping 3.9 and below).
• Added ITK installation and Windows-specific fixes (short paths, dependencies).
• Configured pre-commit hooks for linting and code quality checks.

---

📦 Miscellaneous

• Updated TODO comments for clarity.
• Introduced internal consistency improvements in pyproject.toml.
• Cleaned backup/commented code while documenting where to find removed methods.

---

🙌 Special Thanks

Big thanks to all contributors who made this release possible 🎉, especially those who opened issues and PRs:

• @LOAMRI team for continuous improvements and refactoring efforts.

---

🔥 This release codenamed Anisotropic Atom marks a major milestone: more stable, more efficient, and better documented. Dive into the new features and enjoy a smoother ASL mapping workflow!

🚀 Release Notes — v0.7.1

We’re excited to announce ASLtk v0.7.1

This release brings documentation improvements, workflow refinements, and a touch of polish across the project.

👉 To upgrade, run:

pip install --upgrade asltk

---

✨ New Features

• 🔑 Kaggle API Integration — Added support for Kaggle API credentials to enhance dataset handling and reproducibility (#69).

---

🛠️ Enhancements / Improvements

• 🔧 Refactored Git configuration steps in the bumpversion workflow for improved clarity (#67).

---

🧹 Style / Refactoring

• 📖 Simplified assertions in registration tests to make them more readable and maintainable.
• 🏷️ Updated checkout step names in the bumpversion workflow for clearer CI/CD logs.

---

📚 Documentation

• 📝 Added a Pull Request template to standardize contributions (#71).
• 📖 Updated citations in the README and main documentation index (#68).

You can always find detailed usage guides and API documentation here:
👉 [Read the Docs](https://asltk.readthedocs.io)

---

⚙️ Continuous Integration / DevOps

• 🔄 Improved bumpversion workflow, making version management more transparent and consistent.

---

🙌 Special Thanks

A huge thank you to everyone contributing code, reviews, and feedback for this release! 💙
Particularly:

• @contributor of PR #71 for improving collaboration with the PR template.
• @contributor of PR #69 for enabling Kaggle API integration.
• @contributor of PR #68 for updating academic references in the docs.

---

📦 Summary

This is a maintenance + polish release, focused on making the project more developer-friendly, well-documented, and CI-stable. No breaking changes were introduced — users can safely upgrade.

ASLtk v0.7.0 Codename: Echo Alignment

Codename: Echo Alignment

Echo: Directly relates to the "Echo Time (TE)" and "Multi-TE" mapping, a key new feature enabling T2-weighted ASL. It's a fundamental concept in MRI physics.

Alignment: Points to the extensive work on robust image registration, space normalization, and head movement correction, which are crucial for bringing ASL data into precise spatial correspondence with atlases and other images. It also implies bringing various data aspects into coherence.

We are excited to announce the release of ASLtk v0.7.0 "Echo Alignment"!

This release brings significant advancements in ASL data processing, focusing heavily on robust registration and normalization capabilities, new T2-weighted mapping features, and a substantial expansion of our built-in brain atlas collection. We've also made numerous improvements to our testing infrastructure, documentation, and continuous integration pipelines.

To upgrade ASLtk to this new version, use pip:

pip install --upgrade asltk

---

Release Highlights

New Features

• ASL Data Registration and Normalization:
  • Implemented a comprehensive framework for registering ASL data to a template, including advanced space normalization and head movement correction functionalities.
  • Introduced an apply_transformation function for flexible application of transformations to images.
• T2-weighted ASL Mapping:
  • Introduced new T2Scalar_ASLMapping class, enabling the calculation of T2 maps and other parameters from multi-echo ASL data.
  • Provided a new command-line interface (CLI) script (asltk t2-mapping) for easy execution of T2 Scalar Mapping.
• Enhanced Brain Atlas Management:
  • Reformulation of the BrainAtlas class to dynamically manage and retrieve a wide range of brain atlases via external JSON files, decoupling atlas data from the codebase.
  • Expanded the built-in atlas collection with new and updated versions (e.g., AAL32024, AICHA2021, LGPHCC2022, JHA2005, FCA7N2011), including richer metadata and DOI information for improved traceability.

Bug Fixes

• CI/CD Configuration: Addressed and fixed issues related to Kaggle API credentials setup within CI workflows, specifically improving compatibility with Windows PowerShell.
• Data Loading: Corrected M0 image loading to reliably support both file paths and NumPy arrays, enhancing flexibility for ASLData initialization.
• Core Processing:
  • Ensured the M0 volume is correctly prioritized during asl_template_normalization for more accurate registration.
  • Fixed type checking errors in the apply_transformation function to prevent unexpected behavior.
• Atlas Data: Corrected JSON formatting for the HOCSA2006 brain atlas file.
• Linter Compliance: Resolved various linter errors to maintain code quality.

Enhancements / Improvements

• ASLData Handling:
  • Improved ASLData class to handle 4D M0 images with appropriate warnings and provide averaging functionality for M0 images.
  • Added a deep copy method for ASLData objects, ensuring data integrity during processing.
• Image Analysis and Quality Control:
  • Enhanced head movement correction with flexible reference volume selection methods (based on SNR or mean intensity) and improved transformation proportion calculations.
  • Implemented calculate_snr and analyze_image_properties functions for quantitative assessment of image quality, including region-of-interest (ROI) support.
  • Improved image resizing logic and optimized orientation analysis for better performance.
• Registration:
  • Added a progress bar for volume registration in the asl_template_registration function, providing better user feedback.
  • Refined asl_template_registration to improve normalization process and atlas integration.
• Smoothing: Refactored smoothing functionality into a centralized module (aux_methods.py), improving code organization and consistency, and added robust validation for smoothing parameters.
• Testing Infrastructure:
  • Expanded test coverage significantly, adding comprehensive parameterized tests for ASLData input values, BrainAtlas functionality, registration methods (rigid body, space normalization), and T2Scalar_ASLMapping.
  • Improved error handling tests across various functions.
  • Integrated pytest-mock for enhanced testing capabilities.

Documentation

• Contribution Guidelines: Created a comprehensive Pull Request template to standardize contributions and improve the review process.
• API Documentation: Improved docstrings for key classes and functions, including ASLData constructor, head_movement_correction, BasicReport, and T2Scalar_ASLMapping, to enhance clarity and detail.
• User Guides: Updated documentation for CLI tools and navigation in mkdocs.yml, making it easier to find relevant information.
• Citations: Updated citation information in README and index.rst documentation.

Style / Refactoring

• Code Clean-up: Performed extensive code style improvements and linter fixes across the repository.
• Modularity: Refactored image loading and saving functions, promoting a more modular structure and improving BIDS directory handling.
• Readability: Refactored asl_template_registration for improved readability and overall code structure.
• Naming Conventions: Renamed the transformation_matrix parameter to transforms in the apply_transformation function for better clarity.
• Cleanup: Removed unused files, parameters, and commented-out code to reduce clutter and improve maintainability.

Continuous Integration / DevOps

• Automated Versioning: Introduced a GitHub Actions workflow for automated version bumping and publishing to PyPI using bump2version.
• Workflow Optimization: Streamlined CI workflow names and linting tasks (lint-check) for consistency and efficiency.
• Python Version Support: Optimized CI workflows by updating Python version matrices (testing across 3.9, 3.11, 3.12, and 3.13) to ensure broader compatibility.
• Manual Triggers: Added workflow_dispatch trigger for manual CI runs on the develop branch.
• Dependency Management: Added antspyx and kagglehub to pyproject.toml to support new functionalities.

Miscellaneous

• Added VSCode settings for Python testing configuration to assist developers.

---

For more detailed information, examples, and API specifics, please refer to our full documentation:
Read the Docs

Special Thanks

We extend our sincere gratitude to all contributors who made this release possible:

• Antonio Carlos Senra Filho (@acsenrafilho)
• Copilot (@Copilot)

Your contributions are invaluable to the ASLtk project!

🧠 ASLTK v0.6.0 – Codename: Pulse Peguin

Version: 0.6.0
Release Date: July 31, 2025
Codename: "NeuroAtlas"

We’re excited to announce the release of ASLTK v0.5.0 (Arterial Spin Labeling Toolkit) — a major milestone that brings advanced support for brain atlas integration, multi-echo T2 mapping, and motion correction tools. This version also introduces a more robust testing framework and enhanced CLI documentation.

---

🚀 What’s New

🧠 Brain Atlas Integration

• Introduced a powerful new module for handling brain atlas files in JSON format.

• Bundled atlases include: MNI2009, AICHA2021, FCA7N2011, LGPHCC2022, DKA2006, JHA2005, and more.

• Each atlas includes complete metadata: dataset source URLs, DOIs, region labels, and descriptions.

• A simple and intuitive API for:

  • Listing available atlases
  • Retrieving region metadata
  • Loading atlas label images for pipeline integration

🧪 Multi-TE T2 Mapping (T2Scalar_ASLMapping)

• New implementation of scalar T2 relaxation mapping using multi-echo ASL datasets.

• Key features:

  • Multiprocessing support for fast computation
  • Validation of TE/PLD parameters
  • Configurable smoothing filters
  • Informative logging throughout the T2 fitting process

• Designed to robustly handle invalid inputs and edge cases

🧰 Head Motion Correction

• New utilities for rigid body motion correction of 4D ASL volumes using ANTsPy.

• Includes:

  • Reference volume selection based on mean intensity or SNR
  • Application of transformation matrices to all volumes
  • Internal checks for consistency and validity of transformation operations

---

✅ Robust Test Suite

• Comprehensive test coverage added for:

  • ASLData object creation and manipulation
  • File- and NumPy-based image loading
  • Multi-echo T2 mapping logic
  • Motion correction and transformation functions
  • Brain atlas metadata handling and validation

• Error scenarios and edge cases are fully tested using pytest and pytest-mock

• Structured test modules for easy extension and future contributions

---

🧼 Code Refactoring & Style Improvements

• Cleaned up unused code, deprecated files, and outdated utilities

• Refactored:

  • apply_transformation with improved type validation
  • Smoothing functions moved to centralized aux_methods.py
  • load_image, save_image, calculate_snr, and related utilities modularized

• Enhanced inline documentation, logging, and error messages

• Linting and formatting standardized across the project

---

📚 Documentation Updates

• Restructured MkDocs navigation to reflect new modules and workflows

• Updated sections:

  • Multi-TE T2 Mapping
  • Brain Atlas integration
  • Commit message conventions and contribution guidelines

• Enhanced help messages and usage examples in CLI tools and pyproject.toml entry points

---

⚙️ CI & Development Infrastructure

• GitHub Actions matrix updated to support Python 3.9 – 3.12
• Linting process consolidated under the lint_check task
• Manual triggering of CI workflows enabled for develop branch
• Added VSCode and test configuration files for contributors

---

🙌 Special Thanks

This release wouldn’t have been possible without the contributions and feedback from our growing community. Special thanks to:

• @LOAMRI – for leading the development of the T2 mapping module, motion correction utilities, and extensive test coverage
• @ascenrafilho – for project direction, architecture, brain atlas integration, and core design
• All testers and users who helped identify bugs, suggest features, and improve the library

---

📦 Repository: [github.com/LOAMRI/asltk](https://github.com/LOAMRI/asltk)
🧪 Documentation: (Coming soon with updated tutorials and API references)

🧠 ASLTK v0.5.0 Codename: Echo Eggplant

Release Date: 2025-07-18
Version: 0.5.0
Codename: "Scalar Precision"

We are proud to announce the release of ASLTK v0.5.0, a substantial update packed with major new features, enhancements, bug fixes, refactorings, and improved documentation. This version introduces T2 Scalar Mapping as a core feature, along with vital CLI tooling, documentation improvements, and robust test coverage.

---

🚀 Highlights

✅ New Feature: T2 Scalar Mapping

• New script for T2 mapping using multi-echo ASL datasets: T2Scalar_ASLMapping

• Full support for:

  • Multiple TE and PLD combinations
  • Smoothing options
  • Multiprocessing for faster computation

• Enhanced error handling: Validations for TE/PLD mismatches, smoothing parameters, and input sanity checks

• Robust unit tests: Coverage includes initialization, error handling, and map creation logic

🔧 CLI Enhancements

• New command-line entry points registered in pyproject.toml, enabling easy access to ASLTK tools
• Updated script help messages and usage examples for a smoother developer and end-user experience

---

📄 Documentation Improvements

• Added full documentation for the T2Scalar_ASLMapping script and class
• Navigation improvements in MkDocs for easier access to new and existing features
• Updated contribution guidelines with instructions for GitHub Copilot usage and commit message standards

---

🧪 Testing & Validation

• New tests:

  • Median smoothing (varied kernel sizes, default and invalid parameters)
  • T2 map retrieval logic
  • TE/PLD error scenarios
  • Brain mask handling
  • DW input validation

• Improved testing infrastructure for MultiTE and CBF mapping functionalities

---

🧹 Code Refactor & Maintenance

• Refactored T2Scalar_ASLMapping initialization and processing logic for better readability and maintainability
• Centralized smoothing logic into aux_methods.py to reduce code duplication
• Removed unused imports and outdated TODO comments
• Enhanced logging during T2 map generation for better debugging

---

📦 Versioning

• Updated project version to v0.4.0 in pyproject.toml to reflect major feature addition and refactor depth

---

🙌 Acknowledgments

A huge thank you to everyone who contributed to this release — whether by coding, reviewing, documenting, or testing. In particular, we'd like to highlight:

• @LOAMRI – for significant contributions to the T2 Scalar Mapping implementation and documentation
• All contributors involved in improving testing, refactoring, and documentation clarity

Your dedication makes ASLTK more robust, user-friendly, and scientifically valuable. 💙

---

Want to contribute or follow along? Visit the project documentation

ASLtk Release v0.4.0 Codename: Voxel Vortex

We’re excited to announce a new version of ASLtk, bringing significant improvements in logging, documentation, bug fixes, BIDS support, and testing reliability. This release focuses on enhancing the developer experience, cross-platform compatibility, and maintainability.

🔧 To upgrade to the latest version:

pip install --upgrade asltk

📚 Read the full documentation at: Read the Docs

---

✨ New Features

• BIDS Support:
  Added support for BIDS structure integration, enabling standardized input/output organization.
  Commit: 2243c3e

• Smoothing Filter in Reconstruction:
  Introduced an optional smoothing filter in the reconstruction module for advanced preprocessing.
  Commit: ddd7878

• Default Parameters in Scripts:
  Provided default options for cbf, te_asl, and dw_asl scripts to simplify CLI usage.
  Commit: 1f837b1

---

🐛 Bug Fixes

• Logger Handler Cleanup (Windows):
  Fixed issues with file locking by ensuring logger handlers are properly closed and removed.
  Commit: a13f358

• Robust Logging Configuration Tests:
  Improved test reliability for logging configuration by ensuring correct handler and flushing behavior.
  Commit: d647f67

• Registration Test Assertions:
  Refactored test assertions in the registration module for better clarity and correctness.
  Commit: 8778f8c

• Threshold Fix in Registration Test:
  Adjusted rigid body registration test threshold to enhance test precision.
  Commit: 0cd1e53

---

🔧 Enhancements / Improvements

• Comprehensive Logging System:
  Implemented an extensible and modular logging system to support better debugging and usage tracking.
  Commits: d03e3d4, cc3a87f

• Improved CI Pre-Test Tasks:
  Introduced lint-check in CI pre-test stage for consistent code quality.
  Commit: ba2e87d

• Workflow Examples and Defaults:
  Added workflow examples and clarified default behaviors to guide users effectively.
  Commits: 37b0dc2, f2886de

---

🧹 Style / Refactoring

• Linter and Style Fixes:
  Multiple code formatting adjustments using black and refactoring of string formatting to comply with code standards.
  Commits: 64d0db4, ad20e28, 44a4c72, 9a7ea36, 9bf881a

---

📚 Documentation

• New Logging Documentation:
  Introduced detailed documentation for the new logging system and added it to the navigation.
  Commits: cc3a87f, 6dceeed

• Enhanced Module Documentation:

  • Added detailed examples to utils.py, reconstruction modules, and workflow sections.
  • Included new visual maps for CBF and ATT in documentation.
    Commits: b153503, cadbb0f, 7545f48

• Workflow and Usage Examples:
  Significantly expanded documentation for workflows and CLI usage to assist new users.
  Commit: f2886de

• README Improvements:

  • Added contributor acknowledgments.
  • Included status and issue tracking badges.
    Commits: 72d5a1b, 1af66c8, 7c55004, 6d0b4db

---

⚙️ Continuous Integration / DevOps

• Cross-Platform Code Formatting Checks:
  Updated GitHub Actions workflows to enforce code formatting across all platforms.
  Commits: 88140b6, 246f94c

• CI Workflow Renaming and Streamlining:
  Improved naming conventions and streamlined execution in CI processes.
  Commit: 246f94c

---

🧩 Miscellaneous

• Initial Planning Stubs:
  Placeholder commits were added during the initial planning phase. These have no functional changes.
  Commits: 7a0f3d7, 7ac1f46, bbe6ab5, 65523ae

---

🙌 Special Thanks

A big thank you to the contributors who made this release possible:

• @BDadmehr0 – for contributions to BIDS support and CI enhancements
• @LOAMRI – for ongoing feature development, issue resolution, and leadership
• Everyone involved in code reviews, discussions, and testing 🎉

---

💡 Next Steps:

We continue to work on improving the usability, performance, and interoperability of ASLtk. If you have suggestions or encounter any issues, feel free to open an issue or contribute with a pull request.

ASLtk v0.3.0 Codename: Relaxation Radiance

Release Notes: ASLTK v0.3.0

Overview

Version v0.3.0 introduces several enhancements, bug fixes, and new functionalities to improve the ASLTK library. This release focuses on rigid body registration, head movement correction, and improved support for multi-dimensional ASL data. Additionally, new unit tests, documentation updates, and codebase refinements enhance the library’s reliability and usability.

---

🚀 New Features

Rigid Body Registration & Head Movement Correction

• Implemented rigid body registration and head movement correction for ASL data.
  Commit: 67c4a4f
• Added unit tests for these functions to ensure accuracy and robustness.
  Commit: 24a0d58

Isotropic Gaussian Smoothing

• Implemented an isotropic Gaussian smoothing function for multi-dimensional data.
  Commit: f7719fe
• Added unit tests to validate the function’s behavior.
  Commit: a00685a

Data Handling Enhancements

• Updated set_image method to accept both image paths and numpy arrays, increasing flexibility.
  Commit: 85992f3
• Added collect_data_volumes function to separate 3D volumes from 4D and 5D data.
  Commit: f6aa17c
• Unit tests added for collect_data_volumes to ensure robustness.
  Commit: dd95494

MultiTE ASL Mapping

• Added get_t1blgm_map method to retrieve T1blGM maps from MultiTE_ASLMapping objects.
  Commit: 6613bd0
• Implemented unit tests for get_t1blgm_map to validate its accuracy.
  Commit: 1b8c340

ASL Image Generation

• New script for ASL image generation using the Hadamard MRI imaging acquisition strategy.
  Commit: e6febdd

---

🛠️ Enhancements

• Improved verbosity output for the generate_subtracted_asl_image script.
  Commit: 365033d
• Disabled warnings in pytest for cleaner test output.
  Commit: 73d8cfb
• Reorganized the utils module and introduced a new dynamic_signal module.
  Commit: ebf5728

---

📖 Documentation Updates

• Expanded the documentation with new script sections:
  • generate_subtracted_asl_image script.
    Commit: c2c24b0
  • multi_te ASL script.
    Commit: d189368
  • cbf script.
    Commit: e53a881
• Updated collect_data_volumes documentation to clarify the original shape of the data.
  Commit: 72ee8f8

---

🐛 Bug Fixes

• Fixed import paths for dynamic ASL models in tests and scripts.
  Commits: 5806549, 6a8820b

---

🔧 Codebase Improvements

• Refactored whitespace in test_reconstruction.py for improved readability.
  Commit: 1720b8c
• Updated .gitignore to exclude VSCode configuration files.
  Commit: e5069bc

---

🎉 Special Thanks

A big thank you to our contributors for their valuable work in making ASLTK v0.3.0 a success:

• @acsenrafilho
• @LOAMRI

Your contributions are greatly appreciated! 🚀👏

---

📥 Upgrade Instructions

1. Update ASLTK to v0.3.0:

   pip install asltk --upgrade

2. Check out the updated documentation for guidance on using the new features.

Enjoy the latest version and happy coding! 🎯

ASLtk v0.2.0 Codename: Magneto Marshmallow

Release Notes: Version v0.2.0

Overview

This release introduces several enhancements, bug fixes, and new features, significantly improving the library's functionality and usability. Key updates include added support for BIDS input format, enhancements to data saving/loading methods, and resolution of critical bugs.

---

🚀 New Features

BIDS Input Support

• Added support for loading BIDS-compliant input folders.
  Commit: d34a2db

  • Introduced methods to parse and process imaging data from BIDS folders.
  • Enhanced library dependency with pybids.

• New sample data and README for BIDS format.
  Commit: 0927300

File Format Enhancements

• Improved dw_asl script to include file format options.
  Commit: 03fcf71

• Image file format patterns added in the asltk module.
  Commit: 1f826eb

• Save and load methods added for the ASLData object.
  Commit: 323abf7

Developer Tools

• .vscode added to .gitignore.
  Commit: 877c3c0

• Updates to the poetry.lock file.
  Commit: b2ac1e2

---

🐛 Bug Fixes

Critical Fixes

• Fixed errors in saving compressed NIfTI files.
  Commit: c6401bb, cfc544b
  Issue: #16

• Adjusted doctests and docstrings for improved clarity and accuracy.
  Commit: 345d5e3, 1e73ade

• Fixed usage of temporary folders in tests.
  Commit: 97d4579

---

📝 Documentation Updates

• More information about calling asltk scripts on the Getting Started page.
  Commit: 589e1f0

• Encouraged developers with additional guidance in documentation.
  Commit: 2068a20

---

🛠️ Enhancements

• Reorganized the reconstruction module while maintaining API consistency.
  Commit: dc4cddb

• Progress bar improvements for CBF and MultiTE processing.
  Commit: 248866f

• Removed unnecessary imports in the ASLData module.
  Commit: b7bcaf2

---

🔒 Issues Resolved

• #16: Saving compressed NIfTI files throws an error in cbf.py.
• #13: Added support for BIDS input format.
• #11: Save image data for external sharing/loading.

---

Commit Summary

Commit	Type	Description
8f99849	ENH	New release v0.2.0
97d4579	BUG	Fix test using tmp folder
345d5e3	BUG	Fix docstring line 140 in utils.py
1e73ade	BUG	Fix doctest in utils.py module
0927300	ENH	Add new sample data (BIDS README)
2068a20	DOC	More encouragement for developers
1f826eb	ENH	Add image file format patterns
f04b1a5	ENH	Add pybids as dependency
d34a2db	ENH	Load BIDS input folder
6bef204	ENH	Add more test data (BIDS format)
03fcf71	ENH	Improve dw_asl script file format options
b7bcaf2	ENH	Remove unnecessary imports in ASLData
323abf7	ENH	Add load/save methods for ASLData
589e1f0	DOC	Add script info in Getting Started
dc4cddb	ENH	Reorganize reconstruction module
877c3c0	ENH	Add .vscode in .gitignore
b2ac1e2	ENH	Update poetry lock file
248866f	ENH	Improve progress bar for processing
cfc544b	BUG	Fix save error in multiTE script
c6401bb	BUG	Fix save error in CBF script

---

Contributors

Special thanks to all contributors who helped make this release possible! 🎉

---

Upgrade Instructions

1. Update the package using your package manager of choice.

   pip install asltk --upgrade

2. For detailed usage instructions, check the documentation.

Enjoy this release, and feel free to provide feedback or open issues for suggestions!

v0.1.5

528df2d (HEAD -> main, tag: v0.1.5, origin/main) Update version to v0.1.5

ENH

246bd55 Merge pull request #17 from LOAMRI/develop
74f548a ENH: Increase code coverage (utils module)
a5ad9e7 ENH: Add support for multiprocess CPU thread for MultiTEMapping class
dd49e5d ENH: Add limitation to cores values to avoid multithreading overhead
dc8b8f7 ENH: Add test to avoid overhead of multithreading
cd2608d ENH: Add multiprocess (CPU Threading) for the CBFMapping class
8a34905 ENH: Add test for single core execution (CBF Mapping)
097b463 ENH: Apply multiprocessing for CBF/ATT mapping class

DOC

2c4b105 DOC: Improve documentation at Getting Started section
ee13a9c DOC: Removing the automatic assigment to issue templates

STYLE

a84f18a STYLE: Changed output format to NRRD for cbf.py script