.. _introduction:

Introduction
============

Welcome to the **hurahura** project documentation!

.. note::

    note: this project was formerly named miresearch

Overview
--------

The **hurahura** project aims to provide a comprehensive platform for organizing and managing medical imaging research projects. It offers tools and utilities to streamline the research process, from data collection and preprocessing to analysis and visualization.

Features
--------

- **Project Organization**: Easily organize your medical imaging research projects, experiments, and datasets in a structured manner.
- **Data Management**: Efficiently manage medical imaging datasets, including storage, retrieval, and preprocessing.
- **Analysis Tools**: Access a variety of tools and algorithms for medical image analysis
- **Visualization**: Visualize medical imaging data and analysis results using interactive visualizations and plots.
- **Collaboration**: Collaborate with colleagues and peers by sharing projects, datasets, and analysis pipelines.
- **Customization**: Customize and extend the platform to suit your specific research needs and workflows.

Getting Started
----------------

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

1. Install the **hurahura** package by running:

   .. code-block:: shell

      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 <https://github.com/fraser29/hurahura>`_

.. 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:

- Issue Tracker: `GitHub Issues <https://github.com/fraser29/hurahura/issues>`_

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