Workflow and tools for switching picongpu versions #4163
Labels
component: tools
scripts, python libs and CMake
documentation
regarding documentation or wiki discussions
Milestone
Our documentation doesn't describe a workflow on how to switch to a new commit (version) and reuse a simulation setup created with a different version.
There are several things that can go wrong in such a process, e.g., a user should know that they are supossed to remove the
.build
directory before recompiling. They also need to update files that are copied to the example directory (when usingpic-create
), such as the.tpl
templates. Making changes to.cfg
and.param
files is sth a user may think about since they are already editing those, but, I think, updating, e.g.,.tpl
files may be not that obvious. The defaulttbg
template is a relative path in the setup directory, so not updating it may lead to users running into problems that were already fixed in the repository (Just like it recently happened to @HighIander).@BrianMarre suggested adding a new command line tool for updating setups, we could probably reuse
pic-create
for that.This issue is a result of an offline discussion with @psychocoderHPC @sbastrakov @BrianMarre and @steindev.
I hope, I didn't miss anything important in this summary. If so, please comment down below.
The text was updated successfully, but these errors were encountered: