From dd797330def148e219dd3e6410edca6eaa0dbdfd Mon Sep 17 00:00:00 2001 From: Max Date: Thu, 29 Oct 2026 17:28:10 +0100 Subject: [PATCH] Shorten the titles of the docs pages. --- examples/01_cloud_in_cell_density.py | 2 +- examples/02_beam_density_2d.py | 2 +- examples/04_deposit_gather_adjoint.py | 4 ++-- examples/05_prescribed_electric_field.py | 4 ++-- examples/06_vector_operations.py | 4 ++-- examples/08_periodic_seam.py | 2 +- examples/11_test_particles.py | 4 ++-- tutorials/kernels.ipynb | 2 +- 8 files changed, 12 insertions(+), 12 deletions(-) diff --git a/examples/01_cloud_in_cell_density.py b/examples/01_cloud_in_cell_density.py index b187523..76a06b9 100644 --- a/examples/01_cloud_in_cell_density.py +++ b/examples/01_cloud_in_cell_density.py @@ -1,4 +1,4 @@ -"""Cloud-in-cell density in 1D +"""Cloud-in-cell density Deposit a Maxwellian cloud of markers on a 1D grid and compare the density with the exact profile. diff --git a/examples/02_beam_density_2d.py b/examples/02_beam_density_2d.py index cab1cb5..2f6fff9 100644 --- a/examples/02_beam_density_2d.py +++ b/examples/02_beam_density_2d.py @@ -1,4 +1,4 @@ -"""A beam's density in 2D +"""Beam density in 2D Deposit a sheared, tilted Gaussian beam on a 2D grid, then smooth the deposit. diff --git a/examples/04_deposit_gather_adjoint.py b/examples/04_deposit_gather_adjoint.py index a8a81db..7723fcb 100644 --- a/examples/04_deposit_gather_adjoint.py +++ b/examples/04_deposit_gather_adjoint.py @@ -1,6 +1,6 @@ -"""Deposit and gather are transposes +"""Adjoint deposit and gather -The scatter of marker values and the gather of a field use the same weights, so they are adjoint. +Deposit and gather are transposes: the scatter of marker values and the gather of a field use the same weights, so they are adjoint. For any field $g$ on the nodes and charges $q_i$ at positions $x_i$, $\\sum_i q_i\\, g(x_i) = \\sum_n g_n \\rho_n$ with $\\rho$ the deposit of the charges. That is diff --git a/examples/05_prescribed_electric_field.py b/examples/05_prescribed_electric_field.py index a69e0b9..b271ce0 100644 --- a/examples/05_prescribed_electric_field.py +++ b/examples/05_prescribed_electric_field.py @@ -1,6 +1,6 @@ -"""An electric field from a prescribed potential +"""Prescribed electric field -Build $E = -\\nabla\\phi$ on a grid from a potential given as a function, here a three-electrode lens. +An electric field from a prescribed potential: build $E = -\\nabla\\phi$ on a grid from a potential given as a function, here a three-electrode lens. `electric_field_from_potential` evaluates the potential on the nodes and differentiates it with second-order central differences. The lens has three cylinders, the middle one at diff --git a/examples/06_vector_operations.py b/examples/06_vector_operations.py index 0b89d52..aa4774f 100644 --- a/examples/06_vector_operations.py +++ b/examples/06_vector_operations.py @@ -1,6 +1,6 @@ -"""Vector fields: the E x B drift +"""E x B drift -Combine fields with arithmetic, `gradient`, `cross`, `dot` and `magnitude`: the drift velocity of a magnetized plasma. +Vector fields: combine fields with arithmetic, `gradient`, `cross`, `dot` and `magnitude`: the drift velocity of a magnetized plasma. A potential hill $\\phi = \\phi_0 e^{-r^2/w^2}$ in a uniform magnetic field $B \\hat z$ makes the guiding centres drift with $v_E = E \\times B / B^2$, along the equipotentials. The diff --git a/examples/08_periodic_seam.py b/examples/08_periodic_seam.py index 5435b10..ec291bb 100644 --- a/examples/08_periodic_seam.py +++ b/examples/08_periodic_seam.py @@ -1,4 +1,4 @@ -"""A periodic axis +"""Periodic axis On a periodic axis the last node neighbours the first: deposits and gathers wrap across the seam. diff --git a/examples/11_test_particles.py b/examples/11_test_particles.py index 9582efe..740ef6f 100644 --- a/examples/11_test_particles.py +++ b/examples/11_test_particles.py @@ -1,6 +1,6 @@ -"""Test particles in a fixed field +"""Test particles -Push charged particles through a field on a grid with a leapfrog scheme, gathering the field every step. +Test particles in a fixed field: push charged particles through a field on a grid with a leapfrog scheme, gathering the field every step. This is the loop of a test-particle code: `gather` gives the electric field at all markers at once, from the compiled gather. The field is that of a 2D potential well, diff --git a/tutorials/kernels.ipynb b/tutorials/kernels.ipynb index f06f441..f0e6669 100644 --- a/tutorials/kernels.ipynb +++ b/tutorials/kernels.ipynb @@ -5,7 +5,7 @@ "id": "0", "metadata": {}, "source": [ - "# The kernels\n", + "# Kernels\n", "\n", "The compiled gather and scatter kernels behind `Field`: their versions, how one is chosen, and calling them directly.\n", "\n",