Guides

Reference material for configuring runs, driving graintrace from an MCP client, benchmarking, avoiding common mistakes, and building the docs.

• Configuration reference
  • sculpt_config
  • sculpt_options
  • Boundary conditions (bc)
  • Segmentation
  • WeightConfig
  • CPFE parameters
  • Fragmentation & reorientation analysis
  • External-tool paths (tools.json)
• MCP server
  • What it exposes
  • Two safety behaviors
  • Recommendation recipes
  • Install
  • Connect a client
  • Notes
• Benchmarks
  • Graph segmentation
  • CPFE
  • Material calibration
  • Output
• Common pitfalls
  • NEPER is bring-your-own
  • CrystalGenerator seed is random by default
  • Derive the cpfe_base path dynamically
  • FF output orientations are always in degrees
  • orientation_tolerance units must match ori_units
  • grid_properties bounding box should be inset
  • CUDA material calibration: the model must be on the device
  • Use the GPU when one is available
  • Resuming a checkpoint validates the parameters that built it
  • The multiprocessing guard
  • Unsegmented voxels must not reach the mesh writers
  • Grain orientation averages need the crystal symmetry
• Building & testing the docs
  • System prerequisite: pandoc
  • Install the docs toolchain
  • Build the HTML
  • Doc tests
  • Continuous integration
  • Writing new pages
  • Definition of done (adding or changing code)