Skip to content

Commit

Permalink
Improve overall documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
gacou54 committed Jan 16, 2025
1 parent a610c8d commit 8631f78
Show file tree
Hide file tree
Showing 3 changed files with 31 additions and 3 deletions.
13 changes: 13 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,19 @@
- Helper functions for working with DICOM data
- Integration with the [Orthanc Python plugin](https://orthanc.uclouvain.be/book/plugins/python.html)


## Why PyOrthanc?
PyOrthanc makes it easy to work with DICOM medical images stored on Orthanc servers using Python - instead
of dealing with the DICOM protocol directly or creating complex code to interact with Orthanc's REST API.

Researchers and clinicians can make simple Python script to access and manage their medical imaging data.

Advanced users can use PyOrthanc to make Orthanc query a hospital PACS (Picture Archiving and Communication System).
This allows to find and retrieve images produced in the clinic for research or quality control purposes.
Additionally, since PyOrthanc simplifies Orthanc's anonymization operations,
an entire medical image management workflow can be implemented in Python.


## Quick Install
```bash
pip install pyorthanc # Basic installation
Expand Down
11 changes: 11 additions & 0 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,17 @@
- Helper functions for working with DICOM data
- Integration with the Orthanc Python plugin

## Why PyOrthanc?
PyOrthanc makes it easy to work with DICOM medical images stored on Orthanc servers using Python - instead
of dealing with the DICOM protocol directly or creating complex code to interact with Orthanc's REST API.

Researchers and clinicians can make simple Python script to access and manage their medical imaging data.

Advanced users can use PyOrthanc to make Orthanc query a hospital PACS (Picture Archiving and Communication System).
This allows to find and retrieve images produced in the clinic for research or quality control purposes.
Additionally, since PyOrthanc simplifies Orthanc's anonymization operations,
an entire medical image management workflow can be implemented in Python.

## Quick Install

```bash
Expand Down
10 changes: 7 additions & 3 deletions docs/tutorial/quickstart.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,14 @@
# First steps

## Orthanc installation
For testing purposes, you can use
For testing purposes, you can use one of this solution to install Orthanc
- Orthanc's demo server (https://orthanc.uclouvain.be/demo)
- Or deploy it locally with docker using `docker run -p 8042:8042 -p 4242:4242 orthancteam/orthanc`
- Other method to install Orthanc are available [here](https://www.orthanc-server.com/download.php)
- Deploy it locally with docker using `docker run -p 8042:8042 -p 4242:4242 orthancteam/orthanc`
- Using the docker-compose from the pyorthanc repo to ha
1. For this, clone the repo (`git clone https://github.com/gacou54/pyorthanc`)
2. Got in the repo (`cd pyorthanc`)
3. Start orthanc (`docker compose up orthanc1`)
- Other method to install Orthanc are available [here](https://www.orthanc-server.com/download.php)

## PyOrthanc installation
```bash
Expand Down

0 comments on commit 8631f78

Please sign in to comment.