diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml index fa5a4ba94..9d51b1a18 100644 --- a/.github/workflows/main.yml +++ b/.github/workflows/main.yml @@ -5,7 +5,7 @@ name: Build and run tests on: push: - branches-ignore: [ "beta" ] + branches-ignore: [ "beta", "user-exposure-tagging" ] # Hacky way to only run pull requests from forked repositories (assumes : is not used in branch names unless forked) # https://github.community/t/how-to-trigger-an-action-on-push-or-pull-request-but-not-both/16662/10 pull_request: diff --git a/pygsti/algorithms/compilers.py b/pygsti/algorithms/compilers.py index ac0c79331..c7ca7cac7 100644 --- a/pygsti/algorithms/compilers.py +++ b/pygsti/algorithms/compilers.py @@ -1,3 +1,4 @@ +## user-exposure: low (EGN) """ Clifford circuit, CNOT circuit, and stabilizer state/measurement generation compilation routines """ diff --git a/pygsti/algorithms/contract.py b/pygsti/algorithms/contract.py index c24f4f204..a358ab01c 100644 --- a/pygsti/algorithms/contract.py +++ b/pygsti/algorithms/contract.py @@ -1,3 +1,4 @@ +## user-exposure: minimal, forsaken (EGN) """ GST contraction algorithms """ diff --git a/pygsti/algorithms/core.py b/pygsti/algorithms/core.py index 44ecd95da..a607c6bc1 100644 --- a/pygsti/algorithms/core.py +++ b/pygsti/algorithms/core.py @@ -1,3 +1,4 @@ +## user-exposure: high (EGN - for "old"-style GST API e.g. run_gst_fit) """ Core GST algorithms """ diff --git a/pygsti/algorithms/directx.py b/pygsti/algorithms/directx.py index 13fd0fb09..a107d78df 100644 --- a/pygsti/algorithms/directx.py +++ b/pygsti/algorithms/directx.py @@ -1,3 +1,4 @@ +## user-exposure: minimal, forsaken (EGN - we don't use this anymore and never really did) """ Functions for generating Direct-(LGST, MC2GST, MLGST) models """ diff --git a/pygsti/algorithms/fiducialpairreduction.py b/pygsti/algorithms/fiducialpairreduction.py index 438e82ee8..c34310119 100644 --- a/pygsti/algorithms/fiducialpairreduction.py +++ b/pygsti/algorithms/fiducialpairreduction.py @@ -1,3 +1,4 @@ +## user-exposure: high (EGN - users use these functions for building GST experiment designs) """ Functions for reducing the number of required fiducial pairs for analysis. """ diff --git a/pygsti/algorithms/fiducialselection.py b/pygsti/algorithms/fiducialselection.py index 39ff8d6de..ba84af086 100644 --- a/pygsti/algorithms/fiducialselection.py +++ b/pygsti/algorithms/fiducialselection.py @@ -1,3 +1,4 @@ +## user-exposure: high (CIO - users use these functions for building GST experiment designs) """ Functions for selecting a complete set of fiducials for a GST analysis. """ diff --git a/pygsti/algorithms/gaugeopt.py b/pygsti/algorithms/gaugeopt.py index fcd52d267..f5f2ddab3 100644 --- a/pygsti/algorithms/gaugeopt.py +++ b/pygsti/algorithms/gaugeopt.py @@ -1,3 +1,4 @@ +## user-exposure: low (CIO - manually gauge optimizing models is typically an advanced use case) """ GST gauge optimization algorithms """ diff --git a/pygsti/algorithms/germselection.py b/pygsti/algorithms/germselection.py index c2885690a..8c9e7b86b 100644 --- a/pygsti/algorithms/germselection.py +++ b/pygsti/algorithms/germselection.py @@ -1,3 +1,4 @@ +## user-exposure: high (CIO - users use these functions for building GST experiment designs) """ Functions for selecting a complete set of germs for a GST analysis. """ diff --git a/pygsti/algorithms/grammatrix.py b/pygsti/algorithms/grammatrix.py index d834cc546..675a112ff 100644 --- a/pygsti/algorithms/grammatrix.py +++ b/pygsti/algorithms/grammatrix.py @@ -1,3 +1,4 @@ +## user-exposure: minimal (CIO - Only presently utilized in creation of gram matrix spectrum plots in reports) """ Utility functions related to Gram matrix construction. """ diff --git a/pygsti/algorithms/grasp.py b/pygsti/algorithms/grasp.py index 5d70402c0..7f4a1f94f 100644 --- a/pygsti/algorithms/grasp.py +++ b/pygsti/algorithms/grasp.py @@ -1,3 +1,4 @@ +## user-exposure : minimal (Used internally in certain combinatorial optimization problems, but also less frequently nowadays) """ Functions to facilitate using GRASP. """ diff --git a/pygsti/algorithms/mirroring.py b/pygsti/algorithms/mirroring.py index 74dc2bcec..cde8a0138 100644 --- a/pygsti/algorithms/mirroring.py +++ b/pygsti/algorithms/mirroring.py @@ -1,3 +1,4 @@ +## user-exposure: low (Tentative, probably only used in RB internals, but check with Timothy or Jordan) """ circuit mirroring functions. """ diff --git a/pygsti/algorithms/randomcircuit.py b/pygsti/algorithms/randomcircuit.py index da4a42a8d..400bc681a 100644 --- a/pygsti/algorithms/randomcircuit.py +++ b/pygsti/algorithms/randomcircuit.py @@ -1,3 +1,4 @@ +## user-exposure: low (Tentative, probably only used in RB internals, but check with Jordan) """ Random circuit sampling functions. """ diff --git a/pygsti/algorithms/rbfit.py b/pygsti/algorithms/rbfit.py index ba54b3706..799788272 100644 --- a/pygsti/algorithms/rbfit.py +++ b/pygsti/algorithms/rbfit.py @@ -1,3 +1,4 @@ +## user-exposure: low (Tentative, probably only used in RB internals, but check with Jordan) """ Functions for analyzing RB data """ diff --git a/pygsti/algorithms/robust_phase_estimation.py b/pygsti/algorithms/robust_phase_estimation.py index c5ec90a86..e61f56d9b 100644 --- a/pygsti/algorithms/robust_phase_estimation.py +++ b/pygsti/algorithms/robust_phase_estimation.py @@ -1,3 +1,4 @@ +## user-exposure: low (Tentative, probably only used in RPE internals, but check with Kenny) """ Robust Phase Estimation platform agnostic portion """ diff --git a/pygsti/algorithms/scoring.py b/pygsti/algorithms/scoring.py index 7879088c2..a79591920 100644 --- a/pygsti/algorithms/scoring.py +++ b/pygsti/algorithms/scoring.py @@ -1,3 +1,4 @@ +## user-exposure: minimal (CIO- used internally in a number of experiment design related combinatorial optimization routines) """ Common functions used in scoring germ and fiducial sets. """