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

Feat: analysis radical migration tool #388

Merged
merged 9 commits into from
Feb 29, 2024

Conversation

ehhartmann
Copy link
Collaborator

this tool will create a json file of migrations which can be visualized in pymol using an external script

@ehhartmann
Copy link
Collaborator Author

ToDo:

  • write code for all three analysis types
  • add option to combine runs
  • (try this on the dopa sims)

@ehhartmann
Copy link
Collaborator Author

ready for review!

@ehhartmann ehhartmann self-assigned this Feb 28, 2024
src/kimmdy/analysis.py Outdated Show resolved Hide resolved
src/kimmdy/analysis.py Outdated Show resolved Hide resolved

parser_radical_migration = subparsers.add_parser(
name="radical_migration",
help="Create a csv of radical migration events for further analysis.",
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

json, not csv, right?

src/kimmdy/assets/analyse_kimmdy_migration.py Outdated Show resolved Hide resolved
@ehhartmann
Copy link
Collaborator Author

I don't want to write the tutorial now but the rest has been addressed

Copy link
Collaborator

@jmbuhr jmbuhr left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

How do you want users to run the script? Right now it would be something like python -m kimmdy.assets.scripts.analyse_kimmdy_migration.py, in which case you would want to add the classic if __name__ == "__main__" thing. Though from the # %% comments it looks more like something you expect people to run interactively in their own environment, so I'm wondering if some place in the guide docs folder would be a better solution, to separate it from the regular kimmdy modules. Also, do you want to add pymol to https://github.com/hits-mbm-dev/kimmdy/blob/0bc5a68b7adbd026a7a7cd78176a2d47b602dc68/setup.cfg#L60-L72 ?

@ehhartmann
Copy link
Collaborator Author

I would say installing pymol is a bit messy, so I would leave it to the user.
The script runs with pymol <script_name>. For debugging and adding new features I run it interactively. To me, it is just a nice script to share with people who have kimmdy output. We could put it in guide and just have it as asset for some future tutorial

@ehhartmann ehhartmann merged commit ba4cb0f into main Feb 29, 2024
1 check passed
@ehhartmann ehhartmann deleted the feat/analysis_radical_migration branch February 29, 2024 16:55
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants