Skip to content

Image-X-Institute/Roentgen.jl

Repository files navigation

Roentgen

CI codecov

Lars Mejnertsen

A Julia package for calculating dose for radiotherapy treatments.

This package is under development, so the implementation may change between versions.

dose_recon_example

Setup and Usage

To add the package to your environment, open the Julia REPL and type the ] to open the package manager. Add the package by entering:

add Roentgen

Once completed, you can exit the package manager by pressing Backspace.

You can then use the package by entering:

using Roentgen

There are examples for simple use cases and features in the examples folder.

Documentation

The documentation is generated by Documenter.jl and located in the docs/ folder.

To build:

  1. Navigate to the project directory in the terminal.
  2. Run julia --project=docs make.jl

This will generate the documentation HTML in docs/build.

Developing the Documentation

For developing the documentation, we recommend using LiveServer.jl. LiverServer will build the docs locally and update them in real-time as they are being edited, serving them on a local webpage. This is not added to the docs environment so it will need to be installed.

From the project directory, run

julia --project=docs docs/liveserver.jl

This will usually serve the docs at http://localhost:8000, which you can view in your web browser.