Skip to content

Commit

Permalink
qualify and summarize the general portability recommendations
Browse files Browse the repository at this point in the history
  • Loading branch information
svonworl committed Feb 16, 2024
1 parent 5403b3b commit 12a446e
Showing 1 changed file with 2 additions and 0 deletions.
2 changes: 2 additions & 0 deletions docs/advanced-topics/best-practices/notebook-portability.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,8 @@ Per the "Interoperable" and "Reusable" guidelines of the :ref:`dict FAIR` princi
- **Access remote data via publically-accessible urls and standard protocols.** If your notebook can always read the data it requires, it's more likely to run successfully.
- **Avoid using a custom kernel image, if possible.** Some notebook environments, such as Google Colab, don't allow you to use a custom kernel image.

Depending upon your goals for your notebook, you might choose to follow or ignore the above recommendations. However, keep in mind that as your notebook's needs diverge from the baseline level of support across all notebook environments - basically, for Jupyter notebooks, the ability to execute vanilla Python 3 code with no external dependencies - it becomes less likely to run everywhere.

Environment-Specific Recommendations
------------------------------------

Expand Down

0 comments on commit 12a446e

Please sign in to comment.