Skip to content

Commit

Permalink
Formatting and update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
brryan committed Nov 14, 2024
1 parent ab4e800 commit b44c50c
Show file tree
Hide file tree
Showing 3 changed files with 30 additions and 5 deletions.
30 changes: 28 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,6 +54,16 @@ Currently supported computers/partitions are:
skylake-gold
volta-x86 (gpu)

## Chicoma

cpu
gpu

## Venado

gg (cpu)
gh (gpu)

# Installation

git submodule update --init --recursive
Expand Down Expand Up @@ -82,15 +92,31 @@ script:

## Testing

There is a suite of tests in the `tst/` directory. To run the full regression suite, do
There is a suite of tests in the `tst/` directory. Tests are run with the included `run_tests.py`
script. This script can be run in three ways:

1. With default arguments, where the current version of the source will be built. The resulting
executable can be saved for reuse with `--save_build`, and if saved can be reused in subsequent test
runs with `--reuse_build`. Note that `--save_build` must continue to be supplied as well to avoid
the reused build being deleted after the tests are run.
2. If the `run_tests.py` script is called from a directory with a valid `artemis` executable, that
executable will be used for testing and will not be cleaned up afterwards.
3. If the path to an `artemis` executable is provided to the `--exe` option of `run_tests.py`, that
executable will be used for testing and will not be cleaned up afterwards.

In all cases, the tests will be run from a `tst` directory created in the same folder as the
executable being used. Figures will be created in `artemis/tst/figs` and the log file in
`artemis/tst`.

To run the full regression suite, do

python3 run_tests.py regression.suite

You can also pass a list of individual tests to the script, or create your own suite file.

## CI

We use the gitlab CI for regression testing. The CI will not run if the PR is marked "Draft:" or
We use the github CI for regression testing. The CI will not run if the PR is marked "Draft:" or
"WIP:". Removing these labels from the title will not automatically launch the CI. To launch the CI
with an empty commit, do

Expand Down
3 changes: 1 addition & 2 deletions tst/launch_ci_runner.py
Original file line number Diff line number Diff line change
Expand Up @@ -92,8 +92,7 @@ def run_tests_in_temp_dir(pr_number, head_repo, head_ref, commit_sha):
+ os.path.join(build_dir, "src", "artemis")
+ " --log_file=ci_cpu_log.txt",
]
ret = subprocess.run(test_command,
check=True)
ret = subprocess.run(test_command, check=True)

# CI apparently succeeded; indicate that
return True
Expand Down
2 changes: 1 addition & 1 deletion tst/run_tests.py
Original file line number Diff line number Diff line change
Expand Up @@ -167,7 +167,7 @@ def main(**kwargs):
):
logger.error("Exception occurred", exc_info=True)
test_errors.append("make()")
raise TestError(f'Provided executable \"{artemis_exe_path}\" not found!')
raise TestError(f'Provided executable "{artemis_exe_path}" not found!')
# Set the valid provided executable path
artemis.set_executable(os.path.abspath(artemis_exe_path))
else:
Expand Down

0 comments on commit b44c50c

Please sign in to comment.