This is the documentation of the most upstream development version of GRACE. If you're looking for the last stable release please select a different version of this documentation.

GRACEpy Library

The GRACEpy library is a set of companion Python tools for the GRACE code.

It includes:

• Data analysis: readers for volume, plane, scalar and gravitational wave output, unified detector views, and a high-level simulation interface

• Physics utilities: physical constants, unit systems, gravitational wave analysis, Kerr-Schild coordinate transformations, and equation of state table handling

• Code generation: SymPy-based utilities to generate optimized C99 code for GRACE kernels

• Simulation management: simpilot, a tool to create, submit and monitor GRACE simulations on HPC clusters

• Command-line tools: descriptor creation, scalar export, grid inspection, source archival

Installation

Download the code from the repository and, preferably within a virtual environment, run

pip install -e ./

This installs all Python dependencies and registers the command-line entry points.

Sections

• Data Analysis
  • XMF Descriptors
  • VTK Reader
  • Scalar Data
  • Gravitational Wave Data
  • Detectors
  • The Simulation Interface
• Physics Utilities
  • Physical Constants
  • Unit Systems
  • Gravitational Wave Analysis
  • Kerr-Schild Transformations
  • Equation of State Tables
• Code Generation
  • Custom C99 Printer
  • Symbolic Derivatives
  • Emitting Assignments
  • Generating Complete Functions
• Simpilot
  • Setup
  • Machine Configuration
  • Creating a Simulation
  • Submitting a Simulation
  • Python API
• Command-Line Tools
  • create_descriptor
  • export_scalars
  • grace_info
  • archive_source
  • unpack_archive
  • convert_timers_to_ascii