SlicerRT icon indicating copy to clipboard operation
SlicerRT copied to clipboard

ENH: Initial support of the arc beam sequence

Open MichaelColonel opened this issue 2 years ago • 17 comments

A simple arc beam generator is added to Beam section of External Beam Planning module

By clicking on the "Arc beam sequence" toggle button, the arc beam sequence will be added instead of simple static beam. image

MichaelColonel avatar Aug 04 '22 11:08 MichaelColonel

Another really great contribution!

Can you please squash the commits, at least those that have the same message?

Also it would be useful if you gave more information about how the created sequence is to be used, and in general some documentation about this feature. As detailed as it seems reasonable. Since we don't have anything better yet, please edit this page: https://www.slicer.org/wiki/Documentation/Nightly/Modules/ExternalBeamPlanning

Thank you!

cpinter avatar Aug 08 '22 14:08 cpinter

Since we don't have anything better yet, please edit this page: https://www.slicer.org/wiki/Documentation/Nightly/Modules/ExternalBeamPlanning

The old Slicer MediaWiki site will be retired (made read-only) at some point. We recommend extensions to store documentation in their repository. We don't need to immediately move the existing documentation, but it would make sense to add new documentation to this repository (a common pattern is to add a Docs subfolder and within this folder add a .md file for each module).

lassoan avatar Aug 08 '22 20:08 lassoan

Initial arc-beam commits were squashed.

Module file description was added

MichaelColonel avatar Aug 10 '22 13:08 MichaelColonel

Thanks for creating the markdown page! @lassoan how do you think we should make it available? Just link it from the wiki for now?

cpinter avatar Sep 05 '22 11:09 cpinter

Thanks for creating the markdown page! @lassoan how do you think we should make it available? Just link it from the wiki for now?

The easiest is to link it from the wiki. It could be also nice (and not too much work) to create a main documentation page in github (just a ti-level RADME.md with about the same content as the wiki main page). Then, page by page, documentation could be moved from the wiki. Whenever a page is moved then the content of the page on the wiki would be replaced by a message that it is moved to Github and the links from the main pages on both wiki ans Github would be updated to the new location.

After a while readthedocs could be set up to generate a nice, versioned rendering of the documentation. (Github pages could be kept for rendering the version-independent part of the documentation, as it is already done now.)

lassoan avatar Sep 05 '22 11:09 lassoan

Hi @MichaelColonel I just saw this stale PR. Is this still on your radar? Can we help in anything to get this through?

cpinter avatar Jun 28 '24 10:06 cpinter

I will try to update this PR, so it can be merged.

MichaelColonel avatar Jun 28 '24 11:06 MichaelColonel