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

Refactoring of python/hpsmc #343

Open
sarahgaiser opened this issue Feb 10, 2023 · 4 comments
Open

Refactoring of python/hpsmc #343

sarahgaiser opened this issue Feb 10, 2023 · 4 comments
Labels
Milestone

Comments

@sarahgaiser
Copy link
Contributor

Some files in python/hpsmc are getting very large and are therefore hard to read/maintain. Especially tools.py contains a lot of components that are not necessarily connected to each other. I propose breaking down these big files into smaller ones containing one component or a set of related components.

@sarahgaiser
Copy link
Contributor Author

I started working on this a while ago when I was still familiarizing myself with hps-mc, so we don't have to start from scratch. I will find that branch again and link it to this issue.

@cbravo135
Copy link
Collaborator

cbravo135 commented Feb 28, 2023

I think a good example of the scope of a single file is generators.py, which contains all components that call one of the generators we use. One example of something we could break out of tools.py would be specifically the lcio tools we use for various sample preparations. The first step to doing this carefully will be to list out all the components we have and start putting them into categories. Having a different file for each component is going to get messy fast.

@JeremyMcCormick
Copy link
Member

JeremyMcCormick commented Mar 13, 2023

Can we discuss this in a meeting sometime?

I agree with you that the existing files could be split up, but I'd like to have a discussion of how this would look. It would have the potential to cause big conflicts on existing branches, so we should probably do this in a "sprint" while we pause most other code development.

@JeremyMcCormick JeremyMcCormick added this to the 2.1.0 milestone Mar 13, 2023
@sarahgaiser
Copy link
Contributor Author

Sounds good to me. Maybe we can discuss the meeting time in software_coordination channel?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

3 participants