Skip to content

Binder dependencies #617

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

Merged
merged 13 commits into from
Oct 29, 2024
Merged

Binder dependencies #617

merged 13 commits into from
Oct 29, 2024

Conversation

jeffjennings
Copy link
Member

@jeffjennings jeffjennings commented Oct 22, 2024

After removing the global requirements.txt in #606, the Binder build broke because it expects that file. In general it expects a single requirements file for all notebooks (see here; for details of how to specify requirements, see here).

This PR adds binder/requirements.txt to the top-level directory, which Binder uses to successfully build. This single requirements file currently works for all notebooks. If in the future individual notebooks need packages installed with versions that differ from those in binder/requirements.txt, execution of those notebooks in Binder will fail.

PR also updates text in the README.

Closes #615
Closes #616
Closes #535

  • Check the box to confirm that you are familiar with the contributing guidelines and/or indicate (check the box) that you are familiar with our contributing workflow.
  • Confirm that any contributed tutorials contain a complete Introduction which includes an Author list, Learning Goals, Keywords, Companion Content (if applicable), and a Summary.
  • Check the box to confirm that you are familiar with the Astropy community code of conduct and you agree to follow the CoC.

@jeffjennings jeffjennings deleted the binder_build branch October 24, 2024 15:56
@jeffjennings jeffjennings restored the binder_build branch October 28, 2024 18:05
@jeffjennings jeffjennings reopened this Oct 28, 2024
@adrn
Copy link
Contributor

adrn commented Oct 29, 2024

I think this approach is fine and practical, but I wonder if we want a mechanism to automatically generate this top-level requirements file based on all of the individual tutorial requirements files?

@adrn
Copy link
Contributor

adrn commented Oct 29, 2024

I guess then there will be ambiguous cases if there are disagreements in version requirements... I think I'm ok with this approach for now (even though there is duplicated information that we have to manually keep in sync) but let's make an issue with the aspirational goal of having a script to "build" the global requirements file automatically.

@adrn adrn merged commit 5b73553 into astropy-learn:main Oct 29, 2024
3 checks passed
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.

Binder notebook build broken Binder hosting not working Update README to use new Makefile
2 participants