Skip to content

Commit

Permalink
Merge branch 'master' into yamllint
Browse files Browse the repository at this point in the history
  • Loading branch information
wtclarke authored Jan 10, 2023
2 parents 630ab2a + 1e15f95 commit 1fd2383
Show file tree
Hide file tree
Showing 13 changed files with 888 additions and 372 deletions.
4 changes: 2 additions & 2 deletions .github/workflows/push_pr.yml
Original file line number Diff line number Diff line change
Expand Up @@ -12,9 +12,9 @@ jobs:
strategy:
matrix:
os: ["ubuntu-latest"]
python-version: ["3.6", "3.7", "3.8", "3.9", "3.10"]
python-version: ["3.7", "3.8", "3.9", "3.10", "3.11"]
steps:
- uses: actions/checkout@v2
- uses: actions/checkout@v3
with:
submodules: true
lfs: true
Expand Down
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,15 +8,15 @@
Python port of the Matlab mapVBVD tool for reading Siemens raw data 'twix' (.dat) files.

## Installation
`conda install -c conda-forge pymapvbvd`
or
`conda install -c conda-forge pymapvbvd`
or
`pip install pymapvbvd`

## Use

I have attempted to replicate the syntax of the original matlab code, but there are a few differences due to differing variable types.

This package contains a demo Jupyter notebook 'Demo.ipynb' which can be run on the demo data found in tests/test_data. There is unsuppressed water SVS MRS, from both a 7T VB scanner and a VE Prisma. There is also imaging data (3D GRE and EPI) from the [ISMRMRD test dataset](https://doi.org/10.5281/zenodo.33166).
This package contains a demo Jupyter notebook 'Demo.ipynb' which can be run on the demo data found in tests/test_data. There is unsuppressed water SVS MRS, from both a 7T VB scanner and a VE Prisma. There is also imaging data (3D GRE and EPI) from the [ISMRMRD test dataset](https://doi.org/10.5281/zenodo.33166).

Run using the following:
```
Expand All @@ -43,7 +43,7 @@ To retrieve the data in an unsorted format (i.e. Col,Cha,NAcq) use `twixObj.imag

Header information is contained in a dict `twixObj.hdr`
`twixObj.hdr.keys()` provides a list of the data containers.
Access them manually using e.g. `twixObj.hdr['MeasYaps']` or `twixObj.hdr.MeasYaps`.
Access them manually using e.g. `twixObj.hdr['MeasYaps']` or `twixObj.hdr.MeasYaps`.
These objects are in turn a final level of dictionaries. The actual data values can be accessed either manually using tuples of key values e.g.
```
twixObj.hdr.MeasYaps[('sTXSPEC','asNucleusInfo','0','tNucleus')]
Expand Down Expand Up @@ -75,4 +75,4 @@ This code is a port of Philipp Ehses' original Matlab code. I am incredibly grat

More recent thanks to Mo Shahdloo and Aaron Hess for edits.

This port is released under the MIT licence and no credit is sought for its use.
This port is released under the MIT licence and no credit is sought for its use.
2 changes: 1 addition & 1 deletion build_process.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,4 +6,4 @@
5. git clean -fdx
6. python setup.py sdist
7. python setup.py bdist_wheel
8. python -m twine upload dist/*
8. python -m twine upload dist/*
Loading

0 comments on commit 1fd2383

Please sign in to comment.