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

Various showcase changes (mappers, networks, structure, figures,...) #125

Merged
merged 8 commits into from
Apr 26, 2024

Conversation

hannahbaumann
Copy link
Contributor

No description provided.

Copy link

Check out this pull request on  ReviewNB

See visual diffs & provide feedback on Jupyter Notebooks.


Powered by ReviewNB

Copy link

Binder 👈 Launch a binder notebook on branch OpenFreeEnergy/ExampleNotebooks/add_options_mappers_networks

@hannahbaumann
Copy link
Contributor Author

The 'new' showcase notebook is currently named openfe_showcase.ipynb.

@hannahbaumann hannahbaumann changed the title [WIP] Show off options atom mappers and ligand networks [WIP] Various showcase changes (mappers, networks, structure, figures,...) Apr 15, 2024
@@ -2,12 +2,11 @@
"cells": [
Copy link
Contributor

@mikemhenry mikemhenry Apr 16, 2024

Choose a reason for hiding this comment

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

Maybe add something like "First we will use rdkit to visualize the TYK2 ligands" or something to prime the reader what we do in the next code block (and so they don't look for an openfe import here)


Reply via ReviewNB

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Added this!

@@ -2,12 +2,11 @@
"cells": [
Copy link
Contributor

@mikemhenry mikemhenry Apr 16, 2024

Choose a reason for hiding this comment

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

Love this section!


Reply via ReviewNB

@@ -2,12 +2,11 @@
"cells": [
Copy link
Contributor

@mikemhenry mikemhenry Apr 16, 2024

Choose a reason for hiding this comment

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

We can drop the note I put here "MMH: I think keeping that you can store the network is fine but we don't need more than this + the small code snnipit"


Reply via ReviewNB

@@ -2,12 +2,11 @@
"cells": [
Copy link
Contributor

@mikemhenry mikemhenry Apr 16, 2024

Choose a reason for hiding this comment

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

I agree with your TODO plan, example commands that do all the work we talked about + link to our CLI tutorial.


Reply via ReviewNB

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Changed this!

@@ -2,12 +2,11 @@
"cells": [
Copy link
Contributor

@mikemhenry mikemhenry Apr 16, 2024

Choose a reason for hiding this comment

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

Yes the more I see this now, I think it makes more sense to mention the CLI at the end, and say that you can do all the steps above with these 3 CLI commands. I think it is easier to use the python API to talk about each step, since you can see what is going on with the python code, and its kinda satisfying (I think) for someone following along to hit the end and think "wow some of that python was over my head but I can do all that with a few CLI commands? awesome"


Reply via ReviewNB

Copy link
Contributor Author

Choose a reason for hiding this comment

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

For now I left the part that shows how to dump transformations to JSON here, since I thought this might be useful, but we can also remove it if you think it's too long (since it's also in the tutorial, users could find it there as well).

@hannahbaumann hannahbaumann changed the title [WIP] Various showcase changes (mappers, networks, structure, figures,...) Various showcase changes (mappers, networks, structure, figures,...) Apr 23, 2024
@@ -2,12 +2,11 @@
"cells": [
Copy link
Member

@IAlibay IAlibay Apr 26, 2024

Choose a reason for hiding this comment

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

Sorry it's probably just too early in the morning please ignore if you think otherwise:

"for alchemical substitutions of the TYK2 ligands"

Something about that sentence feels off for some reason? Should it be "of alchemical transformations between the TYK2 ligands"?


Reply via ReviewNB

Copy link
Contributor Author

Choose a reason for hiding this comment

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

You're right, changed this!

@@ -2,12 +2,11 @@
"cells": [
Copy link
Member

@IAlibay IAlibay Apr 26, 2024

Choose a reason for hiding this comment

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

  1. Because this is our "showcase", it would be best not to have TODO entries around. Assuming suitable issues are opened for each of these, could we remove them from the user facing text here?
  2. The diagram we link to here is out of date - I think we should remove it for now and update it later?

Reply via ReviewNB

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Removed these!

showcase/openfe_showcase.ipynb Show resolved Hide resolved
showcase/openfe_showcase.ipynb Show resolved Hide resolved
showcase/openfe_showcase.ipynb Show resolved Hide resolved
@@ -2,12 +2,11 @@
"cells": [
Copy link
Member

@IAlibay IAlibay Apr 26, 2024

Choose a reason for hiding this comment

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

Should this text re: explanation of mapping viz, go above when we look at atom mappings?


Reply via ReviewNB

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Moved this to the other section!

showcase/openfe_showcase.ipynb Show resolved Hide resolved
showcase/openfe_showcase.ipynb Show resolved Hide resolved
@@ -2,12 +2,11 @@
"cells": [
Copy link
Member

@IAlibay IAlibay Apr 26, 2024

Choose a reason for hiding this comment

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

Maybe to be discussed?

Overall this section confuses me a bit because we're doing things in vastly different ways for the two approaches.

Would it make more sense to "just" create the Transformations, and then for the "executing in Python" portion we use "Transformation.create()" to get the DAG out and run that?

Then in the CLI portion we can use the same Transformations, write them to disk and say we can use quickrun to run them?


Reply via ReviewNB

showcase/openfe_showcase.ipynb Show resolved Hide resolved
@@ -2,12 +2,11 @@
"cells": [
Copy link
Member

@IAlibay IAlibay Apr 26, 2024

Choose a reason for hiding this comment

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

[enhancement]

Making the inputs as bullet points may make things easier to read.


Reply via ReviewNB

Copy link
Member

@IAlibay IAlibay left a comment

Choose a reason for hiding this comment

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

This is great, thanks @hannahbaumann !

Just the one proposed enhancement but it's very much optional. Please merge when you want!

@hannahbaumann hannahbaumann merged commit 1ae7400 into openfe-1.0.0rc0-test Apr 26, 2024
2 checks passed
@hannahbaumann hannahbaumann deleted the add_options_mappers_networks branch April 26, 2024 13:05
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
3 participants