Add crate preludes + make convenience

Author: ciaranra

Makefile

@@ -183,6 +183,12 @@ pip-install-uv:  ## Install uv using pip and create a venv. (Recommended to inst
 	@echo "Creating venv and installing dependencies..."
 	uv sync
 
+.PONY: dev
+dev: clean build test  ## Run the typical sequence of commands to check everything is running correctly
+
+.PONY: devl  ## Run the commands to make sure everything runs + lint
+devl: dev lint
+
 # Help
 # ----
 

crates/pecos-core/src/lib.rs

@@ -16,6 +16,7 @@ pub mod errors;
 pub mod gate;
 pub mod pauli;
 pub mod phase;
+pub mod prelude;
 pub mod qubit_id;
 pub mod rng;
 pub mod sets;

crates/pecos-core/src/prelude.rs

@@ -0,0 +1,17 @@
+// Copyright 2025 The PECOS Developers
+//
+// Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except
+// in compliance with the License.You may obtain a copy of the License at
+//
+//     https://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software distributed under the License
+// is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express
+// or implied. See the License for the specific language governing permissions and limitations under
+// the License.
+
+pub use crate::{
+    IndexableElement, Set, VecSet,
+    errors::PecosError,
+    rng::{RngManageable, rng_manageable::derive_seed},
+};

crates/pecos-engines/src/lib.rs

@@ -1,6 +1,7 @@
 pub mod byte_message;
 pub mod core;
 pub mod engines;
+pub mod prelude;
 
 // Re-exports for commonly used types
 pub use byte_message::{ByteMessage, ByteMessageBuilder, GateType, QuantumGate};

crates/pecos-engines/src/prelude.rs

@@ -0,0 +1,21 @@
+// Copyright 2025 The PECOS Developers
+//
+// Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except
+// in compliance with the License.You may obtain a copy of the License at
+//
+//     https://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software distributed under the License
+// is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express
+// or implied. See the License for the specific language governing permissions and limitations under
+// the License.
+
+pub use crate::{
+    ByteMessage, ByteMessageBuilder, ClassicalEngine, ControlEngine, DepolarizingNoiseModel,
+    Engine, EngineStage, EngineSystem, HybridEngine, MonteCarloEngine, NoiseModel,
+    PassThroughNoiseModel, QuantumEngine, QuantumSystem, ShotResult, ShotResults,
+    byte_message::dump_batch,
+    core::shot_results::OutputFormat,
+    engines::noise::general::GeneralNoiseModel,
+    engines::quantum::{SparseStabEngine, StateVecEngine, new_quantum_engine_arbitrary_qgate},
+};

crates/pecos-phir/src/lib.rs

@@ -1,6 +1,8 @@
 pub mod common;
 pub mod version_traits;
 
+pub mod prelude;
+
 // Version-specific implementations
 #[cfg(feature = "v0_1")]
 pub mod v0_1;

crates/pecos-phir/src/prelude.rs

@@ -0,0 +1 @@
+pub use crate::{PHIREngine, setup_phir_engine};

crates/pecos-qasm/src/lib.rs

@@ -47,6 +47,7 @@ pub mod engine;
 pub mod engine_builder;
 pub mod includes;
 pub mod parser;
+pub mod prelude;
 pub mod preprocessor;
 pub mod util;
 

crates/pecos-qasm/src/prelude.rs

@@ -0,0 +1,16 @@
+// Copyright 2025 The PECOS Developers
+//
+// Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except
+// in compliance with the License.You may obtain a copy of the License at
+//
+//     https://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software distributed under the License
+// is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express
+// or implied. See the License for the specific language governing permissions and limitations under
+// the License.
+
+pub use std::str::FromStr;
+
+pub use crate::engine::QASMEngine;
+pub use crate::engine_builder::QASMEngineBuilder;

crates/pecos-qir/src/lib.rs

@@ -1,13 +1,12 @@
-// Re-export the QIR engine components
 pub mod command_generation;
 pub mod common;
 pub mod compiler;
 pub mod engine;
 pub mod library;
 pub mod measurement;
 pub mod platform;
+pub mod prelude;
 pub mod runtime;
 pub mod state;
 
-// Public exports
 pub use engine::QirEngine;