Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Workflow and tools for switching picongpu versions #4163

Open
pordyna opened this issue Jun 16, 2022 · 2 comments
Open

Workflow and tools for switching picongpu versions #4163

pordyna opened this issue Jun 16, 2022 · 2 comments
Assignees
Labels
component: tools scripts, python libs and CMake documentation regarding documentation or wiki discussions

Comments

@pordyna
Copy link
Member

pordyna commented Jun 16, 2022

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 using pic-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 default tbg 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.

@sbastrakov sbastrakov added the documentation regarding documentation or wiki discussions label Jun 16, 2022
@sbastrakov sbastrakov added this to the 0.7.0 / 1.0.0: Next Stable milestone Jun 16, 2022
@wmles
Copy link
Contributor

wmles commented Jun 24, 2022

This would be a really useful tool if it works! In my experience, it's always easier to start with a working example in the new version and edit this to incorporate the old changes.
But I fear it's far from trivial to write such a tool, it would have to track the changes in the signatures of the .param files. This is possible to do once between major versions but would require a lot of work/discipline to maintain that in the dev branch!

@sbastrakov
Copy link
Member

sbastrakov commented Jun 24, 2022

Oh i think the idea for the tool was not to automatically account for changes in .param files with PIConGPU version, that would be on a user anyways. But at least to keep the rest intact, so that e.g. after the update tbg -t etc/picongpu/hemera-hzdr/fwkt_v100.tpl ... would use the updated .tpl file version and not potentially old one in user's input directory.

@steindev steindev added the component: tools scripts, python libs and CMake label Oct 14, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
component: tools scripts, python libs and CMake documentation regarding documentation or wiki discussions
Projects
None yet
Development

No branches or pull requests

6 participants