Skip to content

Commit 877bf5e

Browse files
ColCarrolltwiecki
authored andcommitted
Add binder badge to readme (#2758)
* Add binder badge to readme * Use rst instead of .md * Use proper rst * Add full requirements to binder * Add master pymc3 * Add more dev requirements to be able to run notebooks * Unpin IPython to allow python2.7 builds * Add bokeh to requirements * Move badge to top
1 parent da3ef19 commit 877bf5e

File tree

3 files changed

+14
-3
lines changed

3 files changed

+14
-3
lines changed

README.rst

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,15 +3,16 @@
33
:alt: PyMC3 logo
44
:align: center
55

6-
|Build Status| |Coverage| |NumFOCUS_badge|
6+
|Build Status| |Coverage| |NumFOCUS_badge| |Binder|
77

88
PyMC3 is a Python package for Bayesian statistical modeling and Probabilistic Machine Learning
99
which focuses on advanced Markov chain Monte Carlo and variational fitting
1010
algorithms. Its flexibility and extensibility make it applicable to a
1111
large suite of problems.
1212

13-
Check out the `getting started guide <http://docs.pymc.io/notebooks/getting_started>`__!
14-
13+
Check out the `getting started guide <http://docs.pymc.io/notebooks/getting_started>`__, or
14+
`interact with live examples <https://mybinder.org/v2/gh/pymc-devs/pymc3/master?filepath=%2Fdocs%2Fsource%2Fnotebooks>`__
15+
using Binder!
1516

1617
Features
1718
========
@@ -176,6 +177,8 @@ Sponsors
176177

177178
|Quantopian|
178179

180+
.. |Binder| image:: https://mybinder.org/badge.svg
181+
:target: https://mybinder.org/v2/gh/pymc-devs/pymc3/master?filepath=%2Fdocs%2Fsource%2Fnotebooks
179182
.. |Build Status| image:: https://travis-ci.org/pymc-devs/pymc3.png?branch=master
180183
:target: https://travis-ci.org/pymc-devs/pymc3
181184
.. |Coverage| image:: https://coveralls.io/repos/github/pymc-devs/pymc3/badge.svg?branch=master

binder/requirements.txt

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
-r ../requirements-dev.txt
2+
# this installs pymc3 itself. it is funny that this is an absolute path,
3+
# but reqirements-dev.txt is relative.
4+
.

requirements-dev.txt

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,8 @@
1+
bokeh>=0.12.13
12
CommonMark==0.5.4
23
h5py>=2.7.0
4+
ipython
5+
Keras>=2.0.8
36
matplotlib>=1.5.0
47
mock>=2.0.0; python_version < '3.4'
58
nbsphinx>=0.2.13
@@ -13,5 +16,6 @@ pytest-cov>=2.5.1
1316
pytest>=3.0.7
1417
recommonmark>=0.4.0
1518
scipy>=0.12.0
19+
seaborn>=0.8.1
1620
sphinx-autobuild==0.7.1
1721
sphinx>=1.5.5

0 commit comments

Comments
 (0)