API reference

Release:

0.4.0

Date:

2025-10-27

You can find the implementation and documentation of every class and function of grogupy in this reference. The method and submodule index can be found here and here respectively.

• Physics
  • Physical classes
  • Background information
• Core
  • Constants
  • Cpu solvers
  • Gpu solvers
  • Utilities
  • IO utility functions
  • Physics utilities
• Input/Output
  • Input/Output Functions
• Batch calculations
  • Timers
  • Convergence
  • Examples
• Command line interface for grogupy
  • Scripts
• Visualization
  • Functions
  • Background information
  • Examples

tqdm in grogupy

tqdm is optional in grogupy, but when it is in use grogupy uses its own wrapper to handle edge cases and print only on the root node, when there is MPI parallelization.

_tqdm

Tqdm wrapper module for grogupy.

Configuration

This module contains the configuration from the environment, which helps to load or avoid the optional dependencies that can be part of grogupy. These optional dependencies are tqdm, CuPy for gpu acceleration and Plotly for visualization.

Config(architecture, tqdm)

Configuration class of grogupy.

The CONFIG instance contains the configuration of grogupy.