orthanc-book
This is a read-only mirror of https://hg.orthanc-server.com/orthanc-book/
Science Score: 44.0%
This score indicates how likely this project is to be science-related based on various indicators:
-
✓CITATION.cff file
Found CITATION.cff file -
✓codemeta.json file
Found codemeta.json file -
✓.zenodo.json file
Found .zenodo.json file -
○DOI references
-
○Academic publication links
-
○Academic email domains
-
○Institutional organization owner
-
○JOSS paper metadata
-
○Scientific vocabulary similarity
Low similarity (12.7%) to scientific vocabulary
Repository
This is a read-only mirror of https://hg.orthanc-server.com/orthanc-book/
Basic Info
Statistics
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
- Releases: 0
Metadata Files
README.md
General information
Orthanc is a lightweight, RESTful Vendor Neutral Archive for DICOM. General information about Orthanc can be found on its official Website.
This repository contains the source code of the Orthanc Book, that documents how Orthanc can be used. It also contains the source code of the documentation of the REST API of Orthanc. The continuous integration server (CIS) of Orthanc watches this repository, and automatically publishes modifications online.
Orthanc Book
Setup
To build the Orthanc Book from sources, you need to install Sphinx, the Python Documentation Generator.
Installing Sphinx under Ubuntu 14.04 LTS
# sudo pip install sphinx sphinx_bootstrap_theme
Generating the Book
Under Linux
# cd ./Sphinx
# make html
The HTML documentation will be available in the folder
./build/html. You can for instance open it using Mozilla Firefox as
follows:
# firefox ./build/html/index.html
Contributing to the Book
- Make sure to understand the reStructuredText file format.
- Fork this repository onto your BitBucket account.
- Edit the content of the
./Sphinx/source/folder. - Generate locally the Orthanc Book (cf. above), and make sure it displays properly on your computer.
- Submit a pull request for review by the Orthanc project.
- Once the pull request is reviewed and accepted, the continuous integration server of the Orthanc project will automatically publish the new version online.
REST API of Orthanc
The REST API of Orthanc is now fully documented in the source code of
the Orthanc
server.
The --openapi= and the --cheatsheet= command-line options of
Orthanc automatically generate respectively the OpenAPI in JSON
format and its quick reference
(cheatsheet)
in CSV format that is designed to be included right into the Orthanc
Book.
In order to contribute to the documentation of the REST API, you can propose a simple patch to the core of Orthanc to be reviewed by the core maintainers.
Owner
- Name: orthanc-mirrors
- Login: orthanc-mirrors
- Kind: organization
- Repositories: 1
- Profile: https://github.com/orthanc-mirrors
Citation (CITATION.cff)
cff-version: "1.1.0"
message: "If you use this software, please cite it using these metadata."
title: Orthanc
abstract: "Orthanc is a lightweight open-source DICOM server for medical imaging supporting representational state transfer (REST)."
authors:
-
affiliation: UCLouvain
family-names: Jodogne
given-names: "Sébastien"
doi: "10.1007/s10278-018-0082-y"
license: "GPL-3.0-or-later"
repository-code: "https://orthanc.uclouvain.be/hg/orthanc/"
version: 1.12.3
date-released: 2024-01-31
GitHub Events
Total
- Push event: 37
- Create event: 6
Last Year
- Push event: 37
- Create event: 6
Dependencies
- python 2.7 build
- Babel ==2.3.4
- Jinja2 ==2.8
- MarkupSafe ==0.23
- Pygments ==2.1.3
- Sphinx ==1.4.1
- alabaster ==0.7.7
- colorama ==0.3.7
- docutils ==0.12
- imagesize ==0.7.1
- pytz ==2016.4
- six ==1.10.0
- snowballstemmer ==1.2.1
- sphinx-bootstrap-theme ==0.4.9