Create flow diagram of how the system components work together

Issue #448 resolved
David Platten
created an issue

I would find it useful to have a diagram that shows how the system components work together. For example:

Populating the database

  • Modality sends DICOM objects to OpenREM's store SCP
  • The store SCP (Conquest in my case) applies the rules in dicom.ini to each object
  • Data from the object is extracted by the appropriate python script or the object is deleted if the extraction rules don't apply
  • Calculation of skin dose map occurs if appropriate / possible
  • The object is deleted from OpenREM's store

There could be other diagrams for other elements of the system.

Read the docs has Graphviz built-in that can help with this. See http://build-me-the-docs-please.readthedocs.io/en/latest/Using_Sphinx/UsingGraphicsAndDiagramsInSphinx.html

Test doc page to see with in progress: http://docs.openrem.org/en/docsdiagrams/testgraphviz.html

Comments (43)

  1. Log in to comment