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

Add binder links #93

Merged
merged 6 commits into from
Oct 26, 2020
Merged

Add binder links #93

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
b3f65a3
add binder links to the readme
sroet Oct 23, 2020
70260fa
update online docs to include binder links
sroet Oct 23, 2020
bf64d7e
fix examples/index.rst to render correctly
sroet Oct 23, 2020
b3fad2f
add binder links
sroet Oct 24, 2020
ae75539
add jinja convert to other rst as well
sroet Oct 24, 2020
ddeef36
Update docs/examples/index.rst
sroet Oct 26, 2020
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
4 changes: 3 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@

[![Codacy Badge](https://api.codacy.com/project/badge/Grade/f7f3cf53698e4655ac8895f13fa5dea6)](https://www.codacy.com/app/dwhswenson/contact_map?utm_source=github.com&utm_medium=referral&utm_content=dwhswenson/contact_map&utm_campaign=Badge_Grade)
[![Maintainability](https://api.codeclimate.com/v1/badges/84768756d594176d8da6/maintainability)](https://codeclimate.com/github/dwhswenson/contact_map/maintainability)

[![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/dwhswenson/contact_map/master)
# Contact Map Explorer

This package provides tools for analyzing and exploring contacts
Expand Down Expand Up @@ -38,6 +38,8 @@ representing the fraction of trajectory time that the contact was present.

Full documentation is at http://contact-map.readthedocs.io/.

Try it out online: [![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/dwhswenson/contact_map/master?filepath=%2Fexamples) (Note: the performance of the online servers can vary widely.)

## Installation

The easiest way to install is with `conda`. Conda is a powerful package and
Expand Down
10 changes: 9 additions & 1 deletion docs/examples/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,19 @@ Examples
We have several examples to illustrate various features of the code. These
notebooks have been rendered here for the web, but the originals are
found in the ``examples/`` directory of the package, and you can run them
yourself!
yourself!

.. toctree::
:maxdepth: 1
:glob:

nb/*

You can also try them out online directly from your browser:

.. image:: https://mybinder.org/badge_logo.svg
:target: https://mybinder.org/v2/gh/dwhswenson/contact_map/master?filepath=%2Fexamples

(Note: the performance of the online servers can vary widely.)