PacDessert1436.QSharpApp.Template 1.0.13

PacDessert1436.QSharpApp.Template

A .NET template for creating Q# (QSharp) console applications, with Quantum Game of Life as an example implementation.

Important Note: Version 1.0.13 is the stable release with all packaging issues resolved. The template now produces only the essential files (AppMain.qs and {YourProjectName}.csproj) with no extraneous artifacts.

Features

• 🚀 Ready-to-use Q# console application template
• 🎮 Quantum Game of Life simulation using quantum randomness
• 📦 Pre-configured with Microsoft Quantum Development Kit
• ✨ Clean project structure with best practices
• 📝 Complete C# project configuration with all necessary settings

Getting Started

Prerequisites

• .NET 8 SDK or later
• Microsoft Quantum Development Kit (QDK)

Installation

Install the template from NuGet:

dotnet new install PacDessert1436.QSharpApp.Template@1.0.13

• Note: @ is now the recommended way to specify the version number (:: was deprecated).

Or install the latest version:

dotnet new install PacDessert1436.QSharpApp.Template

Create a New Project

Use the template to create a new Q# console application:

dotnet new qsharpapp -n MyQuantumApp
cd MyQuantumApp

Run the Application

dotnet run

Template Structure

MyQuantumApp/
├── AppMain.qs           # Main Q# program with Game of Life implementation
└── MyQuantumApp.csproj  # C# project configuration file

C# Project Configuration

The generated MyQuantumApp.csproj includes the following key configurations:

SDK and Framework

• SDK: Microsoft.Quantum.Sdk (version 0.28.302812)
• Target Framework: .NET 8.0
• Output Type: Console Application (Exe)

Project Properties

• Root Namespace: Set to project name (e.g., MyQuantumApp)
• Implicit Usings: Enabled
• Nullable Reference Types: Enabled

Template Metadata (for package generation)

• PackageId: PacDessert1436.QSharpApp.Template
• Version: 1.0.12
• Title: Q# Console App Template
• Authors: Pac-Dessert1436
• PackageType: Template

Quantum Game of Life

This template implements Conway's Game of Life using quantum randomness for initial grid generation. Each cell's initial state is determined by measuring a qubit in superposition, creating a truly random starting configuration.

Key Q# Operations

• QuantumRandomBit() - Generates a random bit using quantum superposition
• GenerateRandomGrid() - Creates a grid with quantum-random initial states
• NextGeneration() - Computes the next generation using Game of Life rules
• PrintGrid() - Displays the grid in the console

Configuration

Modify the Main() operation in AppMain.qs to customize:

let cfg = GameOfLifeConfig(Width, Height, Generations);

• Width: Number of columns in the grid (default: 30)
• Height: Number of rows in the grid (default: 10)
• Generations: Number of simulation steps (default: 15)

Game of Life Rules

The simulation follows Conway's classic rules:

1. Alive cell (# symbol) survives if it has 2 or 3 live neighbors
2. Dead cell (. symbol) becomes alive if it has exactly 3 live neighbors
3. All other cells die or remain dead

Development

Build the Template

cd QSharpAppTemplate
dotnet pack

Test the Template

dotnet new qsharpapp -o TestApp
cd TestApp
dotnet run

License

This project is licensed under the BSD 3-Clause License. See the LICENSE file for details.

Resources

• Q# Documentation
• Microsoft Quantum Development Kit
• Conway's Game of Life

Version History