hackingmaterials / matminer_examples

A repo of examples for the matminer (https://github.com/hackingmaterials/matminer) code
Other
103 stars 60 forks source link

Binder examples cannot be run interactively #41

Closed utf closed 6 years ago

utf commented 6 years ago

When running the notebooks in binder (as per the documentation), the lack of API keys mean the notebooks cannot be run interactively. Another issue is that matminer is not installed using the optional dependencies, so the MPDS examples fail with another error message.

Possible solutions:

If binder provides other benefits further to running the notebooks interactively then I guess it could make sense to leave the link in the documentation.

computron commented 6 years ago

Would it be possible to get the binder links to run by adding matminer as an optional-dep and also requiring the user to edit their API keys? e.g. there is a cell that looks like this:

# Enter your API key below!
API_KEY = None
if not API_KEY:
    raise ValueError("You need to modify this notebook and enter your API key above!!")

Then when running the binder notebook it will be clear to everyone that they need to enter their API key to proceed.