... | @@ -8,7 +8,35 @@ If you would like us to expand upon anything feel free to bring it up in our <a |
... | @@ -8,7 +8,35 @@ If you would like us to expand upon anything feel free to bring it up in our <a |
|
Before diving into the topics below, make sure you have a good understanding of the
|
|
Before diving into the topics below, make sure you have a good understanding of the
|
|
the [Common Data Model](https://pulse.kitware.com/_c_d_m.html) and its [structures](https://pulse.kitware.com/_c_d_m_tables.html), as well as the [Pulse interface](https://pulse.kitware.com/physeng.html).
|
|
the [Common Data Model](https://pulse.kitware.com/_c_d_m.html) and its [structures](https://pulse.kitware.com/_c_d_m_tables.html), as well as the [Pulse interface](https://pulse.kitware.com/physeng.html).
|
|
|
|
|
|
We also assume you have build the source code per instruction from our repository. All binaries and data files can be found in your <path/to/pulse/build>install/bin directory. We will refer to this directory as <pulse/bin> in the following sections. Also, to follow along and both execute and debug the engine, you will need to pull all of our baseline scenarios. If you chose not to pull the baselines in your build process (you do not have a <pulse/bin>/verification folder), you will need to pull them. From a command/terminal running in the <pulse/bin>, execute the following command :
|
|
We also assume you have build the source code per instruction from our repository.
|
|
|
|
* We will refer to the source code directory as `<pulse/source>`
|
|
|
|
* The build directory you set where you ran CMake, will be refereed to as `<pulse/build>`
|
|
|
|
* All commands will be run from a terminal in the `<pulse/build>/install/bin`, which we will refer to as `<pulse/bin>`
|
|
|
|
|
|
|
|
The script to run all of our tests, utilities, and tools is written in CMake to ensure cross platform compatibility. CMake should be available on your path to use these tools. We also provide a simple `run` batch/shell script wrapper around the CMake calling format to be run as follows :
|
|
|
|
|
|
|
|
```bash
|
|
|
|
# The CMake invocation
|
|
|
|
cmake -DTYPE:STRING=[command] -P run.cmake
|
|
|
|
# On Windows
|
|
|
|
> run [command]
|
|
|
|
# On Linux/Max
|
|
|
|
$ ./run.sh [command]
|
|
|
|
# Note you may need to do a
|
|
|
|
$ chmod +x run.sh
|
|
|
|
# To run this script on your machine
|
|
|
|
```
|
|
|
|
|
|
|
|
Where [command] can be one of the following values:
|
|
|
|
- genData - Generate pba files from data in the `<pulse/source>/data/Data.xlxs` file (Patients, Substances, etc.)
|
|
|
|
- genStates - Generate a state file for every patient at the point where the patient completed stabilization (Simulation time 0s)to `<pulse/bin>/states`
|
|
|
|
- SystemValidation - Will use `<pulse/source>/test/config/ValidationSystems.config` to create system validation tables in the `<pulse/bin>/test_results` directory
|
|
|
|
- PatientValidation - Will use `<pulse/source>/test/config/ValidationPatients.config` to create patient validation tables in the `<pulse/bin>/test_results` directory
|
|
|
|
- The names of the other config files in the `<pulse/source>/test/config/` directory without the suffix
|
|
|
|
- For Example : DebugRun, CDMUnitTests, ValidationSystems, VerificationScenarios, etc.
|
|
|
|
- With exception of the Characterize.config, this is a legacy testing configuration that will not work
|
|
|
|
|
|
|
|
Lastly, to follow along and both execute and debug the engine, you will need to pull all of our baseline scenarios. If you chose not to pull the baselines in your build process (you do not have a <pulse/bin>/verification folder), you will need to pull them. From a command/terminal running in the <pulse/bin>, execute the following command :
|
|
|
|
|
|
```bash
|
|
```bash
|
|
# Windows
|
|
# Windows
|
... | @@ -17,7 +45,7 @@ We also assume you have build the source code per instruction from our repositor |
... | @@ -17,7 +45,7 @@ We also assume you have build the source code per instruction from our repositor |
|
$ ./run.sh updateBaselines
|
|
$ ./run.sh updateBaselines
|
|
```
|
|
```
|
|
|
|
|
|
This baseline collection will be create the following folder : <pulse/bin>/verification. It will contain both [Scenario files](https://pulse.kitware.com/_scenario_file.html), and baseline results files. We will discuss the baseline results in the test suite section.
|
|
This baseline collection will be create the following folder : `<pulse/bin>/verification`. It will contain both [Scenario files](https://pulse.kitware.com/_scenario_file.html), and baseline results files. We will discuss the baseline results in the test suite section.
|
|
|
|
|
|
Executing Pulse
|
|
Executing Pulse
|
|
---------------
|
|
---------------
|
... | | ... | |