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

DOC: Add binder support #112

Merged
merged 7 commits into from Apr 30, 2020
Merged

Conversation

scottclowe
Copy link
Member

Add a .binder directory containing a minimal requirements.txt file which instructs binder to install our
requirements for the plots as fissa[plotting].

Note that this means that binder will be using the latest stable release on pypi, not the bleeding-edge version of fissa which is found in the master branch of the repository.

We also add a binder badge linking to the interactive notebooks. @swkeemink if you want to try out the notebooks before the PR is merged, go here https://mybinder.org/v2/gh/scottclowe/fissa/doc_binder?filepath=examples to check it out.

Closes #3.

@scottclowe scottclowe added the doc label Apr 8, 2020
@codecov
Copy link

codecov bot commented Apr 8, 2020

Codecov Report

Merging #112 into master will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##           master     #112   +/-   ##
=======================================
  Coverage   80.40%   80.40%           
=======================================
  Files           9        9           
  Lines         740      740           
  Branches      139      139           
=======================================
  Hits          595      595           
  Misses        109      109           
  Partials       36       36           

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 5edb324...8d378e8. Read the comment docs.

@scottclowe scottclowe force-pushed the doc_binder branch 3 times, most recently from b136dcf to 3b042ce Compare April 8, 2020 11:03
@scottclowe scottclowe force-pushed the doc_binder branch 6 times, most recently from c8a7c4f to a9f39b9 Compare April 18, 2020 18:20
Add a .binder directory, instructing binder to install our
requirements for the plots:

fissa[plotting]
sima

Note that this means that binder will be using the latest
stable release on pypi, not the bleeding-edge version of
fissa which is found in the master branch of the repository.

Because sima doesn't install on Python 3.7 and above, we also
specify the runtime to be Python 3.6.

specify binder python 3.6
@scottclowe scottclowe merged commit 2e7e861 into rochefort-lab:master Apr 30, 2020
@scottclowe scottclowe deleted the doc_binder branch April 30, 2020 08:45
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Turn iPython notebooks into Binders
1 participant