DRAFT: tket2-hseries hugr-cli plugin

ms3.json

@@ -0,0 +1 @@
+{"version":"live","nodes":[{"parent":0,"op":"Module"},{"parent":8,"op":"DataflowBlock","inputs":[],"other_outputs":[],"sum_rows":[[]],"extension_delta":[]},{"parent":8,"op":"ExitBlock","cfg_outputs":[]},{"parent":7,"op":"Input","types":[]},{"parent":1,"op":"Input","types":[]},{"parent":1,"op":"Output","types":[{"t":"Sum","s":"Unit","size":1}]},{"parent":7,"op":"Output","types":[]},{"parent":0,"op":"FuncDefn","name":"main","signature":{"params":[],"body":{"t":"G","input":[],"output":[],"extension_reqs":[]}}},{"parent":7,"op":"CFG","signature":{"t":"G","input":[],"output":[],"extension_reqs":[]}},{"parent":1,"op":"CustomOp","extension":"quantum.tket2","name":"QAlloc","signature":{"t":"G","input":[],"output":[{"t":"Opaque","extension":"prelude","id":"qubit","args":[],"bound":"A"}],"extension_reqs":[]},"description":"","args":[]},{"parent":1,"op":"CustomOp","extension":"quantum.tket2","name":"Reset","signature":{"t":"G","input":[{"t":"Opaque","extension":"prelude","id":"qubit","args":[],"bound":"A"}],"output":[{"t":"Opaque","extension":"prelude","id":"qubit","args":[],"bound":"A"}],"extension_reqs":[]},"description":"","args":[]},{"parent":1,"op":"CustomOp","extension":"quantum.tket2","name":"QAlloc","signature":{"t":"G","input":[],"output":[{"t":"Opaque","extension":"prelude","id":"qubit","args":[],"bound":"A"}],"extension_reqs":[]},"description":"","args":[]},{"parent":1,"op":"CustomOp","extension":"quantum.tket2","name":"Reset","signature":{"t":"G","input":[{"t":"Opaque","extension":"prelude","id":"qubit","args":[],"bound":"A"}],"output":[{"t":"Opaque","extension":"prelude","id":"qubit","args":[],"bound":"A"}],"extension_reqs":[]},"description":"","args":[]},{"parent":1,"op":"MakeTuple","tys":[{"t":"Opaque","extension":"prelude","id":"qubit","args":[],"bound":"A"},{"t":"Opaque","extension":"prelude","id":"qubit","args":[],"bound":"A"}]},{"parent":1,"op":"UnpackTuple","tys":[{"t":"Opaque","extension":"prelude","id":"qubit","args":[],"bound":"A"},{"t":"Opaque","extension":"prelude","id":"qubit","args":[],"bound":"A"}]},{"parent":1,"op":"Const","v":{"v":"Extension","extensions":["arithmetic.float.types"],"typ":{"t":"Opaque","extension":"arithmetic.float.types","id":"float64","args":[],"bound":"C"},"value":{"c":"ConstF64","v":{"value":3.1415}}}},{"parent":1,"op":"LoadConstant","datatype":{"t":"Opaque","extension":"arithmetic.float.types","id":"float64","args":[],"bound":"C"}},{"parent":1,"op":"CustomOp","extension":"quantum.tket2","name":"RzF64","signature":{"t":"G","input":[{"t":"Opaque","extension":"prelude","id":"qubit","args":[],"bound":"A"},{"t":"Opaque","extension":"arithmetic.float.types","id":"float64","args":[],"bound":"C"}],"output":[{"t":"Opaque","extension":"prelude","id":"qubit","args":[],"bound":"A"}],"extension_reqs":[]},"description":"","args":[]},{"parent":1,"op":"CustomOp","extension":"quantum.tket2","name":"ZZMax","signature":{"t":"G","input":[{"t":"Opaque","extension":"prelude","id":"qubit","args":[],"bound":"A"},{"t":"Opaque","extension":"prelude","id":"qubit","args":[],"bound":"A"}],"output":[{"t":"Opaque","extension":"prelude","id":"qubit","args":[],"bound":"A"},{"t":"Opaque","extension":"prelude","id":"qubit","args":[],"bound":"A"}],"extension_reqs":[]},"description":"","args":[]},{"parent":1,"op":"MakeTuple","tys":[{"t":"Opaque","extension":"prelude","id":"qubit","args":[],"bound":"A"},{"t":"Opaque","extension":"prelude","id":"qubit","args":[],"bound":"A"}]},{"parent":1,"op":"UnpackTuple","tys":[{"t":"Opaque","extension":"prelude","id":"qubit","args":[],"bound":"A"},{"t":"Opaque","extension":"prelude","id":"qubit","args":[],"bound":"A"}]},{"parent":1,"op":"CustomOp","extension":"quantum.tket2","name":"Measure","signature":{"t":"G","input":[{"t":"Opaque","extension":"prelude","id":"qubit","args":[],"bound":"A"}],"output":[{"t":"Opaque","extension":"prelude","id":"qubit","args":[],"bound":"A"},{"t":"Sum","s":"Unit","size":2}],"extension_reqs":[]},"description":"","args":[]},{"parent":1,"op":"CustomOp","extension":"quantum.tket2","name":"QFree","signature":{"t":"G","input":[{"t":"Opaque","extension":"prelude","id":"qubit","args":[],"bound":"A"}],"output":[],"extension_reqs":[]},"description":"","args":[]},{"parent":1,"op":"CustomOp","extension":"quantum.tket2","name":"Measure","signature":{"t":"G","input":[{"t":"Opaque","extension":"prelude","id":"qubit","args":[],"bound":"A"}],"output":[{"t":"Opaque","extension":"prelude","id":"qubit","args":[],"bound":"A"},{"t":"Sum","s":"Unit","size":2}],"extension_reqs":[]},"description":"","args":[]},{"parent":1,"op":"CustomOp","extension":"quantum.tket2","name":"QFree","signature":{"t":"G","input":[{"t":"Opaque","extension":"prelude","id":"qubit","args":[],"bound":"A"}],"output":[],"extension_reqs":[]},"description":"","args":[]},{"parent":1,"op":"Tag","tag":0,"variants":[[]]}],"edges":[[[1,0],[2,null]],[[9,0],[10,0]],[[10,0],[13,0]],[[11,0],[12,0]],[[12,0],[13,1]],[[13,0],[14,0]],[[14,0],[17,0]],[[14,1],[18,1]],[[15,0],[16,0]],[[16,0],[17,1]],[[17,0],[18,0]],[[18,0],[19,0]],[[18,1],[19,1]],[[19,0],[20,0]],[[20,0],[21,0]],[[20,1],[23,0]],[[21,0],[22,0]],[[23,0],[24,0]],[[25,0],[5,0]]],"metadata":null,"encoder":"hugr-py v0.5.0"}

tket2-hseries/Cargo.toml

@@ -13,6 +13,14 @@ description = "TKET2 tool for preparing and validating `Hugr`s for compilation t
 keywords = ["Quantum", "Quantinuum"]
 categories = ["compilers"]
 
+[features]
+default = ["cli"]
+cli = ["dep:clap", "dep:hugr-cli", "dep:clap-verbosity-flag", "dep:clio"]
+
+[[bin]]
+name = "tket2-hseries"
+required-features = ["cli"]
+
 [dependencies]
 hugr.workspace = true
 tket2 = { path = "../tket2", version = "0.2.0" }
@@ -24,6 +32,10 @@ strum.workspace = true
 strum_macros.workspace = true
 thiserror.workspace = true
 itertools.workspace = true
+clap = { workspace = true, optional = true}
+hugr-cli = { version = "*", optional = true }
+clap-verbosity-flag = { version = "*", optional = true }
+clio = { version = "*", features = ["clap-parse"], optional = true }
 
 [dev-dependencies]
 cool_asserts.workspace = true

tket2-hseries/src/bin/tket2-hseries.rs

@@ -0,0 +1,19 @@
+use clap::Parser as _;
+use clap_verbosity_flag::Level;
+use tket2_hseries::cli::CliArgs;
+
+fn main() {
+    match CliArgs::parse() {
+        CliArgs::Run(mut args) => {
+            if let Err(e) = args.run() {
+                if args.hugr_args.verbosity(Level::Error) {
+                    eprintln!("{}", e);
+                }
+            }
+        }
+        _ => {
+            eprintln!("Unknown command");
+            std::process::exit(1);
+        }
+    };
+}

tket2-hseries/src/cli.rs

@@ -0,0 +1,107 @@
+use std::error::Error;
+use std::io::Write;
+
+use clap::{Parser, ValueEnum};
+use clio::Output;
+
+use hugr::{
+    algorithms::validation::ValidationLevel, extension::ExtensionRegistry, hugr::hugrmut::HugrMut,
+    Hugr,
+};
+use hugr_cli::HugrArgs;
+
+use crate::HSeriesPass;
+
+/// CLI arguments.
+#[derive(Parser, Debug)]
+#[clap(version = "1.0", long_about = None)]
+#[clap(about = "HUGR CLI tools.")]
+#[group(id = "hugr")]
+#[non_exhaustive]
+pub enum CliArgs {
+    Run(RunArgs),
+}
+
+#[derive(Copy, Clone, PartialEq, Eq, PartialOrd, Ord, Debug, ValueEnum)]
+pub enum Pass {
+    All,
+    LazifyMeasure,
+    ForceOrder,
+}
+
+/// Validate and visualise a HUGR file.
+#[derive(Parser, Debug)]
+#[clap(version = "1.0", long_about = None)]
+#[clap(about = "Validate a HUGR.")]
+#[group(id = "hugr")]
+#[non_exhaustive]
+pub struct RunArgs {
+    #[command(flatten)]
+    /// common arguments
+    pub hugr_args: HugrArgs,
+
+    #[arg(value_enum, default_value = "all")]
+    pub pass: Pass,
+
+    #[arg(long = "validate", default_value = "true")]
+    pub validate_pass: bool,
+}
+
+#[derive(Parser, Debug)]
+#[clap(version = "1.0", long_about = None)]
+#[clap(about = "Validate a HUGR.")]
+#[group(id = "hugr")]
+#[non_exhaustive]
+pub struct RunCommand {
+    #[command(flatten)]
+    pub run_args: RunArgs,
+
+    /// Output file '-' for stdout
+    #[clap(long, short, value_parser, default_value = "-")]
+    output: Output,
+}
+
+impl RunArgs {
+    pub fn run(&mut self) -> Result<Hugr, Box<dyn Error>> {
+        let (hugrs, reg) = self.hugr_args.validate()?;
+        let Ok::<[_; 1], _>([mut hugr]) = hugrs.try_into() else {
+            Err("Only one module is supported".to_string())?
+        };
+        let validation_level = if self.validate_pass {
+            ValidationLevel::WithExtensions
+        } else {
+            ValidationLevel::WithoutExtensions
+        };
+
+        self.pass.run(&mut hugr, &reg, validation_level)?;
+        Ok(hugr)
+    }
+}
+
+impl RunCommand {
+    pub fn run(&mut self) -> Result<(), Box<dyn Error>> {
+        write!(
+            self.output,
+            "{}",
+            serde_json::to_string_pretty(&self.run_args.run()?)?
+        )?;
+        Ok(())
+    }
+}
+
+impl Pass {
+    pub fn run(
+        &self,
+        hugr: &mut impl HugrMut,
+        registry: &ExtensionRegistry,
+        level: ValidationLevel,
+    ) -> Result<(), Box<dyn Error>> {
+        let pass = HSeriesPass::default().with_validation_level(level);
+        match self {
+            Pass::All => pass.run(hugr, registry)?,
+            Pass::LazifyMeasure => pass.lazify_measure(hugr, registry)?,
+            Pass::ForceOrder => pass.force_order(hugr, registry)?,
+        };
+        Ok(())
+    }
+}