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

Prepare notebooks for central examples #40

Merged
merged 2 commits into from
Jul 4, 2023
Merged

Conversation

Yoshanuikabundi
Copy link
Contributor

@Yoshanuikabundi Yoshanuikabundi commented Jul 4, 2023

We're moving towards a central examples page for OpenFF!

This PR just updates the examples to make them work for that purpose. Dependency install instructions are no longer necessary in each notebook because they're being unified in the central examples downloads (see the top of each notebook, though the CSS styling is not final). This should make it easier to both find and consume examples.

Changes to examples are synced when they make their way to conda forge - so users will always have examples that are consistent with the released version. Only the latest version is rendered, but users will be able to find earlier versions through the "View on GitHub" link. Links to run the notebook in Colab or download it with a helpful dependency installation script are also provided.

Changes made in this Pull Request:

  • Changes titles to make them clear outside the context of NAGL
  • Removes dependency installation instructions, as that is being unified with other examples

PR Checklist

  • CHANGELOG updated?

@lilyminium
Copy link
Collaborator

This is super cool, thanks Josh!

@lilyminium lilyminium merged commit 210d8d6 into main Jul 4, 2023
@lilyminium lilyminium deleted the central_examples branch July 4, 2023 05:40
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.

2 participants