Docs: deps

GilesStrong · Feb 17, 2024 · 2f590ba · 2f590ba
1 parent f6ea4d7
commit 2f590ba
Show file tree

Hide file tree

Showing 7 changed files with 63 additions and 87 deletions.
diff --git a/README.md b/README.md
@@ -85,7 +85,7 @@ Finally, make sure everything is working as expected by running the tests:
 poetry run pytest tests
 ```
 
-For those unfamiliar with `poetry`, basically just prepend commands with `poetry run` to use the stuff installed within the local environment. This local environment is basically a python virtual environment. To correctly set up the interpreter in your IDE, use `poetry run which python` to see the path to the correct python executable
+For those unfamiliar with `poetry`, basically just prepend commands with `poetry run` to use the stuff installed within the local environment, e.g. `poetry run jupyter notebook` to start a jupyter notebook server. This local environment is basically a python virtual environment. To correctly set up the interpreter in your IDE, use `poetry run which python` to see the path to the correct python executable.
 
 ## Examples
 
@@ -105,7 +105,7 @@ If you want to run notebooks on a remote cluster but access them on the browser
 
 On the cluster, run:
 ```
-jupyter notebook --no-browser --port=8889
+poetry run jupyter notebook --no-browser --port=8889
 ```
 
 On your local computer, you need to set up a forwarding that picks the flux of data from the cluster via a local port, and makes it available on another port as if the server was in the local machine:

diff --git a/docs/source/installation.md b/docs/source/installation.md
@@ -51,7 +51,7 @@ Finally, make sure everything is working as expected by running the tests:
 poetry run pytest tests
 ```
 
-For those unfamiliar with `poetry`, basically just prepend commands with `poetry run` to use the stuff installed within the local environment. This local environment is basically a python virtual environment. To correctly set up the interpreter in your IDE, use `poetry run which python` to see the path to the correct python executable
+For those unfamiliar with `poetry`, basically just prepend commands with `poetry run` to use the stuff installed within the local environment, e.g. `poetry run jupyter notebook` to start a jupyter notebook server.. This local environment is basically a python virtual environment. To correctly set up the interpreter in your IDE, use `poetry run which python` to see the path to the correct python executable.
 
 ## Examples
 
@@ -71,7 +71,7 @@ If you want to run notebooks on a remote cluster but access them on the browser
 
 On the cluster, run:
 ```
-jupyter notebook --no-browser --port=8889
+poetry run jupyter notebook --no-browser --port=8889
 ```
 
 On your local computer, you need to set up a forwarding that picks the flux of data from the cluster via a local port, and makes it available on another port as if the server was in the local machine:

diff --git a/examples/benchmarks/ladle_furnace.ipynb b/examples/benchmarks/ladle_furnace.ipynb
@@ -15,16 +15,7 @@
    "cell_type": "code",
    "execution_count": 2,
    "metadata": {},
-   "outputs": [
-    {
-     "name": "stderr",
-     "output_type": "stream",
-     "text": [
-      "/Users/giles/anaconda3/envs/tomopt/lib/python3.8/site-packages/tqdm/auto.py:22: TqdmWarning: IProgress not found. Please update jupyter and ipywidgets. See https://ipywidgets.readthedocs.io/en/stable/user_install.html\n",
-      "  from .autonotebook import tqdm as notebook_tqdm\n"
-     ]
-    }
-   ],
+   "outputs": [],
    "source": [
     "import torch"
    ]
@@ -3544,9 +3535,9 @@
  ],
  "metadata": {
   "kernelspec": {
-   "display_name": "Python [conda env:tomopt]",
+   "display_name": "Python 3 (ipykernel)",
    "language": "python",
-   "name": "conda-env-tomopt-py"
+   "name": "python3"
   },
   "language_info": {
    "codemirror_mode": {
@@ -3558,7 +3549,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.8.0"
+   "version": "3.10.13"
   },
   "toc": {
    "base_numbering": 1,

diff --git a/examples/getting_started/00_Hello_World.ipynb b/examples/getting_started/00_Hello_World.ipynb
diff --git a/examples/getting_started/01_Indepth_tutorial_single_cycle.ipynb b/examples/getting_started/01_Indepth_tutorial_single_cycle.ipynb
@@ -8141,9 +8141,9 @@
  ],
  "metadata": {
   "kernelspec": {
-   "display_name": "Python [conda env:tomopt]",
+   "display_name": "Python 3 (ipykernel)",
    "language": "python",
-   "name": "conda-env-tomopt-py"
+   "name": "python3"
   },
   "language_info": {
    "codemirror_mode": {
@@ -8155,7 +8155,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.8.0"
+   "version": "3.10.13"
   },
   "toc": {
    "base_numbering": 1,

diff --git a/examples/getting_started/02_Indepth_tutorial_optimisation_and_callbacks.ipynb b/examples/getting_started/02_Indepth_tutorial_optimisation_and_callbacks.ipynb
@@ -1335,9 +1335,9 @@
  ],
  "metadata": {
   "kernelspec": {
-   "display_name": "Python [conda env:tomopt]",
+   "display_name": "Python 3 (ipykernel)",
    "language": "python",
-   "name": "conda-env-tomopt-py"
+   "name": "python3"
   },
   "language_info": {
    "codemirror_mode": {
@@ -1349,7 +1349,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.8.0"
+   "version": "3.10.13"
   },
   "toc": {
    "base_numbering": 1,

diff --git a/examples/getting_started/03_fixed_budget_mode.ipynb b/examples/getting_started/03_fixed_budget_mode.ipynb
@@ -502,9 +502,9 @@
  ],
  "metadata": {
   "kernelspec": {
-   "display_name": "Python [conda env:tomopt]",
+   "display_name": "Python 3 (ipykernel)",
    "language": "python",
-   "name": "conda-env-tomopt-py"
+   "name": "python3"
   },
   "language_info": {
    "codemirror_mode": {
@@ -516,7 +516,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.8.0"
+   "version": "3.10.13"
   },
   "toc": {
    "base_numbering": 1,