.. _api_guide:

API Guide
=========

This guide takes you through the classes used in Struphy launch files generated by::

    struphy params MODEL

for a valid ``MODEL`` from the list of :ref:`models`.
All information for running simulations are contained and can be altered in such launch (parameter) files.
It is recommended to generate such a file and inspect it with an editor like VScode (using Pylance).


Simulation class
----------------

.. autoclass:: struphy.Simulation
    :show-inheritance:


Simulation parameters
---------------------

For available models see :ref:`models`.

For domains see :ref:`avail_mappings`.

For fluid backgrounds see :ref:`equils_avail`.

.. autoclass:: struphy.EnvironmentOptions

For profiling-related runtime options and output inspection, see :ref:`code_profiling`.

.. autoclass:: struphy.BaseUnits

.. autoclass:: struphy.Time

.. autoclass:: struphy.grids.TensorProductGrid
    :show-inheritance:

.. autoclass:: struphy.DerhamOptions


.. _species:

Species types
-------------

Each Struphy model is a collection of species of one of the following types:

.. autoclass:: struphy.models.species.FieldSpecies

.. autoclass:: struphy.models.species.FluidSpecies

.. autoclass:: struphy.models.species.ParticleSpecies


Variable types
--------------

Each species can contain multiple variables.

.. autoclass:: struphy.models.variables.PICVariable

.. autoclass:: struphy.models.variables.FEECVariable

.. autoclass:: struphy.models.variables.SPHVariable


Particle parameters
-------------------

.. automethod:: struphy.models.species.ParticleSpecies.set_markers

.. autoclass:: struphy.particles.parameters.LoadingParameters

.. autoclass:: struphy.particles.parameters.WeightsParameters

.. autoclass:: struphy.particles.parameters.BoundaryParameters

.. autoclass:: struphy.particles.parameters.SortingParameters

.. autoclass:: struphy.particles.parameters.SavingParameters

.. autoclass:: struphy.particles.parameters.BinningPlot

.. autoclass:: struphy.particles.parameters.KernelDensityPlot


Fields background
-----------------

.. autoclass:: struphy.io.options.FieldsBackground


Perturbation functions
----------------------

.. autoclass:: struphy.initial.base.Perturbation

See available :ref:`perturbations`.