Skip to main content

Close contact restrictions for radionuclide therapy patients

Project description

DOI

Dorn

Dorn is a GUI for generating individualised close contact restrictions for nuclear medicine patients, particularly radionuclide therapy patients.

Executable provided with release

Each release on GitHub includes a zip file. The zip file contains an executable file Dorn.exe that can be used to run the Dorn program on Windows 10 and 11 systems without needing to install Python and Dorn's other dependencies.

Installation

Dorn can be installed as a Python package if you have Python version 3.9 or higher. In the directory containing the pyproject.toml file:

python -m pip install .

Then run the command dorn to start the GUI.

glowgreen package

Dorn uses the Python package glowgreen for calculating radiation dose from contact patterns and restriction periods.

Building your own standalone executable

In the directory containing the pyproject.toml file:

python -m pip install . .[windows] .[freeze]
cxfreeze build

This generates a directory called something like build/exe.win-amd64-3.11 containing a file Dorn.exe. You can copy the exe.win-amd64-3.11 directory to another computer (of the same architecture) and run Dorn from the Dorn.exe file.

Creating the icon file

The icon file icofile.ico was generated from shovel.png in Python. Something like:

python -m pip install Pillow

Then

from PIL import Image
filename = 'shovel.png'
img = Image.open(filename)
icon_sizes = [(16,16), (32, 32), (48, 48), (64,64)]
img.save('new_icofile.ico', sizes=icon_sizes)

Source

https://github.com/SAMI-Medical-Physics/dorn

Bug tracker

https://github.com/SAMI-Medical-Physics/dorn/issues

Author

Jake Forster (jake.forster@sa.gov.au)

Copyright

Dorn is copyright (C) 2022-2025 South Australia Medical Imaging.

License

MIT License. See LICENSE file.

Citation

See CITATION.cff file.

Acknowledgments

The Dorn icon was designed by Kevin Hickson.


Development

Program overview

  • Patient data is stored in an ordered dictionary. Program reads/writes patient data to XML file.

  • Program settings are stored in another ordered dictionary, which reads/writes to settings.xml in the user's configuration directory. On Windows this is C:\Users\<USER>\AppData\Local\Dorn\Dorn\settings.xml. For backward compatibility, if there is a settings.xml in the current working directory, that file will be used instead.

  • Some settings cannot be edited via the GUI, such as the therapy options and the radionuclide data. The user may add at most 1 additional therapy options with measured clearance data and 1 additional therapy option with generic clearance via the command line interface (see below).

  • A command-line interface is provided that offers additional flexibility. To see the command line options, enter:

      dorn -h
    

    or with the executable:

      Dorn.exe -h
    

Ideas for new features

  • For therapy options that use generic clearance, allow the user to provide an initial dose rate measurement to determine the clearance function parameter: initial dose rate at 1 m.
  • Add more dose rate measurement time points and a scroll bar.
  • Add curve fit model representing no excretion at night. The difficulty will be adding the support in glowgreen.
  • Add a name field for the detector.
  • Attempt to propagate uncertainty from the contact pattern onto the calculated restriction period or dose.
  • Allow the user to edit/add contact patterns.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

dorn-2.0.0.tar.gz (157.7 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

dorn-2.0.0-py3-none-any.whl (156.2 kB view details)

Uploaded Python 3

File details

Details for the file dorn-2.0.0.tar.gz.

File metadata

  • Download URL: dorn-2.0.0.tar.gz
  • Upload date:
  • Size: 157.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.11.11

File hashes

Hashes for dorn-2.0.0.tar.gz
Algorithm Hash digest
SHA256 3da3acbd826590052d8c8ceb39371233c3a8587251aa069502291e33cb729b36
MD5 dfe01d49d9c140855ceca0035a4db12c
BLAKE2b-256 1af24563b27e1e4d550b91183ca0b5050505f98925a3ceb1aa64da280c6deac1

See more details on using hashes here.

File details

Details for the file dorn-2.0.0-py3-none-any.whl.

File metadata

  • Download URL: dorn-2.0.0-py3-none-any.whl
  • Upload date:
  • Size: 156.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.11.11

File hashes

Hashes for dorn-2.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 bbe4851f738b23ce2c5086224ae7b70ff206176d57efc8ec65d31d5d7bbd88ca
MD5 ee4532a57f77a34f092f744cc15c46ff
BLAKE2b-256 cf3de9f9703ada56b81878e0b0c78c110c2fc52c549ade3b9483c986479416c0

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page