ATS is an Automated Test System. It is used to implement regression testing across a variety of HPC platforms.
ATS usage and expectations vary among its user base. This also applies to how ATS is installed. Below are a few variations that users may find helpful.
For more information, please check our documentation.
A "global" install really means a widely available Python executable with ATS modules discoverable in its python path. Useful for multiple different projects in a shared environment.
Example installation:
# Load a python 3.8 module, or otherwise put python 3.8 in your path
module load python/3.8.2
# Create a fresh Python 3.8 (or higher) executable to be shared.
python3 -m virtualenv --system-site-packages --python=python3.8 <NEW_ENV_PATH>
# Clone ATS
git clone git@github.com:LLNL/ATS.git <CLONE_PATH>
# pip install cloned ATS into fresh shared Python 3.8 (or higher) executable.
<NEW_ENV_PATH>/bin/python -m pip install <CLONE_PATH>/
A project installation could apply to projects that include ATS in their source code directly.
# Load a python 3.8 module, or otherwise put python 3.8 in your path
module load python/3.8.2
# Clone ATS
git clone git@github.com:LLNL/ATS.git <CLONE_PATH>
# pip install cloned ATS into <DESTINATION_PATH>
python3 -m pip install <CLONE_PATH>/ --target=<DESTINATION_PATH>
Installation specific to the user could save an individual from running multiple project installs. The user just needs to remember to update their ATS when needed.
# Load a python 3.8 module, or otherwise put python 3.8 in your path
module load python/3.8.2
# Clone ATS
git clone git@github.com:LLNL/ATS.git <CLONE_PATH>
# pip install cloned ATS into <DESTINATION_PATH>
python3 -m pip install --user <CLONE_PATH>/
Another option is to tell Python where ATS is without any installation. Append the path to ats/init.py to $PYTHONPATH as seen below:
# Clone ATS
git clone git@github.com:LLNL/ATS.git <CLONE_PATH>
# bash and zsh users
export PYTHONPATH=$PYTHONPATH:<CLONE_PATH>/ats
# (t)csh users. Note that the colon is commented out
setenv PYTHONPATH $PYTHONPATH\:<CLONE_PATH>/ats
Contact the ATS project lead dawson6@llnl.gov
Refer to file Contributing
ATS is licensed under the BSD 3-Clause license, (BSD-3-Clause or https://opensource.org/licenses/BSD-3-Clause).
Refer to LICENSE
LLNL-CODE-820679