| Name | hurahura JSON |
| Version |
0.1.28
JSON |
| download |
| home_page | None |
| Summary | Medical Imaging Research structuring and automation |
| upload_time | 2025-08-27 07:50:10 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.9.0 |
| license | MIT |
| keywords |
ct
dicom
imaging
medical
mri
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# hurahura - formerly miresearch
Organisation and automation tools for medical imaging research data
__hurahura__ is māori for "to investigate" or "to look around"
## Installation:
```bash
pip install hurahura
# formerly: pip install imaging-research
```
## About
This is a collection of classes for following OOP principles for organisation of research data for medical imaging research studies.
The intention is to provide a framework that will store imaging data on a "per __examination__" basis in a structured format. This structured format then permits simple interrogation, and automation.
It takes advantage of the dicom standard and the package [spydcmtk](https://pypi.org/project/spydcmtk/) for automating and generalising many typical steps with the intention of making the researcher's life easier.
This package may be easily adapted and expanded upon for a high level control over your research data. Or, it may be used as is for basic structure and organisation of data and automation of common tasks.
## Class structure
**AbstractSubject** class is top level class taking inputs:
- *subjectNumber* : an integer
- *dataRoot* : the root directory where subjects to be stored
- *subjectPrefix* : a prefix to be combined with *subjectNumber* for naming each subject
- Optional: will be guessed from subjects already present in *dataRoot* if not given.
- *DIRECTORY_STRUCTURE_TREE* : DirectoryStructureTree class to define directory structure for each subject directory (see wiki for construction shortcuts)
- Optional: Defaults to **RAW** and **META** directories.
This is the basic parent class containing fundamental methods for organisation and management. See [hurahura docs](https://fraser29.github.io/hurahura/) for advanced usage, epsecially via inheritance and polymorphism.
## Configuration
hurahura uses a miresearch.conf file for configuration.
By default miresearch.conf files are search for in the following locations:
1. source_code_directory/miresearch.conf (file with default settings)
2. $HOME/miresearch.conf
3. $HOME/.miresearch.conf
4. $HOME/.config/miresearch.conf
5. Full file path defined at environment variable: "MIRESEARCH_CONF"
6. Full path passed as commandline argument to `hurahura`
Files are read in the above order with each subsequent variable present overwritting any previously defined.
For information on files found and variables used run:
`hurahura -INFO`
## File system watcher
hurahura can watch a directory for new subjects and load them into the system. This works nicely with [AUTORTHANC](https://github.com/fraser29/autorthanc)
```bash
hurahura -WatchDirectory /path/to/watch_directory
```
## UI
hurahura can be run with a UI for easy management of subjects and data.
```bash
hurahura -UI
```
# Documentation
For full documentation see [hurahura docs](https://fraser29.github.io/hurahura/)
Raw data
{
"_id": null,
"home_page": null,
"name": "hurahura",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9.0",
"maintainer_email": null,
"keywords": "ct, dicom, imaging, medical, mri",
"author": null,
"author_email": "\"Fraser M. Callaghan\" <callaghan.fm@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/9c/89/ee368aadf9ca73521315f546232551c54fbe26d70bae604c7491f1d02012/hurahura-0.1.28.tar.gz",
"platform": null,
"description": "# hurahura - formerly miresearch\n\nOrganisation and automation tools for medical imaging research data\n\n__hurahura__ is m\u0101ori for \"to investigate\" or \"to look around\"\n\n## Installation: \n\n```bash\npip install hurahura\n# formerly: pip install imaging-research\n\n```\n\n## About\n\nThis is a collection of classes for following OOP principles for organisation of research data for medical imaging research studies. \n\nThe intention is to provide a framework that will store imaging data on a \"per __examination__\" basis in a structured format. This structured format then permits simple interrogation, and automation. \n\nIt takes advantage of the dicom standard and the package [spydcmtk](https://pypi.org/project/spydcmtk/) for automating and generalising many typical steps with the intention of making the researcher's life easier. \n\nThis package may be easily adapted and expanded upon for a high level control over your research data. Or, it may be used as is for basic structure and organisation of data and automation of common tasks. \n\n\n## Class structure\n\n**AbstractSubject** class is top level class taking inputs:\n- *subjectNumber* : an integer\n- *dataRoot* : the root directory where subjects to be stored \n- *subjectPrefix* : a prefix to be combined with *subjectNumber* for naming each subject\n - Optional: will be guessed from subjects already present in *dataRoot* if not given. \n- *DIRECTORY_STRUCTURE_TREE* : DirectoryStructureTree class to define directory structure for each subject directory (see wiki for construction shortcuts)\n - Optional: Defaults to **RAW** and **META** directories. \n\nThis is the basic parent class containing fundamental methods for organisation and management. See [hurahura docs](https://fraser29.github.io/hurahura/) for advanced usage, epsecially via inheritance and polymorphism. \n\n\n## Configuration\n\nhurahura uses a miresearch.conf file for configuration. \n\nBy default miresearch.conf files are search for in the following locations: \n\n1. source_code_directory/miresearch.conf (file with default settings)\n2. $HOME/miresearch.conf\n3. $HOME/.miresearch.conf\n4. $HOME/.config/miresearch.conf\n5. Full file path defined at environment variable: \"MIRESEARCH_CONF\"\n6. Full path passed as commandline argument to `hurahura`\n\nFiles are read in the above order with each subsequent variable present overwritting any previously defined. \nFor information on files found and variables used run:\n\n`hurahura -INFO` \n\n## File system watcher\n\nhurahura can watch a directory for new subjects and load them into the system. This works nicely with [AUTORTHANC](https://github.com/fraser29/autorthanc)\n\n```bash\nhurahura -WatchDirectory /path/to/watch_directory\n```\n\n## UI\n\nhurahura can be run with a UI for easy management of subjects and data. \n\n```bash\nhurahura -UI\n```\n\n# Documentation\n\nFor full documentation see [hurahura docs](https://fraser29.github.io/hurahura/)",
"bugtrack_url": null,
"license": "MIT",
"summary": "Medical Imaging Research structuring and automation",
"version": "0.1.28",
"project_urls": {
"Homepage": "https://github.com/fraser29/hurahura"
},
"split_keywords": [
"ct",
" dicom",
" imaging",
" medical",
" mri"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "b15e6054cad04c7f796af5d3f2bea2e371fa66cfa63f03110f867337b5da7dc8",
"md5": "e3ad8e6dfd909d787b38d0b42e3ccabd",
"sha256": "4efec2b7a0639a7716c41b1c4fec71607254ee6d1bd69e48a3c8ff23cc2e5908"
},
"downloads": -1,
"filename": "hurahura-0.1.28-py3-none-any.whl",
"has_sig": false,
"md5_digest": "e3ad8e6dfd909d787b38d0b42e3ccabd",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9.0",
"size": 56764,
"upload_time": "2025-08-27T07:50:08",
"upload_time_iso_8601": "2025-08-27T07:50:08.822071Z",
"url": "https://files.pythonhosted.org/packages/b1/5e/6054cad04c7f796af5d3f2bea2e371fa66cfa63f03110f867337b5da7dc8/hurahura-0.1.28-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "9c89ee368aadf9ca73521315f546232551c54fbe26d70bae604c7491f1d02012",
"md5": "1ffab9aa4b339245e441218fe5bf3cc2",
"sha256": "4fae03f42d7c8bce83a1ed35f43859679531290727d8cbbf08bc7ffef95f1bdc"
},
"downloads": -1,
"filename": "hurahura-0.1.28.tar.gz",
"has_sig": false,
"md5_digest": "1ffab9aa4b339245e441218fe5bf3cc2",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9.0",
"size": 51971,
"upload_time": "2025-08-27T07:50:10",
"upload_time_iso_8601": "2025-08-27T07:50:10.315890Z",
"url": "https://files.pythonhosted.org/packages/9c/89/ee368aadf9ca73521315f546232551c54fbe26d70bae604c7491f1d02012/hurahura-0.1.28.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-08-27 07:50:10",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "fraser29",
"github_project": "hurahura",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "hurahura"
}
