Skip to main content
Ctrl+K
struphy 2.5.0 documentation - Home struphy 2.5.0 documentation - Home
  • Tl;dr
  • Install
  • Quickstart
  • Userguide
  • Tutorials
  • Numerics
  • Models
  • Geometry
    • Equilibria
    • Propagators
    • Particle modules
    • FEEC modules
    • Utilities
    • Developer’s guide
    • Struphy repo
    • Struphy LinkedIn
    • Struphy RocketChat
  • Tl;dr
  • Install
  • Quickstart
  • Userguide
  • Tutorials
  • Numerics
  • Models
  • Geometry
  • Equilibria
  • Propagators
  • Particle modules
  • FEEC modules
  • Utilities
  • Developer’s guide
  • Struphy repo
  • Struphy LinkedIn
  • Struphy RocketChat

Table of Contents

Contents:

  • Tl;dr
  • Install
  • Quickstart
  • Userguide
  • Tutorials
  • Numerics
  • Models
  • Geometry
  • Equilibria
  • Propagators
  • Particle modules
  • FEEC modules
  • Utilities
  • Developer’s guide

Previous topic

Quickstart

Next topic

The Struphy CLI

  • Userguide

Userguide#

There are two basic modes of how Struphy can be used:

  1. in Python programs, as for instance described in the notebook Tutorials

  2. via the Struphy CLI (command line interface)

In the CLI the overall help is displayed by typing:

struphy -h

To get more information on the sub-commands:

struphy COMMAND -h

The installed version is obtained by:

struphy -v

Contents:

  • The Struphy CLI
  • Simulation parameters
  • Initial conditions
  • Boundary conditions
  • Code profiling
  • Post-processing
  • Paraview

previous

Quickstart

next

The Struphy CLI

This Page

  • Show Source

© Copyright 2019-2025 (c) Struphy dev team | Max Planck Institute for Plasma Physics.

Created using Sphinx 8.1.3.

Built with the PyData Sphinx Theme 0.16.1.