... | ... | @@ -8,9 +8,7 @@ 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
|
|
|
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.
|
|
|
|
|
|
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. 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 :
|
|
|
|
|
|
```bash
|
|
|
# Windows
|
... | ... | @@ -19,18 +17,22 @@ From a command/terminal running in the <pulse/bin>, execute the following comman |
|
|
$ ./run.sh updateBaselines
|
|
|
```
|
|
|
|
|
|
This baseline collection will be create the following folder : <pulse/bin>/verification. It will contain both Scenario files, 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
|
|
|
---------------
|
|
|
Being a C++ library, Pulse requires a separate application to instantiate and execute the engine. While we do provide various execution mechanisms in our repository that we will explore in the sections below, we will focus on our simplest application driver, the PulseScenarioDriver. This driver is a simple executable and is our primary tool for debugging and developing the engine.
|
|
|
|
|
|
[Running the PulseScenarioDriver](command-terminal-execution)<br>
|
|
|
[Running C++ from Visual Studio](msvc-execution)<br>
|
|
|
[Running C++ from CLion](clion-execution)<br>
|
|
|
[Running Java from Eclipse](eclipse-execution)<br>
|
|
|
[Running Java from IntelliJ](intellij-execution)<br>
|
|
|
[Running C#/.NET from Visual Studio](msvcsharp-execution)
|
|
|
Being a C++ library, Pulse requires a separate application to instantiate and execute the engine. While we do provide various execution mechanisms in our repository that we will explore in the sections below, we will focus on our simple PulseScenarioDriver executable. This driver is our primary tool for debugging and developing the engine.
|
|
|
|
|
|
[Running the PulseScenarioDriver](command-terminal-execution)
|
|
|
[Running the Pulse Test Suite](test-suite-execution)
|
|
|
|
|
|
Setting up an IDE
|
|
|
-----------------
|
|
|
[Using C++ with Visual Studio](msvc-execution)<br>
|
|
|
[Using C++ with CLion](clion-execution)<br>
|
|
|
[Using Java with Eclipse](eclipse-execution)<br>
|
|
|
[Using Java with IntelliJ](intellij-execution)<br>
|
|
|
[Using C#/.NET with Visual Studio](msvcsharp-execution)
|
|
|
|
|
|
Using Pulse
|
|
|
-----------
|
... | ... | |