nkDSL

nkDSL is a small standalone package that extracts the symbolic operator DSL from neuraLQX and makes it usable on its own. The core workflow is to describe a discrete operator in a compact, readable [D]eclarative [S]ymbolic [L]anguage (DSL) and compile it into a NetKet-compatible JAX operator.

Note

nkDSL is currently in beta. The core DSL and compiler workflow are ready for broader testing, while some advanced APIs may still evolve before a fully stable release.

The package is built around a simple four-step mental model:

1. choose where to act with an iterator

2. choose when to act with a predicate

3. choose how to update the state

4. choose the matrix element attached to each emitted branch

That description is lowered into a static-shape JAX connectivity kernel (default target: get_conn_padded).

Compilation also runs a linting pass that reports symbol, index, and connectivity diagnostics early. See Linting for details.

Getting started

• Overview
  • What nkDSL is for
  • The mental model
  • What gets compiled
  • Current scope
• Quick start
  • Installation
  • Example
  • What this example shows
  • Typical next step
• Compiler and execution
  • Operator lowering registry
  • From DSL to executable operator
  • Default passes
  • Diagnostics policy and strictness
  • Caching
  • Direct compiler usage
  • Compiled operators
  • How to read printed IR

The DSL

• The DSL
  • Linting
    • The Symbolic Operator
    • Selectors and expressions
    • Emissions and matrix elements
    • Linting
    • Currently Supported
    • Iterators
    • Conditions
    • Updates

Guides

• Guides
  • Extending the DSL
    • Extending DSL Iterators
    • Extending DSL Predicates
    • Extending DSL Emissions

Tutorials

• Tutorials
  • Ising model
  • Heisenberg model
  • J1-J2 model

Advanced Tutorials

• Advanced Tutorials
  • Custom Iterators
  • Custom Predicates
  • Reading Symbolic IR
  • Conditional Emissions (if / elseif / else)
  • Extending Emission Clauses

Reference

• API reference
  • Top-level exports
  • Modules

Project

• Changelog
  • nkDSL v0.1.2
  • nkDSL v0.1.1a0