Welcome to criptic’s documentation!

Contents:

• Getting criptic
• License
• Introduction to criptic
• Unit systems in criptic
• Setting up a problem
  • Initializing the background gas state
  • Initializing cosmic ray propagation
  • Initializing cosmic ray packets
  • Initializing cosmic ray sources
  • Problem-specific work
  • Compile-time definitions
• Describing the background gas
  • The GasData class
  • The Gas class
  • Pre-defined gas descriptors
• Describing the cosmic ray propagation model
  • The PropagationData struct
  • The Propagation class
  • Pre-defined propagation descriptors
  • Field quantities
  • Limits on propagation parameters
• Building criptic
  • Language standard
  • Dependencies
  • Compiling and compilation flags
  • Machine-specific makefiles
• Parameter files
  • Global control parameters
  • Geometry parameters
  • Integrator parameters
  • Tree parameters
  • Loss parameters
  • Random number generator parameters
  • CR propagation parameters
  • Output parameters
  • Gas, cosmic ray propagation, and problem parameters
  • The ParmParser
• Running a criptic simulation
• Output files
  • cripticpy
  • Full contents of checkpoint files
• Simulating pitch angle evolution
  • Physical model and equations solved
  • Problem setup for pitch angle-dependent simulations
  • Propagation models for pitch angle-dependent simulations
  • Building and running criptic for pitch angle-dependent simulations
  • Output files for pitch angle-dependent simulations
• Reproducibility
  • What does reproducibility mean?
  • Why is reproducibility an issue for Criptic?
  • Controlling reproducibility
• Code layout for developers
• The criptic test suite
  • Testing workflow
  • Available test problems
  • Writing new tests
• Full documentation of criptic
• Full documentation of cripticpy
  • Tp()
  • heatscatter()
  • pT()
  • parseinput()
  • readchk()
  • readlastchk()
  • vp()

Indices and tables

• Index

• Module Index

• Search Page