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

📚 DOCS: Added a plotly example. #269

Merged
merged 4 commits into from
Oct 18, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
99 changes: 99 additions & 0 deletions docs/examples/plotly-example.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,99 @@
==============
Plotly Example
==============

Thebe can display output from plotly.py_.

.. _plotly.py: https://github.com/plotly/plotly.py

Setup
=====

Be sure to load require.js before any of your thebe activation code so that the
Jupyter widgets can function:

.. code-block:: html

<script src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.4/require.min.js"></script>

Configure thebe and load it:

.. code-block:: html

<script type="text/x-thebe-config">
{
requestKernel: true,
binderOptions: {
repo: "plotly/plotly.py",
ref: "doc-prod",
binderUrl: "https://binder.libretexts.org",
repoProvider: "github",
},
}
</script>
<script src="https://unpkg.com/thebelab@latest/lib/index.js"></script>

Create a button to activate thebe:

.. code-block:: html

<button id="activateButton" style="width: 120px; height: 40px; font-size: 1.5em;">
Activate
</button>
<script>
var bootstrapThebe = function() {
thebelab.bootstrap();
}
document.querySelector("#activateButton").addEventListener('click', bootstrapThebe)
</script>

Now add code cells between these HTML tags:

.. code-block:: html

<pre data-executable="true" data-language="python"></pre>

Example
=======

.. raw:: html

<script src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.4/require.min.js"></script>
<script type="text/x-thebe-config">
{
requestKernel: true,
binderOptions: {
repo: "plotly/plotly.py",
ref: "doc-prod",
repoProvider: "github",
},
}
</script>
<script src="https://unpkg.com/thebelab@latest/lib/index.js"></script>

Press the "Activate" button below to connect to a Jupyter server:

.. raw:: html

<button id="activateButton" style="width: 120px; height: 40px; font-size: 1.5em;">
Activate
</button>
<script>
var bootstrapThebe = function() {
thebelab.bootstrap();
}
document.querySelector("#activateButton").addEventListener('click', bootstrapThebe)
</script>

Here is a distribution plot example from https://plotly.com/python/distplot/
(MIT License):

.. raw:: html

<pre data-executable="true" data-language="python">
import plotly.express as px
df = px.data.tips()
fig = px.histogram(df, x="total_bill", y="tip", color="sex", marginal="rug",
hover_data=df.columns)
fig.show()
</pre>
1 change: 1 addition & 0 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -102,5 +102,6 @@ Horizon 2020 European Research Infrastructure project (676541).
howto/initialize_cells
minimal_example
examples/ipyleaflet_example
examples/plotly-example
contribute
api