metriq-gym/.env.example at main · unitaryfoundation/metriq-gym · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
# Copy this file to .env and fill in the values as needed.
# Note that many of these are not required and have default values.

# This directory is used to store job execution configuration, intermediate data, and results.
# Optional, defaults to the platform-specific app data directory (e.g. ~/Library/Application Support/metriq-gym on macOS).
MGYM_LOCAL_DB_DIR="<MGYM_LOCAL_DB_DIR>"

# This directory is used to store local simulator results and is not required for cloud-based simulations.
# Optional, defaults to the platform-specific app cache directory (e.g. ~/Library/Caches/metriq-gym on macOS).
MGYM_LOCAL_SIMULATOR_CACHE_DIR="<MGYM_LOCAL_SIMULATOR_CACHE_DIR>"

# Metriq
# Obtained at: https://metriq.info/Token
METRIQ_CLIENT_API_KEY="<METRIQ_CLIENT_API_KEY>"

# AWS
# Obtained at: https://aws.amazon.com/braket/
AWS_ACCESS_KEY_ID="<AWS_ACCESS_KEY_ID>"
AWS_SECRET_ACCESS_KEY="<AWS_SECRET_ACCESS_KEY>"

# Azure
# Obtained at: https://portal.azure.com/
AZURE_QUANTUM_CONNECTION_STRING="<AZURE_SUBSCRIPTION_ID>"

# IBM
# Obtained at: https://quantum.cloud.ibm.com
QISKIT_IBM_TOKEN="<IBM Cloud API key>" # (from https://cloud.ibm.com/iam/apikeys)
QISKIT_IBM_CHANNEL="<Channel type>" # (Optional, default: "ibm_quantum_platform")
QISKIT_IBM_INSTANCE="<Instance CRN>" # (Optional)

# Quantinuum (NEXUS)
# Basic auth for NEXUS; use username/password.
# This also requires a manual login workflow to link the account the first time.
# From your command line, please run `qnx login` and follow the instructions.
QUANTINUUM_NEXUS_USERNAME="<QUANTINUUM_NEXUS_USERNAME>"
QUANTINUUM_NEXUS_PASSWORD="<QUANTINUUM_NEXUS_PASSWORD>"
QUANTINUUM_NEXUS_PROJECT_NAME="metriq-gym"
# Optional optimisation level for compilation (default: 1)
QUANTINUUM_NEXUS_OPT_LEVEL="1"

# OriginQ Wukong
# Obtained at: https://account.originqc.com.cn/
ORIGIN_API_KEY="<ORIGINQ_API_KEY>"

# IonQ
# Obtained at: https://cloud.ionq.com/settings/keys
IONQ_API_KEY="<IONQ_API_KEY>"

# qBraid
# Obtained at: https://account.qbraid.com/
QBRAID_API_KEY="<QBRAID_API_KEY>"

# GitHub upload (mgym job upload)
# Repository to open PRs against, format: owner/repo (default: unitaryfoundation/metriq-data)
MGYM_UPLOAD_REPO="unitaryfoundation/metriq-data"
# Base branch for PRs (default: main)
MGYM_UPLOAD_BASE_BRANCH="main"
# Directory in the repo to place the JSON file (optional).
# If unset, mgym uses: results/v<major.minor> (e.g., results/v0.3)
MGYM_UPLOAD_DIR=""
# Optional working directory for clones
MGYM_UPLOAD_CLONE_DIR="<PATH>"
# GitHub token used to push and create PRs
# Create a Personal Access Token (classic) with repo scope, or a fine-grained token.
# Fine-grained token tips: set Resource owner to your account; grant access to All repositories (or ensure future forks are covered),
# and grant repository permissions: Contents (Read and write) and Pull requests (Read and write).
# Docs: https://docs.github.com/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token
# Token settings: https://github.com/settings/tokens
GITHUB_TOKEN="<GITHUB_TOKEN>"