Introduction

Welcome to the hurahura project documentation!

Note

note: this project was formerly named miresearch

Overview

The hurahura project aims to provide a comprehensive framework for organising and managing medical imaging research projects. It offers tools and utilities to standardise storage, organisation, logging and automation of typical tasks in medical imaging research.

Features

  • Project Organisation: Easily organise your medical imaging research projects, experiments, and datasets in a structured manner.

    • Tools for loading new datasets, including automated via a watch directory feature.

    • Tools for querying and summarising data.

    • hurahura relies on the DICOM standard for data organisation and retrieval.

  • Data Management: Efficiently manage medical imaging datasets.

    • Tools for anonymising data.

    • Tools for logging data.

    • Tools for summarising data.

    • Tools for querying data.

  • Extendable: hurahura aims to provide a standard framework that is intended to be extended for a range of specialised tasks.

    • Example: A subclass may be created to handle a specific type of data, such as a particular type of imaging modality or a particular type of analysis.

  • User Friendly: hurahura aims to provide a user friendly interface for data management and querying.

    • No database is employed - all data is stored in a simple directory structure.

    • A web interface is provided for easy management of subjects and data.

Getting Started

To get started with hurahura, you can follow these steps:

  1. Install the hurahura package by running:

    pip install hurahura

  2. Explore the documentation to learn about the project’s features, usage, and API reference.

  3. Check out the tutorials and examples to see hurahura in action.

Contributing

Contributions to the hurahura project are welcome! If you encounter any issues, have suggestions for improvements, or would like to contribute code, please visit the project repository on GitHub:

hurahura GitHub Repository

Note

Please review the contribution guidelines and code of conduct before contributing to the project.

Feedback

We value your feedback! If you have any questions, comments, or feedback regarding the hurahura project, please don’t hesitate to reach out to us:

Thank you for using hurahura for your medical imaging research projects!