v1.1.0

📦 Release: v1.1.0 – Harmonisation improvements & License Security Update

Release date: April 24, 2026

This is an bug fixes release that resolves issues identified in the harmonisation process. The harmonisation parameters and workflow have been revised to exclude the group covariate (control vs. patient), to improve the plots against the normative growth curves.
Also this release increase the level of security to use the AID-HS package by introducing a mandatory registration.
No breaking changes have been introduced.

---

🔧 Bug fixes

• 🧠 Harmonisation Parameters Updated
  The harmonisation parameters and process using ComBat have been updated to exclude the group covariate (control vs. patient). This change was made in response to user feedback indicating that including both patients and controls when computing harmonisation parameters could lead to inaccuracies in the harmonised features plotted against normative curves.

• ✅ Other minor issues fixed: fix the RAS orientation in PDF segmentations plot (PR #16), fix the subject ids in the hippunfold parallelised call (PR #14), enable parsing custom demographics_file.csv

📝 New Features

• 📥 Change in Data Downloading
  The AID-HS data folder is now download from GIthub, as Figshare the platform hosting the AID-HS model parameters results in failures during the automated downloading of the parameters.

• 🔐 License & Registration Requirement
  A new security layer has been implemented: AID-HS now requires a license file to run. Users must register to receive their license. This change helps us maintain responsible distribution, ensure compliance, and support communication about bug fix and new release.

• 📚 Updated documentation
  Update installation instruction with automated downloading of data, update contact details, clarify FAQ

• 🧹 Minor code cleanup for improved stability and maintainability

---

Instructions to use AID-HS v1.1.0

REGISTER TO GET YOUR AID-HS LICENSE: We request that all AID-HS users fill the AID-HS registration form. Following registration you will received a license file. This file will be needed for use of all future AID-HS versions v1.1.0 and above. Your email address will be added to the AID-HS mailing list. This will ensure that we can update you about bugs fix and new releases.

New users ➡️ please follow the instructions on the README

Existing users ➡️ please follow the guidelines Updating AID-HS to V1.1.0 in our FAQ, to update your code and recompute the harmonisation parameters.

v1.0.1

📦 Release: v1.0.1 – Bug Fixes & Compatibility Improvements

Release date: May 2, 2025

This is a bug fix release that addresses issues found in v1.0.0 and improves compatibility and usability. No breaking changes have been introduced.

---

🔧 Bug Fixes

• ✅ Radiological visualisation of left and right hippocampi segmentation
  Fixed an issue in the visualisation of left and right hippocampi segmentation on the PDF report. The segmentation were not visualised in radiological view

  Please see instructions below to recompute the PDF reports for patients already ran through AID-HS

• 🧠 Harmonisation Input Handling
  Removed the requirement to specify scanner strength in demographics_file.csv for harmonisation. This resolves errors when scanner strength wasn’t 3T

  ✅ Still fully compatible with older files that include scanner strength and old harmonisation files.

• 📚 Updated documentation based on users feedback
  Instructions for use of Docker Desktop, Instructions to join the mailing list; Clarification on FAQ

• 🧹 Minor code cleanup for improved stability and maintainability

---

Instructions to use AID-HS v1.0.1

SIGN UP TO THE AID-HS MAILING LIST: we request that all AID-HS users sign up the AID-HS mailing list. Please send an email to meld.study@gmail.com with the subject "Request to be added to the AID-HS mailing list" and provide us with your name and institute. This will ensure that we can update you about bug fixes and new releases.

New users ➡️ please follow the instructions on the README

Existing users ➡️ please follow the guidelines Updating AID-HS to V1.0.1 in our FAQ, to update your code and fix the visualisation of the segmentation on your PDF reports

aidhs_data

📦 Release: data folder needed to run AID HS

Release date: April 23, 2026

🔧 This release offers an alternative way to download the AID-HS data, as Figshare the platform hosting the AID-HS model parameters results in failures during the automated downloading of the parameters.

---

Notes on the folders

• input: contains the input scans for each subject you want to run with AID-HS
• params: contains the parameters needed by AID-HS for the preprocessing of the data
• models: contains the AID-HS logistic regression model
• output: contains the inputs data formatted in BIDS for compatibility with HippUnfold (bids_outputs), outputs from the HippUnfold segmentation , contains the outputs from the HippUnfold segmentation (hippunfold_outputs), the output of the preprocessing of surface-based features (preprocessed_surf_data), the final interpretable report produced by the AID-HS tool (predictions_reports)

Notes on the test data

DO NOT run AID-HS on sub-test001
The input folder contain test data to run "pytest", the command that test if AID-HS is correctly installed. The test subject provided sub-test001 is given as an example of how to organised your data. The nifti files contained in this folder are empty. Therefore if you run AID-HS on this subject, it will fail.

More information

For more information on how to prepare your data to run AID-HS, look at the "Prepare the data" guidelines

For more information on how to run AID-HS on a subject, look at "Detect and lateralize HS on MRI data" guidelines

For more information on how to interpret the output of AID-HS look at "Interpretation of the AID-HS results" guidelines

V1.0.0

Initial release of the AID-HS package

Docker version

• Compatible with Linux and Mac
• Not tested on windows