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.

Sign up for GitHub

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

Jump to bottom

Implement the use of "launch binder" #250

Closed
rhutten opened this issue Jun 15, 2022 · 1 comment · Fixed by #264 · May be fixed by #309
Closed

Implement the use of "launch binder" #250

rhutten opened this issue Jun 15, 2022 · 1 comment · Fixed by #264 · May be fixed by #309
Assignees
@BeardedPlatypus
Labels
type: dependencies Dependency updates, compatibility type: documentation Improvements or additions to documentation
Projects
HYDROLIB-core
Milestone
0.3.1

Comments

@rhutten
Copy link
Collaborator

rhutten commented Jun 15, 2022 •
edited

What is the need for this task.
The HYDROLIB team strives to create tutorials, which can be executed through binder.

What is the task?

  • create environment.yml or use dockerfile
  • make launch buttons at each notebook and at the introduction of the tutorials
  • implement binder
@rhutten rhutten added type: documentation Improvements or additions to documentation type: dependencies Dependency updates, compatibility labels Jun 15, 2022
@rhutten rhutten self-assigned this Jun 15, 2022
@rhutten rhutten added this to To do in HYDROLIB-core via automation Jun 15, 2022
@rhutten rhutten mentioned this issue Jun 20, 2022
Merged
@BeardedPlatypus BeardedPlatypus moved this from To do to In progress in HYDROLIB-core Jun 28, 2022
@BeardedPlatypus BeardedPlatypus linked a pull request Jun 28, 2022 that will close this issue
feat: add binder support with a dockerfile #264
Merged
@BeardedPlatypus BeardedPlatypus mentioned this issue Jun 28, 2022
Merged
@BeardedPlatypus
Copy link
Contributor

In #264 a binder Dockerfile has been added. This approach leverages the docker support within Binder. Using either requirements.txt or an environments.yml proved troublesome, especially in resolving the hydrolib-core and meshkernel packages. Instead the Dockerfile copies the HYDROLIB-core repository, and then installs it locally through the pyproject.toml. This means we do not need to synchronize any dependencies, which simplifies the process.

In order to create a binding for a jupyter notebook, the mybinder.org website can be used:

image

Because the Docker image copies the whole repository, we can specify the jupyter notebook path relative to the repository root. The above settings were used to generate the launch button in #264.

@BeardedPlatypus BeardedPlatypus moved this from In progress to Ready to review in HYDROLIB-core Jun 28, 2022
@arthurvd arthurvd moved this from Ready to review to Reviewer follow up in HYDROLIB-core Jul 6, 2022
@arthurvd arthurvd assigned BeardedPlatypus and unassigned rhutten Jul 6, 2022
@BeardedPlatypus BeardedPlatypus moved this from Reviewer follow up to Ready to review in HYDROLIB-core Jul 11, 2022
@priscavdsluis priscavdsluis added this to the Release 0.4 milestone Jul 14, 2022
@arthurvd arthurvd mentioned this issue Jul 15, 2022
Open
HYDROLIB-core automation moved this from Ready to review to Done Jul 19, 2022
This was referenced Aug 18, 2022
Open
Closed
@priscavdsluis priscavdsluis modified the milestones: Release 0.4, 0.3.1 Oct 25, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@BeardedPlatypus BeardedPlatypus

Labels
type: dependencies Dependency updates, compatibility type: documentation Improvements or additions to documentation
Projects
HYDROLIB-core
  
Done
Milestone
0.3.1
3 participants
@BeardedPlatypus @priscavdsluis @rhutten