Skip to content

Commit

Permalink
Documentation: Document InspectEMFile
Browse files Browse the repository at this point in the history
  • Loading branch information
2xB authored Jul 8, 2024
1 parent 9935e0f commit 02f5c69
Showing 1 changed file with 11 additions and 2 deletions.
13 changes: 11 additions & 2 deletions Documentation/gh-pages/source/kemfield_tools.rst
Original file line number Diff line number Diff line change
@@ -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
Expand Down Expand Up @@ -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:
Expand Down

0 comments on commit 02f5c69

Please sign in to comment.