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

Build examples against Interchange 0.3.25 #46

Merged
merged 5 commits into from
Apr 3, 2024
Merged

Conversation

mattwthompson
Copy link
Member

No description provided.

@mattwthompson
Copy link
Member Author

/generate-cache

@mattwthompson
Copy link
Member Author

/regenerate-cache

Copy link

This repository caches data generated from notebooks stored in other repositories in the _cookbook_data_* branches. Regenerating this cache takes about half an hour, so it is not done automatically in PRs. The current value of the cache from the main branch has been copied over to this PR's cache.

To regenerate the cache for this PR, create a comment on this PR consisting only of the string:

/regenerate-cache

Copy link

A workflow has been dispatched to regenerate the cookbook cache for this PR.

  • Run ID: 8481436546
  • Triggering actor: github-actions[bot]
  • Target branch: interchange-0.3.25
  • Deployment branch: _cookbook_data_PR46

Copy link

A workflow dispatched to regenerate the cookbook cache for this PR has just finished.

  • Run ID: 8481436546
  • Triggering actor: github-actions[bot]
  • Target branch: interchange-0.3.25
  • Deployment branch: _cookbook_data_PR46
  • Status: success

If the workflow was successful, changes will only be visible in the ReadTheDocs preview after it has been rebuilt.

@mattwthompson
Copy link
Member Author

While working on this, I noticed two sore spots:

  1. These two examples have the same name:
    image

  2. Interchange's examples use "doing this" language whereas more of the examples use "do this." I'm standardizing Interchange's examples of the latter. (I also come across another trove of terms that are less-than-standardized in our infrastructure, but if I start down that path, I'll end up on a journey with Alice to Wonderland instead of a merge commit.)

I changed these upstream: openforcefield/openff-interchange@0cf4387

@mattwthompson
Copy link
Member Author

/regenerate-cache

Copy link

A workflow has been dispatched to regenerate the cookbook cache for this PR.

  • Run ID: 8482031430
  • Triggering actor: github-actions[bot]
  • Target branch: interchange-0.3.25
  • Deployment branch: _cookbook_data_PR46

Copy link

A workflow dispatched to regenerate the cookbook cache for this PR has just finished.

  • Run ID: 8482031430
  • Triggering actor: github-actions[bot]
  • Target branch: interchange-0.3.25
  • Deployment branch: _cookbook_data_PR46
  • Status: success

If the workflow was successful, changes will only be visible in the ReadTheDocs preview after it has been rebuilt.

@mattwthompson
Copy link
Member Author

@mattwthompson mattwthompson marked this pull request as ready for review April 1, 2024 14:32
Copy link
Contributor

@Yoshanuikabundi Yoshanuikabundi left a comment

Choose a reason for hiding this comment

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

Great @mattwthompson, thanks for this! I'd like to avoid pip installing things that are available on Conda if at all possible - let me know if there's something wrong with that.

If you accept my suggestions and regenerating the cache again still works, consider this approval to merge!

Comment on lines 27 to 28
- pip:
- git+https://github.com/openforcefield/openff-interchange.git@v0.3.25b1
Copy link
Contributor

Choose a reason for hiding this comment

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

Can this be removed now that 0.3.25 has been released?

Suggested change
- pip:
- git+https://github.com/openforcefield/openff-interchange.git@v0.3.25b1

If you want a version of Interchange that's compatible with 0.3.25 installed with conda, but you want to take the examples from this tag, the best way to do that is to get ~=0.3.25 in the regular way and then set the tag in the GITHUB_REPOS global variable (l33-39 in globals_.py, change "openforcefield/openff-interchange" to "openforcefield/openff-interchange@v0.3.25b1"). I'd like to avoid pip installing things in this environment if possible.

Copy link
Member Author

Choose a reason for hiding this comment

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

I just forgot to update this is all

@@ -14,7 +14,7 @@ dependencies:
- packaging
# Examples
- openff-toolkit-examples>=0.15.2
- openff-interchange>=0.3.18
- openff-interchange ~=0.3.25
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
- openff-interchange ~=0.3.25
- openff-interchange >=0.3.25

I think >= is actually the desired semantics - we want this environment not to need updating if an incompatible version of Interchange is released. There isn't any assumption that code will remain compatible with Interchange, because any code that uses Interchange comes either from the selected version of Interchange or a compatible version of a different package.

I can see that ~= is more appropriate for a downloadable environment for end-users, but the environment file is checked daily and isn't really designed for users to hold on to long term before they solve it. Users should re-download the new example and get the updated environment rather than use an old download.

What do you think?

Copy link
Member Author

Choose a reason for hiding this comment

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

IIUC, ~= will pull down any 0.3.x that's released in the future but never pull down the 0.4.0 that I'm hoping exists at some point in the future.

In this case the difference may not be so big if 0.4.x doesn't break any examples, which is my hope, and if I'm going to be manually updating this anyway, which is more or less my expectation.

Copy link
Contributor

Choose a reason for hiding this comment

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

Yeah ok totally fair. Sorry, I think I was worried that I'd be updating pins every time a minor release came out, but if it's your job to fix your examples then it's totally fair that you get to choose how to manage your releases!

@mattwthompson
Copy link
Member Author

/regenerate-cache

Copy link

github-actions bot commented Apr 3, 2024

A workflow has been dispatched to regenerate the cookbook cache for this PR.

  • Run ID: 8538615288
  • Triggering actor: github-actions[bot]
  • Target branch: interchange-0.3.25
  • Deployment branch: _cookbook_data_PR46

Copy link

github-actions bot commented Apr 3, 2024

A workflow dispatched to regenerate the cookbook cache for this PR has just finished.

  • Run ID: 8538615288
  • Triggering actor: github-actions[bot]
  • Target branch: interchange-0.3.25
  • Deployment branch: _cookbook_data_PR46
  • Status: failure

If the workflow was successful, changes will only be visible in the ReadTheDocs preview after it has been rebuilt.

Copy link

github-actions bot commented Apr 3, 2024

A workflow has been dispatched to regenerate the cookbook cache for this PR.

  • Run ID: 8538615288
  • Triggering actor: mattwthompson
  • Target branch: interchange-0.3.25
  • Deployment branch: _cookbook_data_PR46

Copy link

github-actions bot commented Apr 3, 2024

A workflow dispatched to regenerate the cookbook cache for this PR has just finished.

  • Run ID: 8538615288
  • Triggering actor: mattwthompson
  • Target branch: interchange-0.3.25
  • Deployment branch: _cookbook_data_PR46
  • Status: failure

If the workflow was successful, changes will only be visible in the ReadTheDocs preview after it has been rebuilt.

Copy link

github-actions bot commented Apr 3, 2024

A workflow has been dispatched to regenerate the cookbook cache for this PR.

  • Run ID: 8538615288
  • Triggering actor: mattwthompson
  • Target branch: interchange-0.3.25
  • Deployment branch: _cookbook_data_PR46

@mattwthompson
Copy link
Member Author

QCArchive is down, not sure for how long

Copy link

github-actions bot commented Apr 3, 2024

A workflow dispatched to regenerate the cookbook cache for this PR has just finished.

  • Run ID: 8538615288
  • Triggering actor: mattwthompson
  • Target branch: interchange-0.3.25
  • Deployment branch: _cookbook_data_PR46
  • Status: failure

If the workflow was successful, changes will only be visible in the ReadTheDocs preview after it has been rebuilt.

@Yoshanuikabundi
Copy link
Contributor

I wonder if we could set up HOSTS to point qcarchive.molssi.org to localhost and run a dummy server in the CI workflow to just serve up the exact API points we actually use in the examples... probably more trouble than it's worth.

@mattwthompson
Copy link
Member Author

It's usually somewhat flaky in CI, so not relying on MolSSI's server would be an improvement, but I wouldn't bet on that being a small amount of work

@mattwthompson
Copy link
Member Author

/regenerate-cache

Copy link

github-actions bot commented Apr 3, 2024

A workflow has been dispatched to regenerate the cookbook cache for this PR.

  • Run ID: 8543770845
  • Triggering actor: github-actions[bot]
  • Target branch: interchange-0.3.25
  • Deployment branch: _cookbook_data_PR46

Copy link

github-actions bot commented Apr 3, 2024

A workflow dispatched to regenerate the cookbook cache for this PR has just finished.

  • Run ID: 8543770845
  • Triggering actor: github-actions[bot]
  • Target branch: interchange-0.3.25
  • Deployment branch: _cookbook_data_PR46
  • Status: success

If the workflow was successful, changes will only be visible in the ReadTheDocs preview after it has been rebuilt.

@mattwthompson
Copy link
Member Author

Rebuilding and let's see ...

@mattwthompson mattwthompson merged commit 4d4636f into main Apr 3, 2024
4 of 5 checks passed
@mattwthompson mattwthompson deleted the interchange-0.3.25 branch April 3, 2024 20:15
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