Science Score: 44.0%
This score indicates how likely this project is to be science-related based on various indicators:
-
✓CITATION.cff file
Found CITATION.cff file -
✓codemeta.json file
Found codemeta.json file -
✓.zenodo.json file
Found .zenodo.json file -
○DOI references
-
○Academic publication links
-
○Academic email domains
-
○Institutional organization owner
-
○JOSS paper metadata
-
○Scientific vocabulary similarity
Low similarity (10.8%) to scientific vocabulary
Repository
Basic Info
- Host: GitHub
- Owner: rserial
- License: mit
- Language: HTML
- Default Branch: main
- Size: 7.85 MB
Statistics
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 11
- Releases: 0
Metadata Files
README.md
process-3T-MRI-data: the MRIMate library
This is a Python library for processing par/rec MRI data. So far it is specific to the V-10 3T Philips scanner.
Features
- Process par/rec MRI data into spin density and/or phase/velocity images.
- Access experiment parameters, check units/information, etc. I still need to finish updating the definition of the different parameters.
- Data can be exported to hdf5 (still need to test if the h5 was written correctly).
- Processed data can be plotted. For now only 2D or MS experiments.
Quickstart
A Linux distribution is required. For windows users we reccomend following the wiki guide on how to install a Windows Linux Subsystem.
Create a Virtual Environment: you can use
venvorpoetryfor example.venvis a bit easier to use in my opinion.python cd your_project_directory python3 -m venv myenv source myenv/bin/activateInstall packages within the virtual environment usingpip. Deactivate the environment when finished:python deactivateIntegrate with Jupyter Notebook in VSCode: Install
ipykerneland load the environment to the notebook.python pip install ipykernel python -m ipykernel install --user --name=myenv --display-name "Python (myenv)”Install the MRIMate library
pip install git+https://collaborating.tuhh.de/v-10/private/data-evaluation/MRImate.gitCheck the quick demo notebook to learn how to use it.
Credits
Raquel - raquel.serial@tuhh.de This package was created with Cookiecutter and the fedejaure/cookiecutter-modern-pypackage project template.
Owner
- Name: Raquel Serial
- Login: rserial
- Kind: user
- Location: Hamburg
- Repositories: 1
- Profile: https://github.com/rserial
MRI scientist
Citation (CITATION.cff)
# This CITATION.cff file was generated with cffinit.
# Visit https://bit.ly/cffinit to generate yours today!
cff-version: 1.2.0
title: MRI Mate
message: >-
If you use this software, please cite it using the
metadata from this file.
type: software
authors:
- given-names: Raquel
family-names: Serial
alias: fedejaure
identifiers:
- type: url
value: >-
https://github.com/rserial/MRIMate/releases/tag/v0.1.0
description: The Software Heritage link for version 0.1.0.
repository-code: 'https://github.com/rserial/MRIMate'
abstract: Cookiecutter template for a modern Python package.
keywords:
- MRIMate
license: MIT
version: 0.1.0
GitHub Events
Total
- Push event: 1
Last Year
- Push event: 1
Dependencies
- bump2version ^1.0.1 develop
- invoke ^2.2.0 develop
- pre-commit ^3.6.1 develop
- watchdog ^4.0.0 develop
- recommonmark ^0.7.1 docs
- sphinx ^7.2.6 docs
- black ^24.2.0 linters
- isort ^5.13.2 linters
- ruff ^0.2.1 linters
- python <3.13,>=3.9
- typer ^0.9.0
- safety ^3.0.1 security
- coverage ^7.4.1 test
- pytest ^8.0.1 test
- pytest-cov ^4.1.0 test
- xdoctest ^1.1.3 test
- mypy ^1.8.0 typing
- actions/checkout v4.1.1 composite
- github/codeql-action/analyze v3 composite
- github/codeql-action/autobuild v3 composite
- github/codeql-action/init v3 composite
- actions/checkout v4.1.1 composite
- actions/setup-python v5.0.0 composite
- peter-evans/create-pull-request v6.0.0 composite
- actions/checkout v4.1.1 composite
- actions/create-release v1.1.4 composite
- actions/setup-python v5.0.0 composite
- mindsers/changelog-reader-action v2.2.2 composite
- pypa/gh-action-pypi-publish v1.8.11 composite
- actions/checkout v4.1.1 composite
- actions/download-artifact v4 composite
- actions/setup-python v5.0.0 composite
- actions/upload-artifact v4 composite
- codecov/codecov-action v3.1.4 composite
- recommonmark ==0.7.1
- sphinx ==7.2.6
- alabaster 0.7.16
- authlib 1.3.0
- babel 2.14.0
- black 24.2.0
- bump2version 1.0.1
- certifi 2024.2.2
- cffi 1.16.0
- cfgv 3.4.0
- charset-normalizer 3.3.2
- click 8.1.7
- colorama 0.4.6
- commonmark 0.9.1
- coverage 7.4.1
- cryptography 42.0.3
- distlib 0.3.8
- docutils 0.20.1
- dparse 0.6.4b0
- exceptiongroup 1.2.0
- filelock 3.13.1
- identify 2.5.34
- idna 3.6
- imagesize 1.4.1
- importlib-metadata 7.0.1
- iniconfig 2.0.0
- invoke 2.2.0
- isort 5.13.2
- jinja2 3.1.3
- markdown-it-py 3.0.0
- markupsafe 2.1.5
- marshmallow 3.20.2
- mdurl 0.1.2
- mypy 1.8.0
- mypy-extensions 1.0.0
- nodeenv 1.8.0
- packaging 23.2
- pathspec 0.12.1
- platformdirs 4.2.0
- pluggy 1.4.0
- pre-commit 3.6.1
- pycparser 2.21
- pydantic 1.10.14
- pygments 2.17.2
- pytest 8.0.1
- pytest-cov 4.1.0
- pyyaml 6.0.1
- recommonmark 0.7.1
- requests 2.31.0
- rich 13.7.0
- ruamel-yaml 0.18.6
- ruamel-yaml-clib 0.2.8
- ruff 0.2.2
- safety 3.0.1
- safety-schemas 0.0.2
- setuptools 69.1.0
- shellingham 1.5.4
- snowballstemmer 2.2.0
- sphinx 7.2.6
- sphinxcontrib-applehelp 1.0.8
- sphinxcontrib-devhelp 1.0.6
- sphinxcontrib-htmlhelp 2.0.5
- sphinxcontrib-jsmath 1.0.1
- sphinxcontrib-qthelp 1.0.7
- sphinxcontrib-serializinghtml 1.1.10
- tomli 2.0.1
- typer 0.9.0
- typing-extensions 4.9.0
- urllib3 2.2.1
- virtualenv 20.25.0
- watchdog 4.0.0
- xdoctest 1.1.3
- zipp 3.17.0