Quickstart

Get familiar with Struphy objects using the notebook Tutorials. What follows is an introduction to the CLI (command line interface) of Struphy. For a more in-depth manual please go to Userguide.

Get help on Struphy console commands:

struphy -h

Check if kernels are compiled:

struphy compile

Check the current I/O paths:

struphy -p

Set the I/O paths to the current working directory:

struphy --set-i .
struphy --set-o .

Get a list of available Struphy models:

struphy run -h

Let us generate default parameters for the model VlasovMaxwellOneSpecies:

struphy params VlasovMaxwellOneSpecies

After hitting enter on prompt, the parameter file params_VlasovMaxwellOneSpecies.yml is created in the current input path (cwd). Let us rename it for convenience:

mv params_VlasovMaxwellOneSpecies.yml test.yml

We can now run a simulation with these parameters and save the data to my_first_sim/:

struphy run VlasovMaxwellOneSpecies -i test.yml -o my_first_sim

The produced data is in the expected folder in the current output path (cwd):

ls my_first_sim/

Let us post-process the raw simulation data:

struphy pproc my_first_sim

The results of post-processing are stored under my_first_sim/post_processing/. In particular, the data of the FEEC-fields is stored under:

ls my_first_sim/post_processing/fields_data/

and the data of the kinetic particles is stored under:

ls my_first_sim/post_processing/kinetic_data/

Check out Tutorial 08 in Tutorials for a deeper discussion on Struphy data and post processing.

Our first simulation ran for just three time steps. Let us change the end-time of the simulation by opening the parameter file:

vi test.yml

and setting time/Tend to 0.1. Save, quit and run again, but this time on 2 MPI processes, and saving to a different folder:

struphy run VlasovMaxwellOneSpecies -i test.yml -o another_sim --mpi 2

This time we ran for 20 time steps. The physical time unit of the run can be known via:

struphy units VlasovMaxwellOneSpecies -i test.yml

For completeness, let us post-process the data of the second run:

struphy pproc another_sim

Let us now double the number of markers used in the simulation:

vi test.yml

by changing kinetic/electrons/markers/ppc from 10 to 20, and then running:

struphy run VlasovMaxwellOneSpecies -i test.yml -o sim_20 --mpi 2

Finally, each Struphy model has some specific options to it, which in the case of VlasovMaxwellOneSpecies can be inspected via:

struphy params VlasovMaxwellOneSpecies --options

These options can be set in the parameter file. They usually refer to different types of solvers or solution methods.

If you want to learn more about using Struphy, please check out the Userguide as well as the Tutorials.