From 02f5c696e073aeaafdfa62bc8524fa5f3d80fcfb Mon Sep 17 00:00:00 2001 From: 2xB <31772910+2xB@users.noreply.github.com> Date: Mon, 8 Jul 2024 16:26:11 +0200 Subject: [PATCH] Documentation: Document InspectEMFile --- Documentation/gh-pages/source/kemfield_tools.rst | 13 +++++++++++-- 1 file changed, 11 insertions(+), 2 deletions(-) diff --git a/Documentation/gh-pages/source/kemfield_tools.rst b/Documentation/gh-pages/source/kemfield_tools.rst index 04976a36..0b99430e 100644 --- a/Documentation/gh-pages/source/kemfield_tools.rst +++ b/Documentation/gh-pages/source/kemfield_tools.rst @@ -1,5 +1,8 @@ Tools -===== +***** + +Field calculation +================= Although *Kassiopeia* is quite powerful in terms of configuration options, sometimes it is necessary to calculate the electric or magnetic field at one or more defined points in the geometry. This is especially useful to compare @@ -29,8 +32,14 @@ and so on. In addition, there is: * ``SimpleMagneticGradientCalculator`` calculates the magnetic field and its gradient at a single point in the global coordinate system, and prints the results to the terminal. +Development +=========== + +Some KEMField tools are especially useful for development. `InspectEMFile` e.g. prints an overview over all keys in +`.kbd` files (like KEMField cache files). These tools can be found here: :gh-code:`KEMField/Source/Applications/Tools`. + Usage ------ +===== All listed programs will show a brief usage summary if called without arguments. For example, the ``SimpleElectricFieldCalculatorAlongZaxis`` will show a message: