IQ# - Fullstate Simulator V1 Output Format

src/AzureClient/AzureClient.cs

@@ -8,6 +8,7 @@
 using System.IO;
 using System.Net;
 using System.Net.Http;
+using System.Runtime.InteropServices.ComTypes;
 using System.Threading;
 
 using Azure.Core;
@@ -23,6 +24,18 @@
 
 namespace Microsoft.Quantum.IQSharp.AzureClient
 {
+    /// <summary>
+    /// Supported output data formats for QIR.
+    /// </summary>
+    internal static class OutputFormat
+    {
+        public const string QirResultsV1 = "microsoft.qir-results.v1";
+
+        public const string QuantumResultsV1 = "microsoft.quantum-results.v1";
+
+        public const string ResourceEstimatesV1 = "microsoft.resource-estimates.v1";
+    }
+
     /// <inheritdoc/>
     public class AzureClient : IAzureClient
     {
@@ -635,7 +648,7 @@ public async Task<ExecutionResult> GetJobResultAsync(IChannel? channel, string?
             }
         }
 
-        private async Task<ExecutionResult> CreateOutput(CloudJob job, IChannel? channel, CancellationToken cancellationToken)
+        internal async Task<ExecutionResult> CreateOutput(CloudJob job, IChannel? channel, CancellationToken cancellationToken)
         {
             async Task<Stream> ReadHttp()
             {
@@ -649,16 +662,22 @@ async Task<Stream> ReadHttp()
             using var stream = job.OutputDataUri.IsFile
                 ? File.OpenRead(job.OutputDataUri.LocalPath)
                 : await ReadHttp();
-            if (this.ActiveTarget?.TargetId?.StartsWith(MicrosoftSimulator) ?? false)
+
+            if (job.OutputDataFormat == OutputFormat.QirResultsV1)
             {
                 var (messages, result) = ParseSimulatorOutput(stream);
                 channel?.Stdout(messages);
                 return result.ToExecutionResult();
             }
-            else
+            else if (job.OutputDataFormat == OutputFormat.QuantumResultsV1)
             {
                 return stream.ToHistogram(channel, Logger).ToExecutionResult();
             }
+            else
+            {
+                channel?.Stderr($"Job ID {job.Id} has unsupported output format: {job.OutputDataFormat}");
+                return AzureClientError.JobOutputDownloadFailed.ToExecutionResult();
+            }
         }
 
         private static (string Messages, string Result) ParseSimulatorOutput(Stream stream)
@@ -669,7 +688,7 @@ private static (string Messages, string Result) ParseSimulatorOutput(Stream stre
                 var line = String.Empty;
                 while ((line = reader.ReadLine()) != null)
                 {
-                     outputLines.Add(line.Trim());
+                    outputLines.Add(line.Trim());
                 }
             }
 

src/AzureClient/AzureClient.csproj

@@ -17,7 +17,7 @@
 
   <ItemGroup>
     <PackageReference Include="Azure.Quantum.Jobs" Version="1.0.0-beta.3" />
-    <PackageReference Include="Microsoft.Azure.Quantum.Client" Version="0.25.228311" />
+    <PackageReference Include="Microsoft.Azure.Quantum.Client" Version="0.26.230521-beta" />
     <PackageReference Include="Microsoft.Rest.ClientRuntime" Version="2.3.23" />
     <PackageReference Include="Microsoft.Rest.ClientRuntime.Azure" Version="3.3.19" />
     <PackageReference Include="System.Reactive" Version="4.3.2" />

src/AzureClient/Mocks/MockCloudJob.cs

@@ -55,12 +55,13 @@ public float? EstimatedTotal
     /// </summary>
     internal class MockJobDetails : JobDetails
     {
-        public MockJobDetails(string containerUri, string inputDataFormat, string providerId, string target)
+        public MockJobDetails(string containerUri, string inputDataFormat, string providerId, string target, string outputDataFormat)
             : base(containerUri: containerUri, 
                    inputDataFormat: inputDataFormat, 
                    providerId: providerId, 
                    target: target)
         {
+            OutputDataFormat = outputDataFormat;
         }
 
         private MockCostEstimate? costEstimate;
@@ -110,14 +111,15 @@ internal class MockCloudJob : CloudJob
         private string _id;
         private string? _outputFile;
 
-        public MockCloudJob(string? id = null)
+        public MockCloudJob(string? id = null, string outputFormat = OutputFormat.QuantumResultsV1)
             : base(
                 new MockAzureWorkspace("mockSubscriptionId", "mockResourceGroupName", "mockWorkspaceName", "mockLocation"),
                 new MockJobDetails(
                     containerUri: string.Empty,
                     inputDataFormat: string.Empty,
                     providerId: string.Empty,
-                    target: string.Empty
+                    target: string.Empty,
+                    outputDataFormat: outputFormat
                 ))
         {
             _id = id ?? Guid.NewGuid().ToString();
@@ -135,7 +137,16 @@ public override Uri OutputDataUri
                 {
                     var path = Path.GetTempFileName();
                     using var outputFile = new StreamWriter(path);
-                    outputFile.WriteLine(@"{'Histogram':['0',0.5,'1',0.5]}");
+                    if (OutputDataFormat == OutputFormat.QirResultsV1)
+                    {
+                        outputFile.WriteLine("\"This is a message.\"");
+                        outputFile.WriteLine("\"The is a two-line");
+                        outputFile.WriteLine("string result.\"");
+                    }
+                    else
+                    {
+                        outputFile.WriteLine(@"{'Histogram':['0',0.5,'1',0.5]}");
+                    }
 
                     _outputFile = path;
                 }

src/Core/Compiler/CompilerService.cs

@@ -304,9 +304,17 @@ public IEnumerable<QsNamespaceElement> IdentifyElements(string source, ITaskRepo
                     ? TargetPackageAssemblyPaths(executionTarget, capability?.Name)
                     : Enumerable.Empty<string>();
             Logger.LogDebug("Using target package assemblies:\n{TargetAssemblies}", string.Join("\n", targetPackages));
+
+            var processorArchitecture = executionTarget ?? string.Empty;
+            if (string.Compare(executionTarget, "microsoft.simulator.fullstate", StringComparison.InvariantCultureIgnoreCase) == 0)
+            {
+                processorArchitecture = AssemblyConstants.MicrosoftSimulator;
+            }
+
             var assemblyConstants = new Dictionary<string, string>
             {
-                [AssemblyConstants.ProcessorArchitecture] = executionTarget ?? string.Empty,
+                [AssemblyConstants.ProcessorArchitecture] = processorArchitecture,
+                [AssemblyConstants.TargetCapability] = capability?.Name ?? string.Empty,
                 [AssemblyConstants.TargetPackageAssemblies] =
                     string.Join(";", targetPackages.Where(s => !string.IsNullOrWhiteSpace(s)))
             };
@@ -454,7 +462,7 @@ string WrapInNamespace(Snippet s) =>
                     var tempPath = Path.GetTempFileName();
                     var bcFile = CompilationLoader.GeneratedFile(tempPath, Path.GetDirectoryName(tempPath), ".bc", "");
                     var diagnostics = new List<IRewriteStep.Diagnostic>();
-                    CompilationSteps.GenerateBitcode(qsCompilation, capability, bcFile, diagnostics: diagnostics);
+                    CompilationSteps.GenerateBitcode(qsCompilation, (IDictionary<string, string?>)assemblyConstants, bcFile, diagnostics: diagnostics);
                     foreach (var diagnostic in diagnostics)
                     {
                         Logger?.Log(

src/Core/Core.csproj

@@ -40,11 +40,11 @@
     <PackageReference Include="Microsoft.CSharp" Version="4.5.0" />
     <PackageReference Include="Microsoft.Extensions.DependencyInjection.Abstractions" Version="3.0.0" />
     <PackageReference Include="Microsoft.Extensions.Logging" Version="3.0.0" />
-    <PackageReference Include="Microsoft.Quantum.Compiler" Version="0.25.228311" />
-    <PackageReference Include="Microsoft.Quantum.QirGeneration" Version="0.25.228311" />
-    <PackageReference Include="Microsoft.Quantum.CSharpGeneration" Version="0.25.228311" />
-    <PackageReference Include="Microsoft.Quantum.Simulators" Version="0.25.228311" />
-    <PackageReference Include="Microsoft.Quantum.QSharp.Core" Version="0.25.228311" />
+    <PackageReference Include="Microsoft.Quantum.Compiler" Version="0.26.230521-beta" />
+    <PackageReference Include="Microsoft.Quantum.QirGeneration" Version="0.26.230521-beta" />
+    <PackageReference Include="Microsoft.Quantum.CSharpGeneration" Version="0.26.230521-beta" />
+    <PackageReference Include="Microsoft.Quantum.Simulators" Version="0.26.230521-beta" />
+    <PackageReference Include="Microsoft.Quantum.QSharp.Core" Version="0.26.230521-beta" />
     <PackageReference Include="Microsoft.Windows.Compatibility" Version="5.0.2" />
     <PackageReference Include="NuGet.Resolver" Version="5.1.0" />
     <PackageReference Include="System.DirectoryServices.Protocols" Version="5.0.1" />

src/ExecutionPathTracer/ExecutionPathTracer.csproj

@@ -32,7 +32,7 @@
   </ItemGroup>
 
   <ItemGroup>
-    <PackageReference Include="Microsoft.Quantum.Simulators" Version="0.25.228311" />
+    <PackageReference Include="Microsoft.Quantum.Simulators" Version="0.26.230521-beta" />
   </ItemGroup>
 
 </Project>

src/Kernel/Kernel.csproj

@@ -26,7 +26,7 @@
 
   <ItemGroup>
     <PackageReference Include="System.Reactive" Version="4.3.2" />
-	<PackageReference Include="Microsoft.Quantum.QirGeneration" Version="0.25.228311" />
+	<PackageReference Include="Microsoft.Quantum.QirGeneration" Version="0.26.230521-beta" />
   </ItemGroup>
 
   <!-- TypeScript compilation -->

src/MockLibraries/Mock.Chemistry/Mock.Chemistry.csproj

@@ -1,11 +1,11 @@
-<Project Sdk="Microsoft.Quantum.Sdk/0.25.228311">
+<Project Sdk="Microsoft.Quantum.Sdk/0.26.230521-beta">
 
   <PropertyGroup>
     <TargetFramework>netstandard2.1</TargetFramework>
     <IncludeQsharpCorePackages>false</IncludeQsharpCorePackages>    <!-- otherwise the standard library is included by the Sdk -->
   </PropertyGroup>
 
   <ItemGroup>
-    <PackageReference Include="Microsoft.Quantum.Simulators" Version="0.25.228311" />
+    <PackageReference Include="Microsoft.Quantum.Simulators" Version="0.26.230521-beta" />
   </ItemGroup>
 </Project>

src/MockLibraries/Mock.Standard/Mock.Standard.csproj

@@ -1,11 +1,11 @@
-<Project Sdk="Microsoft.Quantum.Sdk/0.25.228311">
+<Project Sdk="Microsoft.Quantum.Sdk/0.26.230521-beta">
 
   <PropertyGroup>
     <TargetFramework>netstandard2.1</TargetFramework>
     <IncludeQsharpCorePackages>false</IncludeQsharpCorePackages>    <!-- otherwise the standard library is included by the Sdk -->
   </PropertyGroup>
 
   <ItemGroup>
-    <PackageReference Include="Microsoft.Quantum.Simulators" Version="0.25.228311" />
+    <PackageReference Include="Microsoft.Quantum.Simulators" Version="0.26.230521-beta" />
   </ItemGroup>
 </Project>

src/Tests/AzureClientTests.cs

@@ -330,6 +330,35 @@ public void TestJobExecution()
             Assert.IsNotNull(histogram);
         }
 
+        [TestMethod]
+        public void TestJobOutputFormats()
+        {
+            var services = Startup.CreateServiceProvider("Workspace");
+            var azureClient = (AzureClient)services.GetRequiredService<IAzureClient>();
+
+            // connect
+            var targets = ExpectSuccess<IEnumerable<TargetStatusInfo>>(ConnectToWorkspaceAsync(azureClient));
+            Assert.IsFalse(targets.Any());
+
+            // add a target
+            var azureWorkspace = azureClient.ActiveWorkspace as MockAzureWorkspace;
+            Assert.IsNotNull(azureWorkspace);
+            azureWorkspace?.AddProviders("microsoft");
+
+            // set the active target
+            var target = ExpectSuccess<TargetStatusInfo>(azureClient.SetActiveTargetAsync(new MockChannel(), "microsoft.simulator"));
+            Assert.AreEqual("microsoft.simulator", target.TargetId);
+
+            var qirResultsJob = new MockCloudJob(null, OutputFormat.QirResultsV1);
+            var quantumResultsJob = new MockCloudJob(null, OutputFormat.QuantumResultsV1);
+
+            var histogram = ExpectSuccess<Histogram>(azureClient.CreateOutput(quantumResultsJob, new MockChannel(), CancellationToken.None));
+            Assert.IsNotNull(histogram);
+
+            var stringOutput = ExpectSuccess<string>(azureClient.CreateOutput(qirResultsJob, new MockChannel(), CancellationToken.None));
+            Assert.IsNotNull(stringOutput);
+        }
+
         [TestMethod]
         public void TestJobExecutionWithArrayInput()
         {

src/Tests/NugetPackagesTests.cs

@@ -20,7 +20,7 @@ public class NugetPackagesTests
         /// We use a known-good version to avoid breaking IQ# tests due to changes in Libraries
         /// also, to make sure an end-to-end QDK build does not have circular build dependencies
         /// between Libraries and IQ#.
-        public static readonly NuGetVersion QDK_LIBRARIES_VERSION = NuGetVersion.Parse("0.25.228311");
+        public static readonly NuGetVersion QDK_LIBRARIES_VERSION = NuGetVersion.Parse("0.26.230521-beta");
 
         public NugetPackages Init()
         {

src/Tests/Workspace.ProjectReferences.ProjectA/ProjectA.csproj

@@ -1,4 +1,4 @@
-<Project Sdk="Microsoft.Quantum.Sdk/0.25.228311">
+<Project Sdk="Microsoft.Quantum.Sdk/0.26.230521-beta">
 
   <PropertyGroup>
     <TargetFramework>netstandard2.1</TargetFramework>

src/Tests/Workspace.ProjectReferences.ProjectB/ProjectB.csproj

@@ -1,4 +1,4 @@
-<Project Sdk="Microsoft.Quantum.Sdk/0.25.228311">
+<Project Sdk="Microsoft.Quantum.Sdk/0.26.230521-beta">
 
   <PropertyGroup>
     <TargetFramework>netstandard2.1</TargetFramework>

src/Tests/Workspace.ProjectReferences/Workspace.ProjectReferences.csproj

@@ -1,4 +1,4 @@
-<Project Sdk="Microsoft.Quantum.Sdk/0.25.228311">
+<Project Sdk="Microsoft.Quantum.Sdk/0.26.230521-beta">
 
   <PropertyGroup>
     <TargetFramework>netstandard2.1</TargetFramework>
@@ -7,7 +7,7 @@
   </PropertyGroup>
 
   <ItemGroup>
-    <PackageReference Include="Microsoft.Quantum.Xunit" Version="0.25.228311" />
+    <PackageReference Include="Microsoft.Quantum.Xunit" Version="0.26.230521-beta" />
   </ItemGroup>
 
   <ItemGroup>

src/Tool/appsettings.json

@@ -6,23 +6,23 @@
     },
     "AllowedHosts": "*",
     "DefaultPackageVersions": [
-        "Microsoft.Quantum.Compiler::0.25.228311",
-        "Microsoft.Quantum.CSharpGeneration::0.25.228311",
-        "Microsoft.Quantum.QirGeneration::0.25.228311",
+        "Microsoft.Quantum.Compiler::0.26.230521-beta",
+        "Microsoft.Quantum.CSharpGeneration::0.26.230521-beta",
+        "Microsoft.Quantum.QirGeneration::0.26.230521-beta",
         "Microsoft.Quantum.Development.Kit::0.25.228311",
-        "Microsoft.Quantum.Simulators::0.25.228311",
-        "Microsoft.Quantum.Xunit::0.25.228311",
-        "Microsoft.Quantum.Standard::0.25.228311",
-        "Microsoft.Quantum.Standard.Visualization::0.25.228311",
-        "Microsoft.Quantum.Chemistry::0.25.228311",
-        "Microsoft.Quantum.Chemistry.Jupyter::0.25.228311",
-        "Microsoft.Quantum.MachineLearning::0.25.228311",
-        "Microsoft.Quantum.Numerics::0.25.228311",
-        "Microsoft.Quantum.Katas::0.25.228311",
-        "Microsoft.Quantum.Research::0.25.228311",
-        "Microsoft.Quantum.Providers.IonQ::0.25.228311",
-        "Microsoft.Quantum.Providers.Honeywell::0.25.228311",
-        "Microsoft.Quantum.Providers.QCI::0.25.228311",
-        "Microsoft.Quantum.Providers.Rigetti::0.25.228311"
+        "Microsoft.Quantum.Simulators::0.26.230521-beta",
+        "Microsoft.Quantum.Xunit::0.26.230521-beta",
+        "Microsoft.Quantum.Standard::0.26.230521-beta",
+        "Microsoft.Quantum.Standard.Visualization::0.26.230521-beta",
+        "Microsoft.Quantum.Chemistry::0.26.230521-beta",
+        "Microsoft.Quantum.Chemistry.Jupyter::0.26.230521-beta",
+        "Microsoft.Quantum.MachineLearning::0.26.230521-beta",
+        "Microsoft.Quantum.Numerics::0.26.230521-beta",
+        "Microsoft.Quantum.Katas::0.26.230521-beta",
+        "Microsoft.Quantum.Research::0.26.230521-beta",
+        "Microsoft.Quantum.Providers.IonQ::0.26.230521-beta",
+        "Microsoft.Quantum.Providers.Honeywell::0.26.230521-beta",
+        "Microsoft.Quantum.Providers.QCI::0.26.230521-beta",
+        "Microsoft.Quantum.Providers.Rigetti::0.26.230521-beta"
     ]
 }