Development

Prerequisites

• Git
• cmake ¹

Optional

• VS Code with the following extensions
  • Python
  • Python Debugger
  • Rust Analyzer
• GitHub CLI

Development Cycle Overview

• Branch
• Develop
  • cargo build
  • develop:
    • tests
    • implementation
  • document:
    • mdbook build
      • output: automesh/book/build
    • mdbook serve --open
      • interactive mode
      • on local machine, with Firefox, open the index.html file., e.g.,
      • file:///Users/chovey/autotwin/automesh/book/build/index.html
  • test:
    • cargo test
    • cargo run // test without required input and output flags
    • cargo run --release -- -i tests/input/f.npy -o foo.exo
    • cargo run -- --help
  • precommit:
    • pre-commit run --all-files
  • clean:
    • cargo clean
  • cargo doc --open
• Test
  • maturin develop --release --features python
• Merge request

References

1. As of Oct 2024, cmake is required for hdf5-metno-src v0.9.2, used for writing Exodus II files. On macOS with brew, install with brew install cmake instead of the GUI installer. ↩