Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
medicalphysics authored Apr 8, 2019
1 parent f247bb9 commit abda587
Showing 1 changed file with 8 additions and 4 deletions.
12 changes: 8 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,18 +1,22 @@
# OpenDXMC
Monte Carlo radiation dose scoring application for diagnostic x-ray imaging

OpenDXMC is a computer package to calculate and visualize dose distributions in diagnostic x-ray examinations. This package consists of a small library for Monte Carlo dose calculations for diagnostic x-ray energies. In addition the package includes a GUI for calculation of radiation dose from common CT examinations and planar x-ray apparatus. The application is currently in early development and an alpha release is available. However, the Monte Carlo code is not yet validated and use of this application should be for educational purposes only.
OpenDXMC is a computer package to calculate and visualize dose distributions in diagnostic x-ray examinations. This package consists of a small library for Monte Carlo dose calculations for diagnostic x-ray energies. In addition the package includes a GUI for calculation of radiation dose from common CT examinations and planar x-ray apparatus. The application is currently in early development and an alpha release is available. The Monte Carlo code is not yet validated and use of this application should be for educational purposes only.

Dose calculations are done by a Monte Carlo method optimized for a voxelized geometry. However only photons are modelled and essentially only KERMA is scored. The application supports dose calculations on CT series of individiual patients and standard human reference phantoms made by ICRU (see report 110).

##Installation
There are currently two major show-stoppers for users of this application; lack of documentation and lack of validation of the monte-carlo code. In the short term, these issues are the main focus of further development of the application.

Please do not hesitate if you encounter bugs or errors in the application, or simply missing a feature. The easiest way to report bugs or feature requests is to open an issue: https://github.com/medicalphysics/OpenDXMC/issues.

## Installation
Precompiled binaries are distributed for Windows 64 bits only and may be obtained here: https://github.com/medicalphysics/OpenDXMC/releases

###Build from source
### Build from source
OpenDXMC is build with CMake and depends on the following libraries:
*xraylib by T. Schoonjans: https://github.com/tschoonj/xraylib
*VTK Visualization Toolkit: https://vtk.org/
*Qt: https://www.qt.io/
These libraries must be installed.
These libraries must be installed. Running cmake with standard settings should suffice to generate makefiles for your platform. The application is currently only tested for Windows 10.


0 comments on commit abda587

Please sign in to comment.