Enabling Repository on Binder

[isaacgsmith]

This allows for the TARDIS repository to be built on binder, which will in turn allow for the running of TARDIS online.

You can see the binder built on my fork here.

Type of change

• Bug fix.
• New feature.
• Breaking change.
• None of the above.

Checklist

• My change requires a change to the documentation.
  • I have updated the documentation accordingly.
  • (optional) I have built the documentation on my fork following the instructions.
• I have assigned and requested two reviewers for this pull request.

[tardis-bot]

Before a pull request is accepted, it must meet the following criteria:

• Is the necessary information provided?
• Is this a duplicate PR?
  • If a new PR is clearly a duplicate, ask how this PR is different from the original PR?
  • If this PR is about to be merged, close the original PR with a link to this new PR that solved the issue.
• Does it pass existing tests and are new tests provided if required?
  • The test coverage should not decrease, and for new features should be close to 100%.
• Is the code tidy?
  • No unnecessary print lines or code comments.

[codecov]

Codecov Report

Merging #1678 (70162f1) into master (c47a3df) will not change coverage.
The diff coverage is n/a.

❗ Current head 70162f1 differs from pull request most recent head 089358b. Consider uploading reports for the commit 089358b to get more accurate results

@@           Coverage Diff           @@
##           master    #1678   +/-   ##
=======================================
  Coverage   61.89%   61.89%           
=======================================
  Files          62       62           
  Lines        5732     5732           
=======================================
  Hits         3548     3548           
  Misses       2184     2184           

---

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 c47a3df...089358b. Read the comment docs.

[epassaro]

• Is the cd command needed? If that's true, why not doing cd ..? It's unclear what's the $HOME dir for binder (it's difficult to track what's $HOME for every CI/CD service!). Using the latter it's more clear, the script is going to the parent directory before executing the command.

• Try install instead of develop, it's preferred.

• Add a new blank line at the end of the file.

[isaacgsmith]

• Is the cd command needed? If that's true, why not doing cd ..? It's unclear what's the $HOME dir for binder (it's difficult to track what's $HOME for every CI/CD service!). Using the latter it's more clear, the script is going to the parent directory before executing the command.
• Try install instead of develop, it's preferred.
• Add a new blank line at the end of the file.

All of those changes have been made and binder still works! I seemingly overcomplicated the cd part.

[epassaro]

@smithis7

Are you interested in implementing a binder badge on the nbsphinx prolog like this?

I think it's better than have the binder badge on README.rst.

If you are interested, see their conf.py.

[isaacgsmith]

@smithis7

Are you interested in implementing a binder badge on the nbsphinx prolog like this?

I think it's better than have the binder badge on README.rst.

If you are interested, see their conf.py.

I actually have a few different ideas on this that are contingent on me getting a few packages working. For now I think we should leave conf.py as it is but possibly change it in the future.