- Taylor Childers (john.taylor.childers@cern.ch)
- python 2.7+ (haven't actually tested with Python 3)
- mpi4py
- yampl
- python-yampl
If you are using a non-standard MPI library, which is common for most supercomputers, you will need to compile the mpi4py module against your local MPI libraries. In order to compile the mpi4py module you will need to compile the Cython module which mpi4py uses to wrap the C++ MPI library functions in Python.
In all cases you will need to compile the yampl program and the python-yampl wrapper for Yoda to use during communications with AthenaMP.
Here are rough instructions for this process, there are specific instructions for some sites further below.
# setup environment
# typically I setup the virtualenv of Harvester at this point
# if your HPC system uses modules to setup environments you may
# need to source some modules for an older GNU or move from
# intel to GNU compilers, etc.
# I'll assume you are in the Harvester virtualenv base directory
# referenced by $VIRTUAL_ENV
# Custom build Cython with local compilers
git clone git@github.com:cython/cython.git
cd cython
git checkout tags/0.25.2 # later tags may also work (haven't tested)
# here cc and CC are place holders for whichever compiler your
# local system requires
CC=cc CXX=CC python setup.py build
export PYTHONPATH=$VIRTUAL_ENV/lib64/python2.7/site-packages
# this installs the python module in the same site-packages area
# as harvester, etc.
CC=cc CXX=CC python setup.py install --prefix=$VIRTUAL_ENV
cd ../
# Custom build mpi4py with local compilers for worker nodes
git clone git@github.com:mpi4py/mpi4py.git
cd mpi4py
git checkout tags/2.0.0 # later tags may work (haven't tested)
## edit mpi.cfg
## under [mpi]
## uncomment mpicc and mpicxx
## change compiler to point at your local compilers (cc & CC) in this example
CC=cc CXX=CC python setup.py build
CC=cc CXX=CC python setup.py install --prefix=$VIRTUAL_ENV
cd ../
# next you need to install yampl which AthenaMP uses to communicate
git clone git@github.com:vitillo/yampl.git
cd yampl
# on some systems like Theta you need "LDFLAGS=-dynamic" to force dynamic linking
# if you find it causing problems on your system, remove it
./configure --prefix=$VIRTUAL_ENV/install CC=cc CXX=CC LDFLAGS=-dynamic
make -j 10 install
# in my case this fails in the zeromq folder
# so go into the zeromq directory and build by hand
cd zeromq
./configure --prefix=$VIRTUAL_ENV/install CC=cc CXX=CC LDFLAGS=-dynamic
make -j 10 install
cd ..
# continue with yampl build
make -j 10 install
cd ../
# now you need to install the python bindings for yampl
git clone git@github.com:vitillo/python-yampl.git
cd python-yampl
# then run
python setup.py build_ext
# the last command may fail, if so,
# edit setup.py such that inside the 'include_dirs' inside the 'Extension' have
# both the path to the '$VIRTUAL_ENV/install/include/yampl'
# and '$VIRTUAL_ENV/install/include' and the 'extra_link_args' has
# '-L/path/to/yampl/install/lib'. Then run it again
# Run this to install the module
python setup.py install
cd ../
# install yoda into the $VIRTUAL_ENV/python2.7/site-packages
pip install git+git://github.com/PanDAWMS/panda-yodaYou should be able to run the yoda_droid command from the command line at this point and have it work. There is configuration now needed. See the configuration section for that.
In the ideal case yoda is updated via this command while inside the virtual environment:
pip install --upgrade git+git://github.com/PanDAWMS/panda-yodaIn my experience with these pip installs from github, this method can fail. If it does you must do the following to update or uninstall:
rm -rf $VIRTUAL_ENV/lib/python2.7/site-packages/pandayoda
rm -rf $VIRTUAL_ENV/lib/python2.7/site-packages/panda_yoda-0.0.1-py2.7.egg-info
pip install git+git://github.com/PanDAWMS/panda-yodaCustom installation for Edison at NERSC
# setup environment
module load python/2.7.9
module load mpi4py/1.3.1
module load virutalenv
module swap PrgEnv-intel PrgEnv-gnu
# create virtualenv area if not already existing
virtualenv panda
cd panda
# upgrade the local version of pip and tell it how to reach outside NERSC
pip install --upgrade --index-url=http://pypi.python.org/simple/ --trusted-host pypi.python.org pip
pip install git+git://github.com/PanDAWMS/panda-yoda
# next you need to install yampl
git clone git@github.com:vitillo/yampl.git
cd yampl
./configure --prefix=$PWD/install CC=cc CXX=CC LDFLAGS=-dynamic
make -j 10 install
# in my case this fails in the zeromq folder
# so do this
cd zeromq
./configure --prefix=$PWD/install CC=cc CXX=CC LDFLAGS=-dynamic
make -j 10 install
cd ..
make -j 10 install
cd ..
# now you need to install the python bindings for yampl
git clone git@github.com:jtchilders/python-yampl.git
cd python-yampl
# edit setup.py such that inside the 'include_dirs' inside the 'Extension' have
# both the path to the '/path/to/yampl/install/include/yampl'
# and '/path/to/yampl/install/include' and the 'extra_link_args' has
# '-L/path/to/yampl/install/lib'.
# then run
python setup.py build_ext
# the last command may fail, if so, remove the '-dynamic' from it and run by hand
# then run
python setup.py install
# in order to run you need to make sure LD_LIBRARY_PATH includes
export LD_LIBRARY_PATH=/path/to/yampl/install/lib:$LD_LIBRARY_PATH
# create install area
INSTALL_AREA=/path/to/yoda
mkdir $INSTALL_AREA
cd $INSTALL_AREA
# build using GNU not Intel compilers
module swap PrgEnv-intel PrgEnv-gnu
# Custom build Cython with local compilers for Theta worker nodes
git clone git@github.com:cython/cython.git
cd cython
git checkout tags/0.25.2 # later tags seem to break (haven't investigated further)
CC=cc CXX=CC python setup.py build
export PYTHONPATH=$INSTALL_AREA/lib64/python2.7/site-packages
CC=cc CXX=CC python setup.py install --prefix=$INSTALL_AREA
cd ../
# Custom build mpi4py with local compilers for Theta worker nodes
git clone git@github.com:mpi4py/mpi4py.git
cd mpi4py
git checkout tags/2.0.0 # later tags seem to break (haven't investigated further)
## edit mpi.cfg
## under [mpi]
## uncomment mpicc = cc
## uncomment mpicxx = cxx
CC=cc CXX=CC python setup.py build
CC=cc CXX=CC python setup.py install --prefix=/path/to/yoda
# Custom build yampl library
git clone git@github.com:vitillo/yampl.git
cd yampl
./configure --prefix=$INSTALL_AREA CC=cc CXX=CC
make -j 10 install
# in my case this fails in the zeromq folder
# so I did this
cd zeromq
./configure --prefix=$INSTALL_AREA CC=cc CXX=CC LDFLAGS=-dynamic
make -j 10 install
# this will also fail to build the shared library because it is trying
# to include the static library from zeromq so edit the Makefile to
# LIBZMQ = ./zeromq/src/.libs/libzmq.so
# if that library does not exist, you may need to re-run the configure
# step in the zeromq folder with the option --enable-shared
# after you have zeromq build go back to yampl directory and build
cd ..
make -j 10 install
cd ..
# Custom build yampl python bindings
git clone git@github.com:vitillo/python-yampl.git
cd python-yampl
## edit setup.py such that inside the 'include_dirs' inside the 'Extension' have
## both the path to the '$INSTALL_AREA/yampl/install/include/yampl'
## and '$INSTALL_AREA/yampl/install/include'
## in my case, I also had to add to the setup.py, at the top:
## yampl_lib_path = subprocess.check_output(['pkg-config','--libs-only-L','yampl']).decode('utf-8')[:-2]
## then the extension declaration looks like this:
## Extension("yampl",
## sources=["yampl.pyx"],
## libraries=["yampl"],
## library_dirs=[yampl_lib_path.replace('-L','')],
## include_dirs=[yampl_include,yampl_include.replace('/yampl','')],
## extra_link_args=[yampl_libs],
## language="c++"),
python setup.py build_ext
python setup.py install
cd ..
# install yoda
pip install git+git://github.com:PanDAWMS/panda-yoda.git
# to later update yoda you must delete the $VIRTUAL_ENV/lib/python2.7/site-packages/pandayoda
# and panda_yoda-0.0.1... folders by hand, then rerun the pip install commandmodule load python/2.7-anaconda
module swap PrgEnv-intel PrgEnv-gnu
# follow directions for ALCF/ThetaAfter installation, you will find a yoda_template.cfg file in your $VIRTUAL_ENV/etc folder. This file uses the ConfigParser syntax from the module of the same name.
Most subsections represent a different process module of Yoda. Many modules have a loop_timeout parameter that controls polling loops of running sub processes and can be finetuned for performance and responsiveness (60 seconds should generally be fast enough). In addition, there is the loglevel setting to control the local log level and can be set to the usual DEBUG, INFO, WARNING, ERROR.
Otherwise, custom settings are described below:
wallclock_expiring_leadtime: this is experimental at the moment, but in the future would allow the user to specify how many seconds before the expected wall-clock of the batch job will expire that Yoda should kill all MPI ranks and exit. Currently the wall-clock time is passed to Yoda on the command line.
messenger_plugin_module: controls the plugin used to communicate with Harvester to request a job definition. Currently there is only onepandayoda.yoda.shared_file_messenger. In the future, there will likely also be sockets version.
send_n_eventranges: controls the number of event ranges theWorkMangerthread sends to Droids requesting more work. Current recommendation is to keep this value at the number of AthenaMP workers (128 on Theta, 136 on Cori, etc.). Multiplying by 2 or more could be recommended if long wall-clock times are anticipated.request_n_eventranges: controls the number of event ranges to request from Harvester when there are no more to hand out to Droid instances. Current recommendation is to keep this value at the number total AthenaMP workers in your batch job, i.e. Number of Nodes times number of AthenaMP workers per node. Again, multiplying by 2 or more could be recommeneded if longer wall-clock times are anticipated.
eventrange_timeout: If Harvester does not supply new event ranges within the number of seconds defined by this setting, measured from the time a request is made, then Yoda sends the 'no more event ranges' message to Droids which triggers an exit after all remaining events have been processed.
harvester_config_file: this should point at the harvester 'cfg' file. the Shared File Messenger needs to know the names of the JSON files Harvester intends to use for communication.
yampl_socket_name: This is a string used to define the yampl socket name that is used to communicate with AthenaMP. It is placed on the command line of the transform (Sim_tf.py). Current setting isEventServiceDroid_r{rank}where{rank}takes advantage of the python string format command to replace rank with the ranknumber of the Droid running AthenaMP.working_path: controls the name of the working path for each Droid instance. This is a relative path to the working directory inwhich Yoda is launched by Harvester. Current setting isdroid_rank_{rank:05d}where{rank:05d}takes advantage of the python string format command to replace rank with the ranknumber of the Droid running AthenaMP padded with zeros.
output_file_type: This is a setting for the JSON output for Harvester. This setting doesn't need to be changed and should always bees_output.harvester_output_timeout: with the shared file messenger, the file manager writes a file containing information related to output files. This timeout controls how frequently it checks the filesystem to see if Harvester has consumed the output file. If the file is no longer on disk, more output files can be written.
get_more_events_threshold: threshold at which the JobComm will request more events from Yoda.aggregate_output_files_time: time in seconds for how frequently output files should be sent via MPI to Yoda from Droid rank. This ensures we are not overloading MPI message traffic and should be optimized for your system. If you have many AthenaMP workers per Droid, there are going to be more output files per second generated, which could warrant a larger value for this time.debug_message_char_length: this controls how many characters to print when debugging and printing received messages.stage_outputs: (experimental) boolean that when set triggers the copying of AthenaMP output files from the AthenaMP working directory to a specified staging directory
template: The full path to a template file for running the Transform. An example of this template is included for running Sim_tf on Theta intemplates/ThetaSubmitTF.sh. Another version for running inside a singularity container is provided intemplates/ThetaSubmitSingularity.sh. The template file contains python string format variables like{rank},{processingType},{taskID},{pandaID},{release},{package},{cmtConfig},{gcclocation},{transformation},{jobPars}.run_script: The name of the script in which thetemplatewill be written.subprocess_stdout: This controls the transforms output log file name. Current settings is -transform_stdout_r{rank}_pid{PandaID}.logwhere{rank}and{PandaID}take advantage of the python string format command to replace rank/PandaID with the ranknumber/PandaID of the Droid/Job running AthenaMP. Keep in mind that if you change this name you must change the Harvester plugin that grabs log data to upload to the grid.subprocess_stderr: same as above, but for the error stream. Currently set totransform_stderr_r{rank}_pid{PandaID}.log.use_clean_env: booean that determines if therun_scriptis executed in asubprocess.Popenobject with a clean environment or using the current environment in which Yoda is running.use_container: Set totrueif you want the transform to run inside a containercontainer_prefix: Used to set the container execute command. For Theta this looks like/usr/bin/singularity exec -B /lus/theta-fs0/projects/AtlasADSP:/lus/theta-fs0/projects/AtlasADSP:rw /lus/theta-fs0/projects/AtlasADSP/centos6-cvmfs.atlas.cern.ch.img.x86_64-slc6-gcc49+.201803081026 /bin/bashrun_directory: (experimental) ifrun_elsewhereis set, this is the directory in whichrun_scriptwill be launched in thesubprocess.Popen.run_elsewhere: (experimental) boolean that if set, triggers the running of AthenaMP in a custom directory specified byrun_directory.logs_to_stage: (experimental) A comma separated list of globs (globs can include wildcards*) that specifies the files to copy from therun_directoryto the yoda working directory for capture by Harvester which tarballs log files for PanDA upload.jobmods: A comma separated list of modules that modify the panda job definition. These modules need to live in thepandayoda/jobmoddirectory of the repo. Current jobmods include:no_file_validation: This simply adds the command line option--fileValidation=Falseto your job to reduce runtime by skipping the file validationremove_dbrelease: This searches the command line arguments for the transformation and removes any--DBRelease=option.shorten_input_evnt_file_list: This searches the command line arguments and includes only one file in the--inputEVNTFile=command line argument. This is used for JumboJobs because the job definition includes EVERY input file on the command line and Athena will try to open them all if you include them there. Therefore, this removes all but the first file.unlimited_athenamp_messages: This adds python code to extend the allowed number of Athena messages that can be printed. This is helpful when debugging Athena.
default_message_buffer_size: controls the MPI Message size limits in mpi4py. Current recommended value is10000000.debug_message_char_length: this controls how many characters to print when debugging and printing received messages.