... | ... | @@ -4,19 +4,31 @@ In this post, we will discuss the process to update methodology documents with a |
|
|
|
|
|
Methodology Layout
|
|
|
------------------
|
|
|
|
|
|
All reports have the same basic layout and information that follows the [Methodology Template] (https://gitlab.kitware.com/physiology/engine/blob/master/docs/Methodology/MethodologyTemplate.md). These documents need to be updated as part of the contribution process.
|
|
|
|
|
|
Adding Images
|
|
|
-------------
|
|
|
TODO - Static plots
|
|
|
|
|
|
https://gitlab.kitware.com/physiology/engine/tree/master/docs/Figures
|
|
|
### Static Figures
|
|
|
|
|
|
You can add images to the documentation by saving them to the [Images directory] (https://gitlab.kitware.com/physiology/engine/tree/master/docs/Images) and referencing them with a tag in the Markdown file you are editing. There are many examples of this in the existing reports.
|
|
|
|
|
|
Most Pulse figures were generated in PowerPoint or Excel files before being saved as images to allow for easy future modification. These working files can be found in the [Figures directory] (https://gitlab.kitware.com/physiology/engine/tree/master/docs/Figures). Updates to each system's data flow diagram can be done here, which is required for new functionality like the addition of an action or condition.
|
|
|
|
|
|
Most existing Pulse circuit diagrams were created using [TinyCAD] (https://sourceforge.net/projects/tinycad/) and can be found in the CircuitDiagrams directory. Like the other static figures, circuit diagrams should also be stored in the [Images directory] (https://gitlab.kitware.com/physiology/engine/tree/master/docs/Images).
|
|
|
|
|
|
To update any existing figure, merely replace it with the same filename in the [Images directory] (https://gitlab.kitware.com/physiology/engine/tree/master/docs/Images). As long as the tag in the markdown file does not change, it will be used when the html is generated (see [Generating Documentation] (https://gitlab.kitware.com/physiology/engine/wikis/Generating%20Documentation)).
|
|
|
|
|
|
### Static Plots
|
|
|
|
|
|
|
|
|
### Validation Plots
|
|
|
|
|
|
Automatically generated
|
|
|
|
|
|
https://gitlab.kitware.com/physiology/engine/tree/master/docs/Images
|
|
|
|
|
|
PPT - flow diagrams
|
|
|
|
|
|
Circuit diagrams
|
|
|
|
|
|
Adding System or Compartment Validation
|
|
|
---------------------------------------
|
... | ... | @@ -24,17 +36,22 @@ With a few exceptions, all system variables (i.e., vitals) should have a healthy |
|
|
|
|
|
TODO how to add values
|
|
|
|
|
|
|
|
|
Adding Static Tables
|
|
|
--------------------
|
|
|
|
|
|
|
|
|
Adding Scenario Validation Tables
|
|
|
---------------------------------
|
|
|
Each action and condition should have at least one scenario associated with it and all scenarios should have expected values for important parameters to validate appropriate functionality.
|
|
|
|
|
|
TODO
|
|
|
|
|
|
Adding Plots
|
|
|
------------
|
|
|
TODO - Automatically generated
|
|
|
Adding static plot data
|
|
|
Adding scenario outputs
|
|
|
|
|
|
|
|
|
Adding Equations
|
|
|
----------------
|
|
|
|
|
|
|
|
|
|
|
|
Generate and Review
|
|
|
-------------------
|
... | ... | |