From 12a446e517865dc195228ef169a99998e66cc37c Mon Sep 17 00:00:00 2001 From: Stephen Von Worley Date: Thu, 15 Feb 2024 16:16:20 -0800 Subject: [PATCH] qualify and summarize the general portability recommendations --- docs/advanced-topics/best-practices/notebook-portability.rst | 2 ++ 1 file changed, 2 insertions(+) diff --git a/docs/advanced-topics/best-practices/notebook-portability.rst b/docs/advanced-topics/best-practices/notebook-portability.rst index a3444b7a..b01d5064 100644 --- a/docs/advanced-topics/best-practices/notebook-portability.rst +++ b/docs/advanced-topics/best-practices/notebook-portability.rst @@ -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 ------------------------------------