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

Configure binder #435

Merged
merged 35 commits into from Nov 2, 2017

Conversation

Projects
None yet
2 participants
@nickhand
Member

nickhand commented Oct 31, 2017

Binder seems to be back to working and everything looks good. This PR adds a binder badge to the README and docs that will launch a JupyterHub instance containing all of our cookbook recipes.

This sets up binder by doing the following:

  • move the old cookbook directory to bccp/nbodykit-cookbook
  • add the bccp/nbodykit-cookbook as a submodule in the docs/ directory
  • make sure nbodykit-cookbook has a conda environment.yml file for installing dependencies on binder

Solves #404

@nickhand

This comment has been minimized.

Member

nickhand commented Oct 31, 2017

@rainwoodman, there is definitely a downside to having the cookbook as a separate repo, but binder seems to works best with an isolated repo and I think the benefits of having binder for new users will outweigh any submodule confusion for developers. I've added some notes to the docs README about the work flow I am using...I am still a bit unfamiliar with submodules tho

@rainwoodman

This comment has been minimized.

Member

rainwoodman commented Oct 31, 2017

submodule command names are misleading. Be sure to note that

  • git submodule update : checkout the version of submodule as recorded

  • to update the ref of the submodule you have to go in the directory, git pull; then go out and git add; git commit. So it will always need a commit.

One possibility is to do more magic in readthedocs scripts to checkout a nbodykit-cookbook repo, grab the files and build. Then you don't have to deal with submodules.

@nickhand

This comment has been minimized.

Member

nickhand commented Nov 2, 2017

I think I like downloading the GitHub repo at build time on RTD. I think it's a better workflow to avoid the submodule confusion and keep all changes confined to the working directory of the nbodykit-cookbook repo. Let me see if I can get that set up

@nickhand

This comment has been minimized.

Member

nickhand commented Nov 2, 2017

I've got the workflow set up to download the cookbook on the file, I think this is ready to merge now

@nickhand nickhand merged commit c0a8855 into bccp:master Nov 2, 2017

3 checks passed

continuous-integration/travis-ci/pr The Travis CI build passed
Details
continuous-integration/travis-ci/push The Travis CI build passed
Details
coverage/coveralls First build on binder at 95.344%
Details

@nickhand nickhand deleted the nickhand:binder branch Nov 2, 2017

@nickhand nickhand referenced this pull request Nov 15, 2017

Closed

Add a binder shortcut. #404

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment