Added pooch registries for data files

docs/source/examples/notebooks/initialize-model-with-solution.ipynb

@@ -23,10 +23,15 @@
      "name": "stdout",
      "output_type": "stream",
      "text": [
-      "\u001b[33mWARNING: You are using pip version 21.0.1; however, version 21.1 is available.\n",
-      "You should consider upgrading via the '/Users/vsulzer/Documents/Energy_storage/PyBaMM/.tox/dev/bin/python -m pip install --upgrade pip' command.\u001b[0m\n",
       "Note: you may need to restart the kernel to use updated packages.\n"
      ]
+    },
+    {
+     "name": "stderr",
+     "output_type": "stream",
+     "text": [
+      "An NVIDIA GPU may be present on this machine, but a CUDA-enabled jaxlib is not installed. Falling back to cpu.\n"
+     ]
     }
    ],
    "source": [
@@ -76,8 +81,9 @@
    "outputs": [],
    "source": [
     "# import drive cycle from file\n",
+    "data_loader = pybamm.DataLoader()\n",
     "drive_cycle = pd.read_csv(\n",
-    "    \"pybamm/input/drive_cycles/US06.csv\", comment=\"#\", header=None\n",
+    "    f\"{data_loader.getdata(\"US06.csv\")}\", comment=\"#\", header=None\n",
     ").to_numpy()\n",
     "# create interpolant\n",
     "param = model.default_parameter_values\n",
@@ -160,7 +166,7 @@
     {
      "data": {
       "application/vnd.jupyter.widget-view+json": {
-       "model_id": "7ad44c260ec446e0bd04a2f7dfbf8c65",
+       "model_id": "cd7fa37499ed49a7a8fa691a0ad9ffa6",
        "version_major": 2,
        "version_minor": 0
       },
@@ -174,7 +180,7 @@
     {
      "data": {
       "text/plain": [
-       "<pybamm.plotting.quick_plot.QuickPlot at 0x1447078e0>"
+       "<pybamm.plotting.quick_plot.QuickPlot at 0x71a9e17ab080>"
       ]
      },
      "execution_count": 6,
@@ -241,7 +247,7 @@
     {
      "data": {
       "application/vnd.jupyter.widget-view+json": {
-       "model_id": "aaf63750ed354d1987703fd2fdde83af",
+       "model_id": "22c047080ebe4a14a664affed4e97ba1",
        "version_major": 2,
        "version_minor": 0
       },
@@ -255,7 +261,7 @@
     {
      "data": {
       "text/plain": [
-       "<pybamm.plotting.quick_plot.QuickPlot at 0x10437c370>"
+       "<pybamm.plotting.quick_plot.QuickPlot at 0x71a9d02dac30>"
       ]
      },
      "execution_count": 8,
@@ -329,7 +335,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.8.10"
+   "version": "3.12.3"
   },
   "toc": {
    "base_numbering": 1,

docs/source/examples/notebooks/models/saving_models.ipynb

@@ -354,7 +354,7 @@
  ],
  "metadata": {
   "kernelspec": {
-   "display_name": "dev",
+   "display_name": "Python 3 (ipykernel)",
    "language": "python",
    "name": "python3"
   },
@@ -368,10 +368,9 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.11.6"
-  },
-  "orig_nbformat": 4
+   "version": "3.12.3"
+  }
  },
  "nbformat": 4,
- "nbformat_minor": 2
+ "nbformat_minor": 4
 }

docs/source/examples/notebooks/parameterization/change-input-current.ipynb

@@ -38,6 +38,13 @@
      "text": [
       "Note: you may need to restart the kernel to use updated packages.\n"
      ]
+    },
+    {
+     "name": "stderr",
+     "output_type": "stream",
+     "text": [
+      "An NVIDIA GPU may be present on this machine, but a CUDA-enabled jaxlib is not installed. Falling back to cpu.\n"
+     ]
     }
    ],
    "source": [
@@ -76,7 +83,7 @@
     {
      "data": {
       "application/vnd.jupyter.widget-view+json": {
-       "model_id": "aef64b871f1346a4b42c722c7eecfe38",
+       "model_id": "174048e3ccf74930a39a249dc0723975",
        "version_major": 2,
        "version_minor": 0
       },
@@ -86,6 +93,16 @@
      },
      "metadata": {},
      "output_type": "display_data"
+    },
+    {
+     "data": {
+      "text/plain": [
+       "<pybamm.plotting.quick_plot.QuickPlot at 0x79ada1f321e0>"
+      ]
+     },
+     "execution_count": 2,
+     "metadata": {},
+     "output_type": "execute_result"
     }
    ],
    "source": [
@@ -110,13 +127,13 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 3,
+   "execution_count": 4,
    "metadata": {},
    "outputs": [
     {
      "data": {
       "application/vnd.jupyter.widget-view+json": {
-       "model_id": "6447d4f706374208b5cbd283577b5da5",
+       "model_id": "bd1dbdfee61f4e518c3534b44e0ce879",
        "version_major": 2,
        "version_minor": 0
       },
@@ -126,6 +143,16 @@
      },
      "metadata": {},
      "output_type": "display_data"
+    },
+    {
+     "data": {
+      "text/plain": [
+       "<pybamm.plotting.quick_plot.QuickPlot at 0x79ae443f29f0>"
+      ]
+     },
+     "execution_count": 4,
+     "metadata": {},
+     "output_type": "execute_result"
     }
    ],
    "source": [
@@ -148,17 +175,26 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 4,
+   "execution_count": 5,
    "metadata": {},
-   "outputs": [],
+   "outputs": [
+    {
+     "name": "stderr",
+     "output_type": "stream",
+     "text": [
+      "Downloading file 'US06.csv' from 'https://github.com/pybamm-team/pybamm-data/releases/download/v1.0.0/US06.csv' to '/home/santa/.cache/pybamm'.\n"
+     ]
+    }
+   ],
    "source": [
     "import pandas as pd  # needed to read the csv data file\n",
     "\n",
     "model = pybamm.lithium_ion.DFN()\n",
     "\n",
     "# import drive cycle from file\n",
+    "data_loader = pybamm.DataLoader()\n",
     "drive_cycle = pd.read_csv(\n",
-    "    \"pybamm/input/drive_cycles/US06.csv\", comment=\"#\", header=None\n",
+    "    f\"{data_loader.getdata(\"US06.csv\")}\", comment=\"#\", header=None\n",
     ").to_numpy()\n",
     "\n",
     "# load parameter values\n",
@@ -185,13 +221,13 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 5,
+   "execution_count": 6,
    "metadata": {},
    "outputs": [
     {
      "data": {
       "application/vnd.jupyter.widget-view+json": {
-       "model_id": "84f87c3d21644c20bafdac8e9b69247d",
+       "model_id": "513c59118a6144a8a205510aaa9e9527",
        "version_major": 2,
        "version_minor": 0
       },
@@ -201,6 +237,16 @@
      },
      "metadata": {},
      "output_type": "display_data"
+    },
+    {
+     "data": {
+      "text/plain": [
+       "<pybamm.plotting.quick_plot.QuickPlot at 0x79ad7d74c620>"
+      ]
+     },
+     "execution_count": 6,
+     "metadata": {},
+     "output_type": "execute_result"
     }
    ],
    "source": [
@@ -233,7 +279,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 6,
+   "execution_count": 7,
    "metadata": {},
    "outputs": [],
    "source": [
@@ -258,7 +304,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 7,
+   "execution_count": 8,
    "metadata": {},
    "outputs": [],
    "source": [
@@ -283,13 +329,13 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 8,
+   "execution_count": 9,
    "metadata": {},
    "outputs": [
     {
      "data": {
       "application/vnd.jupyter.widget-view+json": {
-       "model_id": "6c06d938eca0491d88cdcbb29c59cd2a",
+       "model_id": "40a6ad712e184ba1a161932440d7a99d",
        "version_major": 2,
        "version_minor": 0
       },
@@ -299,6 +345,16 @@
      },
      "metadata": {},
      "output_type": "display_data"
+    },
+    {
+     "data": {
+      "text/plain": [
+       "<pybamm.plotting.quick_plot.QuickPlot at 0x79ad73fea6c0>"
+      ]
+     },
+     "execution_count": 9,
+     "metadata": {},
+     "output_type": "execute_result"
     }
    ],
    "source": [
@@ -352,7 +408,7 @@
  ],
  "metadata": {
   "kernelspec": {
-   "display_name": "Python 3.9.13 ('conda_jl')",
+   "display_name": "Python 3 (ipykernel)",
    "language": "python",
    "name": "python3"
   },
@@ -366,7 +422,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.9.13"
+   "version": "3.12.3"
   },
   "toc": {
    "base_numbering": 1,
@@ -388,5 +444,5 @@
   }
  },
  "nbformat": 4,
- "nbformat_minor": 2
+ "nbformat_minor": 4
 }

examples/scripts/compare_comsol/compare_comsol_DFN.py

@@ -17,8 +17,9 @@
 C_rate = "1"  # choose the key from the above dictionary of available results
 
 # load the comsol results
+data_loader = pybamm.DataLoader()
 comsol_results_path = pybamm.get_parameters_filepath(
-    f"input/comsol_results/comsol_{C_rate}C.json"
+    f"{data_loader.getdata(f"comsol_{C_rate}C.json")}"
 )
 
 comsol_variables = json.load(open(comsol_results_path))

examples/scripts/compare_comsol/discharge_curve.py

@@ -55,11 +55,12 @@
 plt.ylabel(r"$\vert V - V_{comsol} \vert$", fontsize=20)
 colors = iter(plt.cycler(color="bgrcmyk"))
 
+data_loader = pybamm.DataLoader()
 for key, C_rate in C_rates.items():
     current = 24 * C_rate
     # load the comsol results
     comsol_results_path = pybamm.get_parameters_filepath(
-        f"input/comsol_results/comsol_{key}C.json"
+        f"{data_loader.getdata(f"comsol_{key}C.json")}"
     )
     comsol_variables = json.load(open(comsol_results_path))
     comsol_time = np.array(comsol_variables["time"])

examples/scripts/drive_cycle.py

@@ -15,8 +15,9 @@
 
 
 # import drive cycle from file
+data_loader = pybamm.DataLoader()
 drive_cycle = pd.read_csv(
-    "pybamm/input/drive_cycles/US06.csv", comment="#", header=None
+    data_loader.getdata("US06.csv"), comment="#", header=None
 ).to_numpy()
 
 # create interpolant

examples/scripts/experiment_drive_cycle.py

@@ -10,8 +10,9 @@
 pybamm.set_logging_level("INFO")
 
 # import drive cycle from file
+data_loader = pybamm.DataLoader()
 drive_cycle_current = pd.read_csv(
-    "pybamm/input/drive_cycles/US06.csv", comment="#", header=None
+    f"{data_loader.getdata("US06.csv")}, comment="  # ", header=None
 ).to_numpy()
 
 

pybamm/__init__.py

@@ -193,6 +193,9 @@
 # Callbacks
 from . import callbacks
 
+# Pybamm Data manager using pooch
+from .pybammdata import DataLoader
+
 # Remove any imported modules, so we don't expose them as part of pybamm
 del sys