diff --git a/.github/workflows/languagetool.yml b/.github/workflows/spelling.yml similarity index 59% rename from .github/workflows/languagetool.yml rename to .github/workflows/spelling.yml index 603c7ffe..7b563b45 100644 --- a/.github/workflows/languagetool.yml +++ b/.github/workflows/spelling.yml @@ -1,5 +1,5 @@ # Check for common grammar and spelling mistakes -name: LanguageTool +name: Spelling on: pull_request: @@ -23,3 +23,19 @@ jobs: reporter: github-pr-review patterns: '*.md src/**.rs python/differt/**.py docs/source/**.md docs/source/**.ipynb' level: warning + + codespell-jupyer: + runs-on: ubuntu-latest + steps: + - name: Checkout repository + uses: actions/checkout@v4 + + - name: Strip cell output + run: | + pip install nbstripout + find . -name '*.ipynb' -exec nbstripout {} + + + - name: Run codespell + run: | + pip install codespell tomli + find . -name '*.ipynb' -exec codespell {} + diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index 19d7e776..b2a0d3d0 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -56,9 +56,16 @@ repos: args: - --sort-by-bibkey - --drop=abstract +- repo: https://github.com/kynan/nbstripout + rev: 0.7.1 + hooks: + - id: nbstripout + args: + - --keep-output - repo: https://github.com/codespell-project/codespell rev: v2.3.0 hooks: - id: codespell additional_dependencies: - tomli + exclude_types: [jupyter] # GitHub action will run on Notebooks diff --git a/docs/source/notebooks/advanced_path_tracing.ipynb b/docs/source/notebooks/advanced_path_tracing.ipynb index 8ca1759f..cd2004c7 100644 --- a/docs/source/notebooks/advanced_path_tracing.ipynb +++ b/docs/source/notebooks/advanced_path_tracing.ipynb @@ -3,7 +3,7 @@ { "cell_type": "code", "execution_count": null, - "id": "e90f3c19", + "id": "0", "metadata": { "tags": [ "differt-install-preamble", @@ -25,7 +25,7 @@ }, { "cell_type": "markdown", - "id": "311d7587", + "id": "1", "metadata": {}, "source": [ "# Advanced Path Tracing\n", @@ -38,7 +38,7 @@ }, { "cell_type": "markdown", - "id": "bdac281d-e122-494b-8f83-1dbcbcfaea39", + "id": "2", "metadata": {}, "source": [ "## Example on a simple scene\n", @@ -61,8 +61,8 @@ }, { "cell_type": "code", - "execution_count": 2, - "id": "0c260649-d4de-452d-a578-7647c0e57993", + "execution_count": null, + "id": "3", "metadata": {}, "outputs": [], "source": [ @@ -87,7 +87,7 @@ }, { "cell_type": "markdown", - "id": "76b12dd2-a6e0-4f50-bc17-3da15d359af0", + "id": "4", "metadata": {}, "source": [ "### Loading a mesh\n", @@ -98,8 +98,8 @@ }, { "cell_type": "code", - "execution_count": 3, - "id": "a4ff244d", + "execution_count": null, + "id": "5", "metadata": {}, "outputs": [], "source": [ @@ -109,7 +109,7 @@ }, { "cell_type": "markdown", - "id": "d3a43cc4-f3b5-4aef-a25e-7c5aed739e9f", + "id": "6", "metadata": { "tags": [] }, @@ -123,7 +123,7 @@ { "cell_type": "code", "execution_count": null, - "id": "2be70ad7-6dae-478f-83bd-b08e516d114d", + "id": "7", "metadata": {}, "outputs": [], "source": [ @@ -135,7 +135,7 @@ }, { "cell_type": "markdown", - "id": "a65b5875-630c-4454-99c0-09e549488ef9", + "id": "8", "metadata": {}, "source": [ "Ray Tracing without start and end points is not very interesting.\n", @@ -145,7 +145,7 @@ { "cell_type": "code", "execution_count": null, - "id": "1b575f59-b2ae-4425-aac2-5286f240e4dc", + "id": "9", "metadata": {}, "outputs": [], "source": [ @@ -159,7 +159,7 @@ }, { "cell_type": "markdown", - "id": "db3d3187-c330-4367-b51c-b027dcdf05ed", + "id": "10", "metadata": {}, "source": [ "### How we trace rays\n", @@ -181,7 +181,7 @@ { "cell_type": "code", "execution_count": null, - "id": "471c5059-cc86-4ca6-ad9e-efc8d7cc2f91", + "id": "11", "metadata": {}, "outputs": [], "source": [ @@ -201,7 +201,7 @@ }, { "cell_type": "markdown", - "id": "7d1fb247-2aba-4064-aba9-f34bfea0d3c5", + "id": "12", "metadata": {}, "source": [ "Looking at the above, we can clearly see that a line-of-sight (LOS) path between TX and RX exists.\n", @@ -215,7 +215,7 @@ { "cell_type": "code", "execution_count": null, - "id": "30689d03-ac54-419f-ada3-c14a1a570d65", + "id": "13", "metadata": {}, "outputs": [], "source": [ @@ -275,7 +275,7 @@ }, { "cell_type": "markdown", - "id": "739cb7d5-a067-4bf3-9641-673ea76ff11c", + "id": "14", "metadata": {}, "source": [ "Nice! Thanks to the {func}`image_method`, we successfully generated the paths we just mentioned.\n", @@ -301,7 +301,7 @@ { "cell_type": "code", "execution_count": null, - "id": "32f1468a-bf02-4c33-8a1d-0dca89d09c20", + "id": "15", "metadata": {}, "outputs": [], "source": [ @@ -416,7 +416,7 @@ }, { "cell_type": "markdown", - "id": "1512b1e9-44ed-4cba-bee4-abf067bf954a", + "id": "16", "metadata": {}, "source": [ "Another path tracing method that is fully compatible with the above cell is {func}`fermat_path_on_planar_mirrors`. You can safely use the latter instead of the former, and that should produce the same result. Note that the Fermat path tracing is much slower than the Image method, but can be applied to other types of interactions than just pure specular reflection. This is left as an exercise to the reader." @@ -424,7 +424,7 @@ }, { "cell_type": "markdown", - "id": "4c44db87-6b36-4000-919d-69b469a744d8", + "id": "17", "metadata": {}, "source": [ "## Example on more complex scenes\n", @@ -456,7 +456,7 @@ { "cell_type": "code", "execution_count": null, - "id": "435cf5c1-c0dd-47a1-9c1f-49c2d1d89b3d", + "id": "18", "metadata": {}, "outputs": [], "source": [ @@ -475,7 +475,7 @@ { "cell_type": "code", "execution_count": null, - "id": "6ef52f5e-5620-4e6d-a731-8c7bad893641", + "id": "19", "metadata": {}, "outputs": [], "source": [ @@ -484,7 +484,7 @@ }, { "cell_type": "markdown", - "id": "51243bb9", + "id": "20", "metadata": {}, "source": [ "This number isn't actually that big, and can easily reach above a million on large cities.\n", @@ -497,7 +497,7 @@ { "cell_type": "code", "execution_count": null, - "id": "fea3cba1-938f-49b2-ab21-ae88396e5b55", + "id": "21", "metadata": {}, "outputs": [], "source": [ @@ -515,7 +515,7 @@ }, { "cell_type": "markdown", - "id": "917fbcc6", + "id": "22", "metadata": {}, "source": [ "That means that there are over 200 million second order reflection paths to test... We need to reduce that number!" @@ -523,7 +523,7 @@ }, { "cell_type": "markdown", - "id": "4974a586", + "id": "23", "metadata": {}, "source": [ "### Assuming quadrilaterals\n", @@ -540,7 +540,7 @@ { "cell_type": "code", "execution_count": null, - "id": "0b3456fe", + "id": "24", "metadata": {}, "outputs": [], "source": [ @@ -550,7 +550,7 @@ }, { "cell_type": "markdown", - "id": "b5ba7acb", + "id": "25", "metadata": {}, "source": [ "Again, we can compute the number of path candidates, and see that it is reduced almost by a factor 4.\n", @@ -561,7 +561,7 @@ { "cell_type": "code", "execution_count": null, - "id": "8080e60c", + "id": "26", "metadata": {}, "outputs": [], "source": [ @@ -576,7 +576,7 @@ }, { "cell_type": "markdown", - "id": "725a925c", + "id": "27", "metadata": {}, "source": [ "### Determining TX's visibility\n", @@ -606,7 +606,7 @@ { "cell_type": "code", "execution_count": null, - "id": "08ab9f72-5d52-488c-bc09-7a635b7ab7a8", + "id": "28", "metadata": {}, "outputs": [], "source": [ @@ -637,7 +637,7 @@ }, { "cell_type": "markdown", - "id": "f1104575", + "id": "29", "metadata": {}, "source": [ "A visibility vector is simply an array of boolean, each entry indicating if a corresponding\n", @@ -649,7 +649,7 @@ { "cell_type": "code", "execution_count": null, - "id": "4bd97917-c5d3-4b7e-b29a-c071b7a579cc", + "id": "30", "metadata": {}, "outputs": [], "source": [ @@ -658,7 +658,7 @@ }, { "cell_type": "markdown", - "id": "7c0354a8", + "id": "31", "metadata": {}, "source": [ "It is also possible to get the number of visible quadrilaterals by\n", @@ -669,7 +669,7 @@ { "cell_type": "code", "execution_count": null, - "id": "bf54e4da", + "id": "32", "metadata": {}, "outputs": [], "source": [ @@ -679,7 +679,7 @@ }, { "cell_type": "markdown", - "id": "e6566874", + "id": "33", "metadata": {}, "source": [ "We can then use this result to inform the graph about the limited number of faces\n", @@ -696,7 +696,7 @@ { "cell_type": "code", "execution_count": null, - "id": "ca360b86", + "id": "34", "metadata": {}, "outputs": [], "source": [ @@ -712,7 +712,7 @@ }, { "cell_type": "markdown", - "id": "3c3229ef", + "id": "35", "metadata": {}, "source": [ "### What about Ray Launching\n", diff --git a/docs/source/notebooks/diffraction.ipynb b/docs/source/notebooks/diffraction.ipynb index c00138c6..a513b3b0 100644 --- a/docs/source/notebooks/diffraction.ipynb +++ b/docs/source/notebooks/diffraction.ipynb @@ -3,7 +3,7 @@ { "cell_type": "code", "execution_count": null, - "id": "e90f3c19", + "id": "0", "metadata": { "tags": [ "differt-install-preamble", @@ -25,7 +25,7 @@ }, { "cell_type": "markdown", - "id": "dd7d10a7-b006-4112-bf51-16e519ffd0c1", + "id": "1", "metadata": {}, "source": [ "# Handling Diffraction\n", @@ -43,7 +43,7 @@ { "cell_type": "code", "execution_count": null, - "id": "7f48a5a2-5531-4c42-a2e3-9106589a5347", + "id": "2", "metadata": {}, "outputs": [], "source": [ diff --git a/docs/source/notebooks/multipath.ipynb b/docs/source/notebooks/multipath.ipynb index 8d585854..a594f0ba 100644 --- a/docs/source/notebooks/multipath.ipynb +++ b/docs/source/notebooks/multipath.ipynb @@ -3,7 +3,7 @@ { "cell_type": "code", "execution_count": null, - "id": "e90f3c19", + "id": "0", "metadata": { "tags": [ "differt-install-preamble", @@ -25,7 +25,7 @@ }, { "cell_type": "markdown", - "id": "4e5044be-26d1-47a1-aea1-b7bf8928ca45", + "id": "1", "metadata": {}, "source": [ "# Multipath Lifetime Map\n", @@ -67,8 +67,8 @@ }, { "cell_type": "code", - "execution_count": 2, - "id": "f05092ba-295c-425e-bf53-b6e92021ed82", + "execution_count": null, + "id": "2", "metadata": {}, "outputs": [], "source": [ @@ -94,7 +94,7 @@ }, { "cell_type": "markdown", - "id": "8530fad4", + "id": "3", "metadata": {}, "source": [ "## Simple Urban Street Canyon Scenario\n", @@ -111,8 +111,8 @@ }, { "cell_type": "code", - "execution_count": 3, - "id": "064ecfdb-3097-4b90-944a-326ca52c96e6", + "execution_count": null, + "id": "4", "metadata": {}, "outputs": [], "source": [ @@ -121,8 +121,8 @@ }, { "cell_type": "code", - "execution_count": 4, - "id": "52763ebb", + "execution_count": null, + "id": "5", "metadata": {}, "outputs": [ { @@ -1907,7 +1907,7 @@ }, { "cell_type": "markdown", - "id": "d13fd243", + "id": "6", "metadata": {}, "source": [ "In the cell below (hidden by default), we define quite a few utility functions to\n", @@ -1917,8 +1917,8 @@ }, { "cell_type": "code", - "execution_count": 5, - "id": "396ff925", + "execution_count": null, + "id": "7", "metadata": { "tags": [ "hide-input" @@ -2028,7 +2028,7 @@ }, { "cell_type": "markdown", - "id": "cd15375a", + "id": "8", "metadata": {}, "source": [ "## Ray Tracing with a Grid of Receivers\n", @@ -2053,8 +2053,8 @@ }, { "cell_type": "code", - "execution_count": 6, - "id": "ebf1de25-6000-497a-a35f-94b5a06db9dd", + "execution_count": null, + "id": "9", "metadata": {}, "outputs": [ { @@ -24495,7 +24495,7 @@ }, { "cell_type": "markdown", - "id": "618adfa0", + "id": "10", "metadata": {}, "source": [ "## Plotting a Multipath Lifetime Map\n", @@ -24506,8 +24506,8 @@ }, { "cell_type": "code", - "execution_count": 7, - "id": "9320934f", + "execution_count": null, + "id": "11", "metadata": {}, "outputs": [ { @@ -36149,7 +36149,7 @@ }, { "cell_type": "markdown", - "id": "8e11c9a9", + "id": "12", "metadata": {}, "source": [ "## Metrics\n", @@ -36164,8 +36164,8 @@ }, { "cell_type": "code", - "execution_count": 8, - "id": "7a4128fb", + "execution_count": null, + "id": "13", "metadata": {}, "outputs": [ { @@ -36175,7 +36175,7 @@ " 197, 228, 71, 17, 72, 12, 92, 170, 4, 36, 15, 1, 205], dtype=int32)" ] }, - "execution_count": 8, + "execution_count": null, "metadata": {}, "output_type": "execute_result" } @@ -36198,8 +36198,8 @@ }, { "cell_type": "code", - "execution_count": 9, - "id": "42265de7", + "execution_count": null, + "id": "14", "metadata": {}, "outputs": [ { @@ -37204,7 +37204,7 @@ }, { "cell_type": "markdown", - "id": "ac959da8", + "id": "15", "metadata": {}, "source": [ "### Average Minimal Inter-cell Distance\n", @@ -37215,8 +37215,8 @@ }, { "cell_type": "code", - "execution_count": 10, - "id": "92983000", + "execution_count": null, + "id": "16", "metadata": { "tags": [ "hide-output" @@ -37274,7 +37274,7 @@ }, { "cell_type": "markdown", - "id": "563d1c30", + "id": "17", "metadata": {}, "source": [ "## Animating Over Multiple Transmitter Positions\n", @@ -37289,8 +37289,8 @@ }, { "cell_type": "code", - "execution_count": 11, - "id": "3484e125", + "execution_count": null, + "id": "18", "metadata": { "tags": [ "hide-input" @@ -581816,7 +581816,7 @@ }, { "cell_type": "markdown", - "id": "c209d76f-91c1-495d-b2cb-a35e9ba5cfe1", + "id": "19", "metadata": {}, "source": [ "## Conclustion\n", @@ -581826,7 +581826,7 @@ "We hope this short tutorial helped you understanding the procedure required\n", "to reproduce the results presented in our paper.\n", "\n", - "Should you have any question, recommandation, or remark, do not hesitate to reach us\n", + "Should you have any question, recommendation, or remark, do not hesitate to reach us\n", "via e-mail or via GitHub issues and discussions!" ] } @@ -581850,7 +581850,7 @@ "version": "3.11.8" }, "mystnb": { - "execution_mode": "off" + "execution_mode": "off" } }, "nbformat": 4, diff --git a/docs/source/notebooks/path_candidates.ipynb b/docs/source/notebooks/path_candidates.ipynb index 66b01a85..37ac8eb3 100644 --- a/docs/source/notebooks/path_candidates.ipynb +++ b/docs/source/notebooks/path_candidates.ipynb @@ -3,7 +3,7 @@ { "cell_type": "code", "execution_count": null, - "id": "e90f3c19", + "id": "0", "metadata": { "tags": [ "differt-install-preamble", @@ -25,7 +25,7 @@ }, { "cell_type": "markdown", - "id": "ce377447-7214-4981-b828-15d66d123c98", + "id": "1", "metadata": {}, "source": [ "(path_candidates)=\n", @@ -82,7 +82,7 @@ { "cell_type": "code", "execution_count": null, - "id": "e2a9463f-0956-4424-8c64-5939a8c59f10", + "id": "2", "metadata": {}, "outputs": [], "source": [ @@ -94,7 +94,7 @@ { "cell_type": "code", "execution_count": null, - "id": "7964d4a8-39b4-4a23-8bc2-374e1771acf4", + "id": "3", "metadata": {}, "outputs": [], "source": [ @@ -120,7 +120,7 @@ }, { "cell_type": "markdown", - "id": "2ecd2a40-256d-480f-bf0f-9e1fe1a998ec", + "id": "4", "metadata": {}, "source": [ "We can test that our adjacency matrix, without BS and UE, is indeed symmetric." @@ -129,7 +129,7 @@ { "cell_type": "code", "execution_count": null, - "id": "c490b068-e6dd-4777-a4d4-8cdbf1cb384d", + "id": "5", "metadata": {}, "outputs": [], "source": [ @@ -141,7 +141,7 @@ { "cell_type": "code", "execution_count": null, - "id": "5248917e-b3a1-4803-ba1d-afd4a4e7fed3", + "id": "6", "metadata": {}, "outputs": [], "source": [ @@ -156,7 +156,7 @@ }, { "cell_type": "markdown", - "id": "64d4cf55-e729-43a6-9e35-37a65a8821d5", + "id": "7", "metadata": {}, "source": [ "## Scene with unknown visibility matrix\n", @@ -190,7 +190,7 @@ { "cell_type": "code", "execution_count": null, - "id": "74130507-1a00-4168-8467-d3c90ffb0939", + "id": "8", "metadata": { "tags": [ "hide-output" @@ -211,7 +211,7 @@ }, { "cell_type": "markdown", - "id": "2914c9de-6639-4947-b9e0-1d45463fdde3", + "id": "9", "metadata": {}, "source": [ "## Beware of the number of path candidates\n", @@ -240,7 +240,7 @@ { "cell_type": "code", "execution_count": null, - "id": "95a30077-9a34-449f-83e2-c060ca2d5c85", + "id": "10", "metadata": {}, "outputs": [], "source": [ diff --git a/docs/source/notebooks/performance_tips.ipynb b/docs/source/notebooks/performance_tips.ipynb index 4e807850..a7f18ae6 100644 --- a/docs/source/notebooks/performance_tips.ipynb +++ b/docs/source/notebooks/performance_tips.ipynb @@ -3,7 +3,7 @@ { "cell_type": "code", "execution_count": null, - "id": "e90f3c19", + "id": "0", "metadata": { "tags": [ "differt-install-preamble", @@ -25,7 +25,7 @@ }, { "cell_type": "markdown", - "id": "e715242e-c780-42cc-81a4-e65330408836", + "id": "1", "metadata": { "editable": true, "slideshow": { @@ -57,7 +57,7 @@ }, { "cell_type": "markdown", - "id": "8b4362eb-68df-46c5-87e4-f9aa01ae1cdb", + "id": "2", "metadata": { "editable": true, "slideshow": { @@ -76,7 +76,7 @@ { "cell_type": "code", "execution_count": null, - "id": "15d28c9a-e243-4a1e-917e-13000c5f29fc", + "id": "3", "metadata": { "editable": true, "slideshow": { @@ -99,7 +99,7 @@ { "cell_type": "code", "execution_count": null, - "id": "5980b1b3-57b7-428e-9b16-de372f85ce4d", + "id": "4", "metadata": { "editable": true, "slideshow": { @@ -121,7 +121,7 @@ }, { "cell_type": "markdown", - "id": "bd65265d-44a7-452a-bf22-b2f4f81178fd", + "id": "5", "metadata": { "editable": true, "slideshow": { @@ -143,7 +143,7 @@ { "cell_type": "code", "execution_count": null, - "id": "32dc93fc-3737-43be-b9c5-c36324e030a4", + "id": "6", "metadata": {}, "outputs": [], "source": [ @@ -152,7 +152,7 @@ }, { "cell_type": "markdown", - "id": "300ba946-bfc4-4c13-abb9-6182f77af3c6", + "id": "7", "metadata": {}, "source": [ "Then, let's compare it with its JIT compiled version.\n", @@ -164,7 +164,7 @@ { "cell_type": "code", "execution_count": null, - "id": "82071c69-c5d8-463d-8318-bd1920173c78", + "id": "8", "metadata": {}, "outputs": [], "source": [ @@ -178,7 +178,7 @@ }, { "cell_type": "markdown", - "id": "14d6cb6a-5de8-4f9f-8126-eb6a276625e1", + "id": "9", "metadata": {}, "source": [ "See! Here, we reduced the execution time by **more that one order of magnitude**, which is quite\n", @@ -191,7 +191,7 @@ }, { "cell_type": "markdown", - "id": "e384026e-fd19-44b8-be0d-6ef6b0caceaa", + "id": "10", "metadata": {}, "source": [ "## JIT-ing a new function\n", @@ -203,7 +203,7 @@ { "cell_type": "code", "execution_count": null, - "id": "277b4b2f-652f-4521-bc53-4dc819363ffd", + "id": "11", "metadata": {}, "outputs": [], "source": [ @@ -219,7 +219,7 @@ }, { "cell_type": "markdown", - "id": "2459d0dc-15d0-469d-b218-b54479cd0f5a", + "id": "12", "metadata": {}, "source": [ "For advanced usage, see {func}`jax.jit`'s documentation.\n", @@ -237,7 +237,7 @@ }, { "cell_type": "markdown", - "id": "9bcc98a5-649b-42f7-8e9d-2d4697a442fe", + "id": "13", "metadata": {}, "source": [ "### (Bad) Type checker placed after JIT decorator" @@ -246,7 +246,7 @@ { "cell_type": "code", "execution_count": null, - "id": "ce01a040-4613-491c-9c63-9b1bf904cd51", + "id": "14", "metadata": {}, "outputs": [], "source": [ @@ -281,7 +281,7 @@ }, { "cell_type": "markdown", - "id": "7835925e-4655-4ead-863f-87f9fe42ca05", + "id": "15", "metadata": {}, "source": [ "### (Good) Type checker placed before JIT decorator" @@ -290,7 +290,7 @@ { "cell_type": "code", "execution_count": null, - "id": "55fecb27-54b6-41a3-ad7f-5af9e26509fd", + "id": "16", "metadata": {}, "outputs": [], "source": [ @@ -315,7 +315,7 @@ }, { "cell_type": "markdown", - "id": "04c27a9e-79c2-4ee1-bac0-805c329ee728", + "id": "17", "metadata": {}, "source": [ "As you can see, a small permutation of the two decorators changed the performances!\n", @@ -324,7 +324,7 @@ }, { "cell_type": "markdown", - "id": "dbd42d1e-ee5d-4a0e-811a-18ef5f0f7747", + "id": "18", "metadata": { "editable": true, "slideshow": { diff --git a/docs/source/notebooks/plotting_backend.ipynb b/docs/source/notebooks/plotting_backend.ipynb index aed41ef6..3052911b 100644 --- a/docs/source/notebooks/plotting_backend.ipynb +++ b/docs/source/notebooks/plotting_backend.ipynb @@ -3,7 +3,7 @@ { "cell_type": "code", "execution_count": null, - "id": "e90f3c19", + "id": "0", "metadata": { "tags": [ "differt-install-preamble", @@ -25,7 +25,7 @@ }, { "cell_type": "markdown", - "id": "450018ce-a5f7-4586-977a-71bfb73bae56", + "id": "1", "metadata": {}, "source": [ "# Choosing your plotting backend\n", @@ -47,7 +47,7 @@ { "cell_type": "code", "execution_count": null, - "id": "5efae8bf-a35d-485a-9fa7-643efaf29d94", + "id": "2", "metadata": { "tags": [] }, @@ -61,7 +61,7 @@ }, { "cell_type": "markdown", - "id": "f139173e-09de-4470-af71-a2edf41fad13", + "id": "3", "metadata": {}, "source": [ "## VisPy\n", @@ -89,7 +89,7 @@ { "cell_type": "code", "execution_count": null, - "id": "0c49fbe0-7721-49cb-9a4e-8ee0bd5e3b5b", + "id": "4", "metadata": { "tags": [] }, @@ -101,7 +101,7 @@ }, { "cell_type": "markdown", - "id": "06c56873-92da-4904-bbdb-bb6622a77f22", + "id": "5", "metadata": {}, "source": [ "## Matplotlib\n", @@ -127,7 +127,7 @@ { "cell_type": "code", "execution_count": null, - "id": "066ada1e-e48a-4223-beb3-c579c5410daa", + "id": "6", "metadata": { "tags": [] }, @@ -147,7 +147,7 @@ }, { "cell_type": "markdown", - "id": "8143b2d6-ab90-4cc6-8765-ae9e9a041599", + "id": "7", "metadata": {}, "source": [ "## Plotly" @@ -155,7 +155,7 @@ }, { "cell_type": "markdown", - "id": "c9f6fc61-d760-4a0d-bdba-1520c7a197d5", + "id": "8", "metadata": {}, "source": [ "(plotly-pros)=\n", @@ -176,7 +176,7 @@ { "cell_type": "code", "execution_count": null, - "id": "c0863a8e-918a-42d5-9841-b7cf248f3953", + "id": "9", "metadata": { "tags": [] }, @@ -188,7 +188,7 @@ }, { "cell_type": "markdown", - "id": "7139b658-1e6b-475a-ae46-5cda5c029a7f", + "id": "10", "metadata": {}, "source": [ "(change-default-backend)=\n", @@ -205,7 +205,7 @@ { "cell_type": "code", "execution_count": null, - "id": "5ba01127-92a9-4c16-8079-591d2a227fca", + "id": "11", "metadata": { "tags": [] }, @@ -221,7 +221,7 @@ }, { "cell_type": "markdown", - "id": "ecc4ad4f-ebd9-4e25-868b-b4d5a89ca0f2", + "id": "12", "metadata": {}, "source": [ "(composing)=\n", @@ -242,7 +242,7 @@ { "cell_type": "code", "execution_count": null, - "id": "d64550e0-dcc0-4c08-943a-69fe26492036", + "id": "13", "metadata": {}, "outputs": [], "source": [ diff --git a/docs/source/notebooks/quickstart.ipynb b/docs/source/notebooks/quickstart.ipynb index 5303e17e..4f8b7eb8 100644 --- a/docs/source/notebooks/quickstart.ipynb +++ b/docs/source/notebooks/quickstart.ipynb @@ -3,7 +3,7 @@ { "cell_type": "code", "execution_count": null, - "id": "e90f3c19", + "id": "0", "metadata": { "tags": [ "differt-install-preamble", @@ -25,7 +25,7 @@ }, { "cell_type": "markdown", - "id": "dd7d10a7-b006-4112-bf51-16e519ffd0c1", + "id": "1", "metadata": {}, "source": [ "# Quickstart\n", @@ -36,7 +36,7 @@ { "cell_type": "code", "execution_count": null, - "id": "6239cc49-a63e-4a48-962e-ed39b0d8aab0", + "id": "2", "metadata": {}, "outputs": [], "source": [ @@ -52,7 +52,7 @@ { "cell_type": "code", "execution_count": null, - "id": "2e443c38-fa47-4aca-8d1d-9ef9c6054559", + "id": "3", "metadata": {}, "outputs": [], "source": [ @@ -62,7 +62,7 @@ { "cell_type": "code", "execution_count": null, - "id": "b4c122fc-85a9-4535-8c79-9f601ba87470", + "id": "4", "metadata": {}, "outputs": [], "source": [ diff --git a/docs/source/notebooks/ray_tracing_at_city_scale.ipynb b/docs/source/notebooks/ray_tracing_at_city_scale.ipynb index e2c1d8b4..b4adf1fa 100644 --- a/docs/source/notebooks/ray_tracing_at_city_scale.ipynb +++ b/docs/source/notebooks/ray_tracing_at_city_scale.ipynb @@ -3,7 +3,7 @@ { "cell_type": "code", "execution_count": null, - "id": "e90f3c19", + "id": "0", "metadata": { "tags": [ "differt-install-preamble", @@ -25,7 +25,7 @@ }, { "cell_type": "markdown", - "id": "311d7587", + "id": "1", "metadata": {}, "source": [ "# Ray Tracing at City Scale" @@ -34,7 +34,7 @@ { "cell_type": "code", "execution_count": null, - "id": "a4ff244d", + "id": "2", "metadata": {}, "outputs": [], "source": [ @@ -49,7 +49,7 @@ { "cell_type": "code", "execution_count": null, - "id": "06d96206", + "id": "3", "metadata": { "tags": [] }, diff --git a/docs/source/notebooks/type_checking.ipynb b/docs/source/notebooks/type_checking.ipynb index 1fc04dfc..e6654acb 100644 --- a/docs/source/notebooks/type_checking.ipynb +++ b/docs/source/notebooks/type_checking.ipynb @@ -3,7 +3,7 @@ { "cell_type": "code", "execution_count": null, - "id": "e90f3c19", + "id": "0", "metadata": { "tags": [ "differt-install-preamble", @@ -25,7 +25,7 @@ }, { "cell_type": "markdown", - "id": "4b679b49-bbab-4b51-8c6e-fe171709c2ee", + "id": "1", "metadata": {}, "source": [ "# Runtime type checking\n", @@ -47,7 +47,7 @@ { "cell_type": "code", "execution_count": null, - "id": "8f766ae8-6a57-4298-9a9c-29039514046a", + "id": "2", "metadata": {}, "outputs": [], "source": [ @@ -63,7 +63,7 @@ }, { "cell_type": "markdown", - "id": "4bf2ab58-4ade-470c-9a37-386bf27bb955", + "id": "3", "metadata": {}, "source": [ "As we can see, its signature expects a 2D array as input, and a 2D array as output,\n", @@ -73,7 +73,7 @@ { "cell_type": "code", "execution_count": null, - "id": "51d7034a-c98b-4f52-8823-019cebeaa425", + "id": "4", "metadata": {}, "outputs": [], "source": [ @@ -85,7 +85,7 @@ }, { "cell_type": "markdown", - "id": "7aaff951-e672-432c-b876-3d9e5582fc20", + "id": "5", "metadata": {}, "source": [ "Hence, if we provide a 2D array as input, everything works just fine:" @@ -94,7 +94,7 @@ { "cell_type": "code", "execution_count": null, - "id": "03faf34c-2c9d-46dd-aacc-56d380600be8", + "id": "6", "metadata": {}, "outputs": [], "source": [ @@ -103,7 +103,7 @@ }, { "cell_type": "markdown", - "id": "b34e431d-aaef-43fd-a267-461f8c371694", + "id": "7", "metadata": {}, "source": [ "However, if anything else than a 2D array is provided, an error will be raised:" @@ -112,7 +112,7 @@ { "cell_type": "code", "execution_count": null, - "id": "570ccb3b-70df-40d3-b84b-94a3dc08f2dd", + "id": "8", "metadata": { "editable": true, "slideshow": { @@ -130,7 +130,7 @@ }, { "cell_type": "markdown", - "id": "64ddf67a-0099-4781-8aae-8341a932770c", + "id": "9", "metadata": {}, "source": [ "The error message is a bit verbose,\n", @@ -143,7 +143,7 @@ }, { "cell_type": "markdown", - "id": "04534a76-d744-4454-8d37-0e25c0a4bb20", + "id": "10", "metadata": {}, "source": [ "## Output checking\n", @@ -163,7 +163,7 @@ { "cell_type": "code", "execution_count": null, - "id": "a7a590dc-de12-41c6-92ce-bd01494d66b4", + "id": "11", "metadata": {}, "outputs": [], "source": [ @@ -183,7 +183,7 @@ { "cell_type": "code", "execution_count": null, - "id": "fe38c920-be0a-4fc9-9453-79dcd7be13c0", + "id": "12", "metadata": { "editable": true, "slideshow": { @@ -200,7 +200,7 @@ }, { "cell_type": "markdown", - "id": "672abeb3-1146-4b77-987d-7e6dc132616a", + "id": "13", "metadata": {}, "source": [ "Here, the error message tells us that it inferred `m=10` and `n=7` from the input arguments,\n", @@ -212,7 +212,7 @@ { "cell_type": "code", "execution_count": null, - "id": "3ee5e96c-fb64-483a-8507-4be2cb8d229e", + "id": "14", "metadata": { "editable": true, "slideshow": { diff --git a/pyproject.toml b/pyproject.toml index 8597caf1..78f5399b 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -89,7 +89,7 @@ search = "version: v{current_version}" builtin = "clear,rare,informal,usage,names,en-GB_to_en-US" check-hidden = true ignore-words-list = "crate,ue" -skip = "docs/source/conf.py,docs/source/notebooks/multipath.ipynb,pyproject.toml,uv.lock" +skip = "docs/source/conf.py,pyproject.toml,uv.lock" [tool.coverage.report] exclude_lines = [ diff --git a/scripts/nbsetup.py b/scripts/nbsetup.py index f4dcd67e..9dcd393c 100644 --- a/scripts/nbsetup.py +++ b/scripts/nbsetup.py @@ -9,7 +9,7 @@ CELL = nbf.NotebookNode( cell_type="code", execution_count=None, - id="e90f3c19", + id="0", metadata={"tags": [TAG, "remove-cell", "skip-execution"]}, outputs=[], source=[