Bekerja dengan Q# proyek

Dengan rilis Azure Quantum Development Kit, Anda dapat menentukan Q# proyek, yang merupakan struktur folder dengan beberapa Q# file yang dapat mengakses sumber daya satu sama lain. Proyek sangat membantu untuk membuat pustaka yang dapat digunakan kembali dan secara logis mengatur kode sumber Anda.

Proyek Q# berisi Q# file manifes, bernama qsharp.json, dan satu atau beberapa file *.qs dalam struktur folder tertentu. Saat pengguna membuka file *.qs di Visual Studio Code, atau mengatur project_root dalam file Jupyter Notebook atau Python, pengompilasi mencari hierarki folder di sekitarnya untuk file manifes dan menentukan cakupan proyek. Jika tidak ada file manifes yang ditemukan, pengkompilasi beroperasi dalam mode file tunggal. Proyek Q# dapat dibuat secara manual atau langsung di Visual Studio Code.

Prasyarat

• Ruang kerja Azure Quantum di langganan Azure Anda. Untuk membuat ruang kerja, lihat Membuat ruang kerja Azure Quantum.
• Lingkungan Python dengan Python dan Pip terpasang.
• Visual Studio Code dengan ekstensi Azure Quantum Development Kit dan Python terinstal.
• Azure Quantum qsharp dan azure-quantum paket.

Q# Menentukan proyek

Proyek Q# didefinisikan oleh keberadaan file manifes qsharp.json dan folder src (yang berisi Q# file sumber), yang keduanya harus berada di folder akar proyek. Untuk Q# program, pengkompilasi Q# mendeteksi folder proyek secara otomatis. Untuk program Python dan Jupyter Notebooks, Anda harus menentukan Q# folder proyek dengan qsharp.init panggilan. Namun, struktur folder untuk Q# proyek tetap sama untuk semua jenis program.

Q# Menggunakan program

Menentukan folder proyek (Q# program)

Ketika file *.qs dibuka di Visual Studio Code, pengkompilasi Q# mencari ke atas dalam struktur folder untuk file manifes qsharp.json . Jika menemukan file manifes, pengkompilasi kemudian mencari ke bawah melalui semua subfolder direktori src untuk file *.qs dan menyimpan operasi atau fungsi apa pun, dan membuat operasi dan fungsi tersebut tersedia untuk semua file *.qs, sesuai aturan pengecualian file manifes.

Misalnya, mengingat struktur folder ini:

• Teleportation_project
  • qsharp.json
  • src
    • RunTeleport.qs
    • TeleportOperations
      • Teleport.qs
      • PrepareState
        • PrepareState.qs

saat Anda membuka file /src/TeleportOperation/PrepareState/PrepareState.qs, pengkompilasi Q# :

1. Memeriksa /src/TeleportOperation/PrepareState/ untuk file qsharp.json .
2. Memeriksa /src/TeleportOperation untuk qsharp.json.
3. Memeriksa /src untuk qsharp.json.
4. / Memeriksa qsharp.json.
5. Menetapkan / sebagai direktori akar proyek, dan menyertakan semua file *.qs di bawah akar dalam proyek, sesuai pengaturan file manifes.

Menggunakan Python atau Jupyter Notebook

Menentukan folder proyek (program Python dan Jupyter Notebook)

Saat Anda menggunakan program Python atau sel Jupyter Notebook untuk mengakses Q# sumber daya, Anda perlu mengatur direktori akar proyek secara langsung dengan qsharp.init pernyataan . Menggunakan struktur folder yang sama dari contoh sebelumnya

• Teleportation_project
  • qsharp.json
  • src
  • MyPythonProgram.py
    • RunTeleport.qs
    • TeleportOperations
      • Teleport.qs
      • PrepareState
        • PrepareState.qs

Anda akan mengatur project_root sebelum melakukan panggilan ke operasi apa pun Q# .

Dengan asumsi program Python Anda ada di Q# folder proyek

import qsharp

qsharp.init(project_root = './Teleportation_project')

Jalur folder akar relatif terhadap file yang mengaturnya, yang berarti bahwa folder proyek Anda Q# dapat berada di mana saja dan program panggilan tidak harus berada dalam proyek. Jalur yang valid mungkin juga './MyProjects/Teleportation_project', atau ../../Teleportation_project.

Pengkompilasi Q# memverifikasi ada file qsharp.json yang valid di folder akar yang ditentukan dan membuat sumber daya *.qs apa pun di bawah folder src tersedia untuk referensi, sesuai aturan pengecualian file manifes.

Create file manifes

File manifes adalah file .json sederhana bernama qsharp.json yang dapat secara opsional menyertakan bidang penulis, lisensi, dan .ints . File manifes minimum yang layak adalah string {}. Saat Anda membuat Q# proyek di Visual Studio Code, file manifes minimal dibuat untuk Anda.

{}

Contoh file manifes

Berikut ini adalah beberapa contoh bagaimana file manifes dapat menentukan cakupan proyek Anda Q# .

Dalam contoh ini, penulis adalah satu-satunya bidang yang ditentukan, dan oleh karena itu semua file *.qs dalam direktori ini dan semua subdirektorinya disertakan dalam Q# proyek.

{
    "author":"Microsoft"
}

{
    "author":"Microsoft",
    "license":"MIT"
}

Q# Dalam proyek, Anda juga dapat menggunakan file manifes untuk menyempurnakan pengaturan Linter Visual Studio CodeQ#. Secara default, tiga aturan Linter adalah:

• needlessParens: default = allow
• divisionByZero: default = warn
• redundantSemicolons: default = warn

Dengan menggunakan file manifes, Anda dapat mengatur setiap aturan ke allow, , warnatau error, misalnya

{
    "author":"Microsoft",
    "lints": [
        {
          "lint": "needlessParens",
          "level": "allow"
        },
        {
          "lint": "redundantSemicolons",
          "level": "warn"
        },
        {
          "lint": "divisionByZero",
          "level": "error"
        }
      ]
}

Q# persyaratan dan properti proyek

Persyaratan dan konfigurasi berikut berlaku untuk semua Q# proyek.

• Semua file *.qs yang ingin Anda sertakan dalam proyek harus berada di bawah folder bernama src, yang harus berada di bawah Q# folder akar proyek. Saat Anda membuat Q# proyek di Visual Studio Code, /src folder dibuat secara otomatis.
• File manifes qsharp.json harus berada pada tingkat yang sama dengan folder src . Saat Anda membuat Q# proyek di Visual Studio Code, file qsharp.json dibuat secara otomatis.
• Operasi dan fungsi dalam file sumber yang tersedia dapat diakses menggunakan open pernyataan:

open MyMathLib;
...
    Multiply(x,y);

atau mereferensikannya dengan namespace:

MyMathLib.Multiply(x,y);

Hanya untuk Q# program

• Hanya satu file *.qs dalam proyek yang Q#@EntryPoint() dapat ditentukan.
• File *.qs dengan @EntryPoint() definisi dapat ditemukan pada tingkat apa pun di bawah file manifes.
• Setiap operasi atau fungsi yang di-cache dari file *.qs di mana saja dalam Q# proyek ditampilkan dalam teks prediktif di Visual Studio Code.
• Jika namespace untuk operasi atau fungsi yang dipilih belum ditambahkan, Visual Studio Code secara otomatis menambahkan pernyataan yang diperlukan open .

Langkah-langkah untuk membuat Q# proyek

1. Di penjelajah file Visual Studio Code, klik kanan folder yang ingin Anda gunakan untuk Q# folder akar proyek dan pilih proyek CreateQ#, atau buka folder dan pilih Tampilkan > Palet >Q#Perintah : Create Q# proyek....

2. Visual Studio Code membuat file manifes qsharp.json minimal di folder, dan menambahkan /src folder dengan Main.qs file templat.

3. Edit file manifes sesuai kebutuhan. Lihat Contoh file manifes.

4. Tambahkan dan atur file sumber Anda Q# di /src bawah folder .

5. Jika Anda mengakses Q# proyek dari program Python atau Jupyter Notebook, atur jalur folder akar menggunakan qsharp.init. Contoh ini mengasumsikan program Anda berada di folder yang sama dengan folder Q# akar proyek:

   qsharp.init(project_root = './Teleportation_project')
   

6. Jika Anda hanya Q# menggunakan file di Visual Studio Code, saat Anda membuka Q# file, pengkompilasi mencari file manifes qsharp.json , menentukan folder akar proyek, lalu memindai subfolder untuk file *.qs.

Catatan

Anda juga dapat membuat file manifes dan /src folder secara manual di langkah 2.

Contoh proyek

Program teleportasi kuantum ini adalah contoh proyek berdasarkan struktur folder yang Q# ditunjukkan sebelumnya, dan berjalan pada simulator lokal di VS Code. Untuk menjalankan program pada perangkat keras Azure Quantum atau simulator pihak ketiga, lihat Mulai menggunakan Q# program dan VSCode untuk langkah-langkah mengkompilasi program Anda dan menyambungkan ke ruang kerja Azure Anda.

Contohnya menggunakan struktur direktori ini:

• Teleportation_project
  • qsharp.json
  • src
    • RunTeleport.qs
    • TeleportOperations
      • Teleport.qs
      • PrepareState
        • PrepareState.qs

File manifes qsharp.json berisi bidang penulis dan lisensi :

{
    "author":"Microsoft",
    "license":"MIT"
}

Q# file sumber

Dengan satu perbedaan kecil - @EntryPoint() pernyataan - file sumber sama untuk Q# program, program Python, atau Jupyter Notebook.

File utama, RunTeleport.qs, berisi titik entri dan mereferensikan TeleportLib namespace di Teleport.qs.

namespace RunTeleport {

    open TeleportLib;   // references the TeleportLib namespace in Teleport.qs

    @EntryPoint()       // @EntryPoint() not necessary for Python or Jupyter Notebook programs
    operation RunTeleportationExample() : Unit {
        use msg = Qubit();
        use target = Qubit();

        H(msg);
        Teleport(msg, target);    // calls the Teleport() operation from Teleport.qs
        H(target);

        if M(target) == Zero {
            Message("Teleported successfully!");
        
        Reset(msg);
        Reset(target);
        }
    }
}

Teleport.qs mendefinisikan Teleport() operasi dan memanggil PrepareBellPair() operasi dari PrepareState.qs.

namespace TeleportLib {

    open PrepareBell;     // references the PrepareBell namespace in PrepareState.qs
 
    operation Teleport(msg : Qubit, target : Qubit) : Unit {
        use here = Qubit();

        PrepareBellPair(here, target);      // calls the PrepareBellPair() operation from PrepareState.qs
        Adjoint PrepareBellPair(msg, here);

        if M(msg) == One { Z(target); }
        if M(here) == One { X(target); }

        Reset(here);
    }
}

File PrepareState.qs berisi operasi standar yang dapat digunakan kembali untuk membuat pasangan Bell.

namespace PrepareBell {    
    
    operation PrepareBellPair(left : Qubit, right : Qubit) : Unit is Adj + Ctl {
        H(left);
        CNOT(left, right);
    }
}

Menjalankan program

Pilih tab untuk lingkungan tempat Anda menjalankan program.

Q# Menjalankan program

Untuk menjalankan program ini, buka file RunTeleport.qs di Visual Studio Code dan pilih Jalankan.

Menjalankan Jupyter Notebook

Untuk program Jupyter Notebook, file sumber tidak memerlukan @EntryPoint() atribut . Fungsi file hanya sebagai pustaka sumber.

Untuk menjalankan program ini dalam Buku Catatan Juptyer, buka buku catatan baru dan jalankan sel berikut ini:

import qsharp

# set the root folder for the Q# project
# make adjustments to the path depending on where your program is saved

# this example assumes your program is in the same folder as the root folder
qsharp.init(project_root = './Teleportation_project')

Jika jalur Anda valid, Anda akan melihat pesan konfirmasi, Q# initialized with configuration: {'targetProfile': 'unrestricted'}

Jalankan program dengan memanggil operasi utama menggunakan %%qsharp perintah ajaib

%%qsharp
// call the main operation
RunTeleport.RunTeleportationExample();

atau dengan menggunakan qsharp.eval() pernyataan

print (qsharp.eval("RunTeleport.RunTeleportationExample()"));

Menjalankan program Python

Untuk program Python, file sumber tidak memerlukan @EntryPoint() atribut . Fungsi file hanya sebagai pustaka sumber.

Untuk menjalankan program ini, jalankan perintah berikut:

import qsharp

# set the root folder for the Q# project
# make adjustments to the path depending on where your program is saved

# this example assumes your program is in the same folder as the root folder
qsharp.init(project_root = '/.Teleportation_project')

Jika jalur Anda valid, Anda akan melihat pesan konfirmasi, Q# initialized with configuration: {'targetProfile': 'unrestricted'}

Jalankan program dengan memanggil operasi utama dengan qsharp.eval()

print (qsharp.eval("RunTeleport.RunTeleportationExample()"));