Package neqsim.util.validation
package neqsim.util.validation
AI-friendly validation framework for NeqSim.
This package provides structured validation with actionable error messages designed for both human users and AI agents (like GitHub Copilot). Key features:
- Pre-execution validation to catch configuration errors early
- Structured error messages with severity levels
- Remediation hints that AI can parse and act upon
- Integration with NeqSim's ML/RL infrastructure
Quick Start:
// Validate any NeqSim object
ValidationResult result = SimulationValidator.validate(fluid);
if (!result.isValid()) {
System.out.println(result.getReport());
// Each issue includes: severity, message, remediation hint
}
// For process systems with RL integration
AIIntegrationHelper helper = AIIntegrationHelper.forProcess(process);
if (helper.isReady()) {
ExecutionResult result = helper.safeRun();
RLEnvironment env = helper.createRLEnvironment();
}
Key Classes:
ValidationResult- Container for validation issuesSimulationValidator- Static validation facadeAIIntegrationHelper- Unified AI/ML entry point
Severity Levels:
CRITICAL- Blocks execution, must be fixedMAJOR- Likely to cause incorrect resultsMINOR- Unexpected but not fatalINFO- Informational note
- Since:
- 1.0
- See Also:
-
ClassDescriptionAI Integration Helper for NeqSim.Result of a safe execution.Execution status.AI-friendly validation helper for NeqSim simulations.Common validation result container for NeqSim components.Severity level for validation issues.A single validation issue.