Skip to content

Commit

Permalink
Add more information about pydicom purpose (#1709)
Browse files Browse the repository at this point in the history
* Add more information about pydicom purpose

- slightly adapt the issue templates
  • Loading branch information
mrbean-bremen committed Oct 8, 2022
1 parent 803fc57 commit 16fd77d
Show file tree
Hide file tree
Showing 4 changed files with 28 additions and 20 deletions.
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: ''

---
27 changes: 22 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,11 +9,23 @@

# *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. In order to keep the
project manageable, it does not handle the specifics of individual SOP classes
or other aspects of DICOM. 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.

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 +122,12 @@ 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).

0 comments on commit 16fd77d

Please sign in to comment.