Using SALAMANDER
Running an Input File and Viewing Results
After SALAMANDER is installed and tested, you should now be able to run input files using the salamander-opt executable located at ~/projects/SALAMANDER. Input files demonstrating the capabilities of SALAMANDER can be found in ~/projects/test/tests. Any input file (say, one called example_input.i) can be run with the following basic syntax:
~/projects/SALAMANDER/salamander-opt -i example_input.i
Information about the simulation and its progress will then be displayed on the screen. If a log file of the iterative solution process is also desired, the console output can be sent to a text file:
~/projects/SALAMANDER/salamander-opt -i example_input.i --color off 2>&1 | tee log.txt
The --color off option is to de-clutter the log file from extraneous mark-up resulting from the displayed console text colors.
Many test input files also create an output file with the name format example_input_out.e that contains all the simulation results that have been selected for output. These results are best viewed using a visualization tool like Paraview.
SALAMANDER Tests, Verification and Validation Cases, and Examples
In general the input files for verification, validation, and example cases located within the test/tests directory are meant to be a showcase of "production" SALAMANDER capability. Users are encouraged to start there when learning to use SALAMANDER and setting up new simulations. Documentation for the verification, validation, and example cases can be found on the SALAMANDER verification, validation, and example page.
The test/tests directory holds all SALAMANDER regression, verification, validation, and example tests for both complete and in-progress capability. These files should not be modified, so that periodic tests of SALAMANDER function can be performed successfully. If modification of tests, verification and validation cases, or examples is desired, their input files should be copied and run elsewhere.
Contributing to SALAMANDER
As SALAMANDER is developed and more capabilities are added, the tests directory will continue to grow. If you feel that you have added important new functionality, please create a test or example for it, such that any future changes will not break that capability. See the contribution guide for detailed instructions on how to contribute to SALAMANDER.