[DOC] Added details of this being a package now.#9
[DOC] Added details of this being a package now.#9mdtisdall wants to merge 1 commit intoMRIMotionCorrection:masterfrom
Conversation
|
Closing this PR since I'm just going to push these changes directly.... |
|
Okay, I'll respect the protection on the code and get a review... |
| # parse_vNav_Motion.py | ||
|
|
||
| This is a small python script to parse DICOM files from a vNav series and convert them into motion scores. The script takes four arguments. The usage and help information below can be generated any time by calling it with the `-h` or `--help` flag. | ||
| This is a small python package that exposes both functions for parsing/interpreting motion in vNavs DICOM files, and an executable that can handle the whole process. To install the package, use `pip install git+https://github.com/MRIMotionCorrection/parse_vNav_Motion#egg=vnav` |
There was a problem hiding this comment.
How do folks feel about registering the package with PyPI, that way users can simply run pip install vnav? And other users could include this package as a dependency.
Looks like the hard work of packaging the repo has been done, and all that's left to do is: python setup.py register
There was a problem hiding this comment.
That's definitely what we're working towards. However, there's still a few more bugs that I think we should fix before we mark it as "released". I'm working on those bugs right now, but I figured I'd like to leave the documentation in a state that matches what's in the repos right now. That way, if I end up not being able to commit fixes for weeks/months, the repos is at least self-consistent.
| author_email='mtisdall@pennmedicine.upenn.edu', | ||
| license='MIT', | ||
| packages=['vnav'], | ||
| install_requires=['pydicom', 'numpy']) |
There was a problem hiding this comment.
Now that setup.py handles the dependencies, The readme can be updated to something like:
## Dependencies
The script depends on the pydicom and numpy packages. These will be installed automatically when `pip install` is run
2 participants
Minor documentation updates.