Atlas - Donor Search Algorithm As a Service

Atlas is licensed under the GNU GPL-v3.0 (or later) license. For details see the license file.

There are several HLA matching algorithms in use worldwide, but Atlas is unique in being the only one that is free to use and open source. It uses cutting-edge cloud technology to implement the latest agreed-upon clinical guidelines for unrelated, hematopoietic stem cell donor matching and selection. It is based on Anthony Nolan’s own donor search algorithm and has been further enhanced for use in WMDA's Search & Match Service for the benefit of the global, stem cell transplant community.

Documentation & Support

• The specifications page lists the current features of Atlas.
• This repository has extensive README documentation mainly aimed at developers and support agents.
• If you have questions about Atlas - technical or otherwise - please browse the Q&A section of the Discussions board, and feel free to post your own questions.
• If you wish to be updated on changes to Atlas, please subscribe to the repo and consult the Atlas Changelogs.
• Atlas is an open-source project and we welcome feedback, ideas, and contributions.
  • If you wish to report an issue, such as a bug or an enhancement request, please use the Issues board.
  • Use the search tool to see if your issue has already been created.
  • If not, submit a New Issue, ideally, using the templates provided.
  • Submitted issues will be triaged according to criticality, priority, and business value, as appropriate, and updates will be posted via the issue comments section.
  • If you are a developer and wish to contribute to the project, please consult the Contribution and Versioning README.

README Index

Due to the size and complexity of the project, the README has been split into various small chunks. Other READMEs have been linked to where appropriate, but here is a comprehensive list:

• Landing Page README (You Are Here)

• Atlas Specifications

• Guides for developers working on Atlas

  • Architectural Overview
  • Development Start Up Guide ("Zero To Hero")
  • Development Settings
  • Contribution and Versioning
  • Test and Debug Resources
  • Manual Testing

• Guides for the installation, setup, and support of the deployed ATLAS system

  • Deployment - deploying the resources needed to run Atlas
  • Configuration - configuring resources / settings of Atlas to fine tune your installation
  • Integration - processing reference data, and integrating your non-Atlas systems into Atlas
  • Support - resources for assisting with any issues when running an installation of Atlas
  • Maintenance - guide to how to keep Atlas up-to-date and in-sync with external data sources

• Component READMEs

  • Donor Import
  • HLA Metadata Dictionary
  • Matching Algorithm
    • Matching Algorithm Validation Test Suite (i.e., non-Technical BDD Testing)
  • Match Prediction Algorithm
  • MAC Dictionary
  • Repeat Search

CHANGELOG Index

API changelogs

• Atlas Product
• Public API Client
• Matching Algorithm Client
• Donor Import File Schema

Database Changelogs

• Matching - Persistent
• Matching - Transient
• Match Prediction
• Repeat Search
• Donors