-
-
Notifications
You must be signed in to change notification settings - Fork 471
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
[MRG] Add more information about pydicom purpose #1709
Changes from 1 commit
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,8 +1,7 @@ | ||
--- | ||
name: Other issues | ||
about: For all other issues (help needed, general query, discussion, etc). | ||
about: For all other issues. Please consider creating a discussion item | ||
instead if you have a question, an idea, or a general discussion item. | ||
title: '' | ||
labels: question | ||
assignees: '' | ||
|
||
--- |
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -9,11 +9,22 @@ | |
|
||
# *pydicom* | ||
|
||
*pydicom* is a pure Python package for working with [DICOM](https://www.dicomstandard.org/) files. It lets you read, modify and write DICOM data in an easy "pythonic" way. | ||
*pydicom* is a pure Python package for working with [DICOM](https://www.dicomstandard.org/) files. | ||
It lets you read, modify and write DICOM data in an easy "pythonic" way. As a pure Python package, | ||
*pydicom* can run anywhere Python runs without any other requirements, although if you're working | ||
with *Pixel Data* then we recommend you also install [NumPy](http://www.numpy.org). | ||
|
||
As a pure Python package, *pydicom* can run anywhere Python runs without any other requirements, although if you're working with *Pixel Data* then we recommend you also install [NumPy](http://www.numpy.org). | ||
Note that *pydicom* is a general-purpose DICOM framework concerned with | ||
reading and writing DICOM datasets, and does not handle the specifics | ||
of individual SOP classes or other aspects of DICOM on purpose. Other | ||
libraries both inside and outside the [pydicom organization](https://github.com/pydicom) | ||
are based on *pydicom* and provide support for other aspects of DICOM, and for more | ||
specific applications. | ||
|
||
Examples are [pynetdicom](https://github.com/pydicom/pynetdicom), which | ||
is a Python library for DICOM networking, and [deid](https://github.com/pydicom/deid), | ||
which supports the anonymization of DICOM files. | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I added linebreaks to avoid too much horizontal scrolling, these are ignored. |
||
|
||
If you're looking for a Python library for DICOM networking then you might be interested in another of our projects: [pynetdicom](https://github.com/pydicom/pynetdicom). | ||
|
||
## Installation | ||
|
||
|
@@ -110,7 +121,17 @@ plt.show() | |
|
||
## Contributing | ||
|
||
To contribute to *pydicom*, read our [contribution guide](https://github.com/pydicom/pydicom/blob/master/CONTRIBUTING.md). | ||
We are all volunteers working on *pydicom* in our free time. As our | ||
resources are limited, we very much value your contributions, be it bug fixes, new | ||
core features, or documentation improvements. For more information, please | ||
read our [contribution guide](https://github.com/pydicom/pydicom/blob/master/CONTRIBUTING.md). | ||
|
||
To contribute an example or extension of *pydicom* that doesn't belong with the core software, see our contribution repository: | ||
If you have examples or extensions of *pydicom* that don't belong with the | ||
core software, but that you deem useful to others, you can add them to our | ||
contribution repository: | ||
[contrib-pydicom](https://www.github.com/pydicom/contrib-pydicom). | ||
|
||
If you have a software package based on *pydicom* that you want to be more | ||
tightly integrated into the *pydicom* ecosystem, you may consider to apply | ||
for transferring it into the *pydicom* organization. You can do so by creating | ||
a general discussion item with a short description of the module. | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I'm not sure about this - I also wanted to document the basic reqiurements for such a transfer somewhere else, but first wanted to know if we want to add this at all. There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I am also not sure about this - I think by adding projects to the pydicom organization, we are essentially endorsing certain libraries over others. The only benefit is to users, in helping them find libraries they might not otherwise have known about. I'd suggest we leave this out for now, and leave it to the pydicom owners to offer a move to the organization, in cases where a clear 'winner' exists that people should know about, that doesn't already have a strong management team under its own organization / individual account. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The "on purpose" here sounds a bit odd to me. Perhaps needs more explanation, like '...or other aspects of DICOM, in order to keep the project manageable'.