Skip to content
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

Merged
merged 2 commits into from
Oct 8, 2022
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
14 changes: 2 additions & 12 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,19 +19,9 @@ How to reproduce the issue. Please include a minimum working code sample, the
traceback (if any) and the anonymized DICOM dataset (if relevant).

**Your environment**
If you're using **pydicom 2 or later**, please use the `pydicom.env_info`
module to gather information about your environment and paste it in the issue:
Please use the `pydicom.env_info` module (available in **pydicom 2 or later**)
to gather information about your environment and paste it into the issue:

```bash
$ python -m pydicom.env_info
```

For **pydicom 1.x**, please run the following code snippet and paste the
output.

```python
import platform, sys, pydicom
print(platform.platform(),
"\nPython", sys.version,
"\npydicom", pydicom.__version__)
```
2 changes: 2 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,8 @@ assignees: ''

**Is your feature request related to a problem? Please describe.**
A clear and concise description of what the problem is. Example: I'm always frustrated when [...]
Please take into account that *pydicom* is a general-purpose framework and
does not handle the specifics of individual SOP classes.

**Describe the solution you'd like**
A clear and concise description of what you want to happen.
5 changes: 2 additions & 3 deletions .github/ISSUE_TEMPLATE/other_issues.md
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: ''

---
31 changes: 26 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Copy link
Member

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'.

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.
Copy link
Member Author

Choose a reason for hiding this comment

The 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

Expand Down Expand Up @@ -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.
Copy link
Member Author

Choose a reason for hiding this comment

The 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.

Copy link
Member

Choose a reason for hiding this comment

The 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.