Repository files navigation


pyGSTi 0.9


Build Status

Overview:

This is the root directory of the pyGSTi software, which is a Python implementation of Gate Set Tomography. pyGSTi free software, licensed under the GNU General Public License (GPL). Copyright and license information can be found in license.txt, and the GPL itself in COPYING.

Getting Started:

pyGSTi is written entirely in Python, and so there's no compiling necessary. The first step is to install Python (and Jupyter notebook is highly recommended) if you haven't already. In order to use pyGSTi you need to tell your Python distribution where pyGSTi lives, which can be done in one of two ways:

  • User-Only Installation

    To install pyGSTi for the current user, run python install_locally.py

    This adds the current pyGSTi path to Python's list of search paths, and doesn't require administrative access. Typically you want to do this if you've cloned the pyGSTi GitHub repository and want any changes you make to your local file to have effect when you import pygsti from Python. You'd also want to use this option if you'd like long-term access the tutorial notebook files in the jupyter_notebooks directory under this one, since this means you'll be keeping this directory around anyway.

  • System-Wide Installation

    To install pyGSTi for all users, run: python setup.py install

    This installs the pyGSTi Python package into one of the Python distribution's search directories. This typically requires administrative privileges, and is the way most Python packages are installed. Installing this way has the advantage that it makes the package available to all users and then allows you to move or delete the directory you're installing from. If you don't use this method you must not delete this directory so long as you want to use pyGSTi.

    Reasons you may not want to use this installation method are

    • pyGSTi comes with (Jupyter notebook) tutorials that you may want to access for weeks and years to come (i.e. you plan to keep this pyGSTi directory around for a while).
    • you've cloned the pyGSTi repository and want this local set of files to be the one Python uses when you import pygsti.

Using pyGSTi

After you've installed pyGSTi, you should be able to import the pygsti Python package. The next thing to do is take a look at the tutorials, which you do by:

  • Changing to the notebook directory, by running: cd jupyter_notebooks/Tutorials/

  • Start up the Jupyter notebook server by running: jupyter notebook

The Jupyter server should open up your web browser to the server root, from where you can start the first "00" tutorial notebook. (Note that the key command to execute a cell within the Jupyter notebook is Shift+Enter, not just Enter.)

Congratulations! You're up and running with pyGSTi!

Documentation

Online documentation is hosted on Read the Docs. Instructions for building the documentation locally are contained in the file doc/build/howToBuild.txt.

Questions?

For help and support with pyGSTi, please contact the authors at pygsti@sandia.gov.

Brief description of the directory structure:

doc/ : Directory containing the HTML documentation and other
reference documents.
jupyter_notebooks/ : Parent directory of all Jupyter notebook tutorial
files included with pyGSTi. It is convenient to
start an Jupyter notebook server from within this
directory.
packages/ : Directory containing the (one) package provided by pyGSTi.
All of the Python source code lies here.
tests/ : Directory containing pyGSTi unit tests.
install_locally.py : A Python script that sets up the software to run from its current location within the file system. This
essentially adds the packages directory to the list of
directories Python uses to search for packages in, so
that ``import pygsti`` will work for any Python script,
regardless of its location in the file system. This
action is local to the user running the script, and does
not copy any files to any system directories, making it a
good option for a user without administrative access.
COPYING : A text version of the GNU General Public License.
license.txt : A text file giving copyright and licensing information
about pyGSTi.

About

A python implementation of Gate Set Tomography

Resources

Stars

0 stars

Watchers

1 watching

Forks

Releases

Packages

Contributors

Languages

, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all
 blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks");
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '
Skip to content

Repository files navigation


pyGSTi 0.9


Build Status

Overview:

This is the root directory of the pyGSTi software, which is a Python implementation of Gate Set Tomography. pyGSTi free software, licensed under the GNU General Public License (GPL). Copyright and license information can be found in license.txt, and the GPL itself in COPYING.

Getting Started:

pyGSTi is written entirely in Python, and so there's no compiling necessary. The first step is to install Python (and Jupyter notebook is highly recommended) if you haven't already. In order to use pyGSTi you need to tell your Python distribution where pyGSTi lives, which can be done in one of two ways:

  • User-Only Installation

    To install pyGSTi for the current user, run python install_locally.py

    This adds the current pyGSTi path to Python's list of search paths, and doesn't require administrative access. Typically you want to do this if you've cloned the pyGSTi GitHub repository and want any changes you make to your local file to have effect when you import pygsti from Python. You'd also want to use this option if you'd like long-term access the tutorial notebook files in the jupyter_notebooks directory under this one, since this means you'll be keeping this directory around anyway.

  • System-Wide Installation

    To install pyGSTi for all users, run: python setup.py install

    This installs the pyGSTi Python package into one of the Python distribution's search directories. This typically requires administrative privileges, and is the way most Python packages are installed. Installing this way has the advantage that it makes the package available to all users and then allows you to move or delete the directory you're installing from. If you don't use this method you must not delete this directory so long as you want to use pyGSTi.

    Reasons you may not want to use this installation method are

    • pyGSTi comes with (Jupyter notebook) tutorials that you may want to access for weeks and years to come (i.e. you plan to keep this pyGSTi directory around for a while).
    • you've cloned the pyGSTi repository and want this local set of files to be the one Python uses when you import pygsti.

Using pyGSTi

After you've installed pyGSTi, you should be able to import the pygsti Python package. The next thing to do is take a look at the tutorials, which you do by:

  • Changing to the notebook directory, by running: cd jupyter_notebooks/Tutorials/

  • Start up the Jupyter notebook server by running: jupyter notebook

The Jupyter server should open up your web browser to the server root, from where you can start the first "00" tutorial notebook. (Note that the key command to execute a cell within the Jupyter notebook is Shift+Enter, not just Enter.)

Congratulations! You're up and running with pyGSTi!

Documentation

Online documentation is hosted on Read the Docs. Instructions for building the documentation locally are contained in the file doc/build/howToBuild.txt.

Questions?

For help and support with pyGSTi, please contact the authors at pygsti@sandia.gov.

Brief description of the directory structure:

doc/ : Directory containing the HTML documentation and other
reference documents.
jupyter_notebooks/ : Parent directory of all Jupyter notebook tutorial
files included with pyGSTi. It is convenient to
start an Jupyter notebook server from within this
directory.
packages/ : Directory containing the (one) package provided by pyGSTi.
All of the Python source code lies here.
tests/ : Directory containing pyGSTi unit tests.
install_locally.py : A Python script that sets up the software to run from its current location within the file system. This
essentially adds the packages directory to the list of
directories Python uses to search for packages in, so
that ``import pygsti`` will work for any Python script,
regardless of its location in the file system. This
action is local to the user running the script, and does
not copy any files to any system directories, making it a
good option for a user without administrative access.
COPYING : A text version of the GNU General Public License.
license.txt : A text file giving copyright and licensing information
about pyGSTi.

About

A python implementation of Gate Set Tomography

Resources

Stars

0 stars

Watchers

1 watching

Forks

Releases

Packages

Contributors

Languages

, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Force GitHub README to respect dark mode\n(function() {\n var style = document.createElement('style');\n style.textContent = '\n .markdown-body {\n color-scheme: dark light;\n }\n .markdown-body pre { background: #161b22 !important; }\n .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }\n .markdown-body table th, .markdown-body table td { border-color: #30363d !important; }\n .markdown-body img { background: #0d1117; }\n .markdown-body blockquote { border-left-color: #8b949e; }\n .markdown-body hr { border-color: #30363d; }\n ';\n document.head.appendChild(style);\n})();", "GitHub Dark Mode README Fix"); } } catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content

Repository files navigation


pyGSTi 0.9


Build Status

Overview:

This is the root directory of the pyGSTi software, which is a Python implementation of Gate Set Tomography. pyGSTi free software, licensed under the GNU General Public License (GPL). Copyright and license information can be found in license.txt, and the GPL itself in COPYING.

Getting Started:

pyGSTi is written entirely in Python, and so there's no compiling necessary. The first step is to install Python (and Jupyter notebook is highly recommended) if you haven't already. In order to use pyGSTi you need to tell your Python distribution where pyGSTi lives, which can be done in one of two ways:

  • User-Only Installation

    To install pyGSTi for the current user, run python install_locally.py

    This adds the current pyGSTi path to Python's list of search paths, and doesn't require administrative access. Typically you want to do this if you've cloned the pyGSTi GitHub repository and want any changes you make to your local file to have effect when you import pygsti from Python. You'd also want to use this option if you'd like long-term access the tutorial notebook files in the jupyter_notebooks directory under this one, since this means you'll be keeping this directory around anyway.

  • System-Wide Installation

    To install pyGSTi for all users, run: python setup.py install

    This installs the pyGSTi Python package into one of the Python distribution's search directories. This typically requires administrative privileges, and is the way most Python packages are installed. Installing this way has the advantage that it makes the package available to all users and then allows you to move or delete the directory you're installing from. If you don't use this method you must not delete this directory so long as you want to use pyGSTi.

    Reasons you may not want to use this installation method are

    • pyGSTi comes with (Jupyter notebook) tutorials that you may want to access for weeks and years to come (i.e. you plan to keep this pyGSTi directory around for a while).
    • you've cloned the pyGSTi repository and want this local set of files to be the one Python uses when you import pygsti.

Using pyGSTi

After you've installed pyGSTi, you should be able to import the pygsti Python package. The next thing to do is take a look at the tutorials, which you do by:

  • Changing to the notebook directory, by running: cd jupyter_notebooks/Tutorials/

  • Start up the Jupyter notebook server by running: jupyter notebook

The Jupyter server should open up your web browser to the server root, from where you can start the first "00" tutorial notebook. (Note that the key command to execute a cell within the Jupyter notebook is Shift+Enter, not just Enter.)

Congratulations! You're up and running with pyGSTi!

Documentation

Online documentation is hosted on Read the Docs. Instructions for building the documentation locally are contained in the file doc/build/howToBuild.txt.

Questions?

For help and support with pyGSTi, please contact the authors at pygsti@sandia.gov.

Brief description of the directory structure:

doc/ : Directory containing the HTML documentation and other
reference documents.
jupyter_notebooks/ : Parent directory of all Jupyter notebook tutorial
files included with pyGSTi. It is convenient to
start an Jupyter notebook server from within this
directory.
packages/ : Directory containing the (one) package provided by pyGSTi.
All of the Python source code lies here.
tests/ : Directory containing pyGSTi unit tests.
install_locally.py : A Python script that sets up the software to run from its current location within the file system. This
essentially adds the packages directory to the list of
directories Python uses to search for packages in, so
that ``import pygsti`` will work for any Python script,
regardless of its location in the file system. This
action is local to the user running the script, and does
not copy any files to any system directories, making it a
good option for a user without administrative access.
COPYING : A text version of the GNU General Public License.
license.txt : A text file giving copyright and licensing information
about pyGSTi.

About

A python implementation of Gate Set Tomography

Resources

Stars

0 stars

Watchers

1 watching

Forks

Releases

Packages

Contributors

Languages

, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Highlight search terms from Google/DuckDuckGo/Bing referrer\n(function() {\n var ref = document.referrer;\n var terms = [];\n \n if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {\n var url = new URL(ref);\n var q = url.searchParams.get('q') || url.searchParams.get('p');\n if (q) {\n terms = q.split(/\\s+/).filter(function(t) { return t.length > 2; });\n }\n }\n \n if (terms.length === 0) return;\n \n var style = document.createElement('style');\n style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';\n document.head.appendChild(style);\n \n function highlight(node) {\n if (node.nodeType === 3) { // text node\n var text = node.textContent;\n var found = false;\n terms.forEach(function(term) {\n var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\\]\\\\]/g, '\\\\') + ')', 'gi');\n if (regex.test(text)) {\n found = true;\n var frag = document.createDocumentFragment();\n var parts = text.split(regex);\n parts.forEach(function(part, i) {\n if (i % 2 === 0) {\n frag.appendChild(document.createTextNode(part));\n } else {\n var span = document.createElement('span');\n span.className = 'userscript-highlight';\n span.textContent = part;\n frag.appendChild(span);\n }\n });\n node.parentNode.replaceChild(frag, node);\n }\n });\n } else if (node.nodeType === 1 && node.childNodes) { // element\n var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];\n if (!skipTags.includes(node.tagName)) {\n Array.from(node.childNodes).forEach(highlight);\n }\n }\n }\n \n highlight(document.body);\n \n // Re-highlight on dynamic content\n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1 || node.nodeType === 3) highlight(node);\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Highlight Search Terms"); } } catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content

Repository files navigation


pyGSTi 0.9


Build Status

Overview:

This is the root directory of the pyGSTi software, which is a Python implementation of Gate Set Tomography. pyGSTi free software, licensed under the GNU General Public License (GPL). Copyright and license information can be found in license.txt, and the GPL itself in COPYING.

Getting Started:

pyGSTi is written entirely in Python, and so there's no compiling necessary. The first step is to install Python (and Jupyter notebook is highly recommended) if you haven't already. In order to use pyGSTi you need to tell your Python distribution where pyGSTi lives, which can be done in one of two ways:

  • User-Only Installation

    To install pyGSTi for the current user, run python install_locally.py

    This adds the current pyGSTi path to Python's list of search paths, and doesn't require administrative access. Typically you want to do this if you've cloned the pyGSTi GitHub repository and want any changes you make to your local file to have effect when you import pygsti from Python. You'd also want to use this option if you'd like long-term access the tutorial notebook files in the jupyter_notebooks directory under this one, since this means you'll be keeping this directory around anyway.

  • System-Wide Installation

    To install pyGSTi for all users, run: python setup.py install

    This installs the pyGSTi Python package into one of the Python distribution's search directories. This typically requires administrative privileges, and is the way most Python packages are installed. Installing this way has the advantage that it makes the package available to all users and then allows you to move or delete the directory you're installing from. If you don't use this method you must not delete this directory so long as you want to use pyGSTi.

    Reasons you may not want to use this installation method are

    • pyGSTi comes with (Jupyter notebook) tutorials that you may want to access for weeks and years to come (i.e. you plan to keep this pyGSTi directory around for a while).
    • you've cloned the pyGSTi repository and want this local set of files to be the one Python uses when you import pygsti.

Using pyGSTi

After you've installed pyGSTi, you should be able to import the pygsti Python package. The next thing to do is take a look at the tutorials, which you do by:

  • Changing to the notebook directory, by running: cd jupyter_notebooks/Tutorials/

  • Start up the Jupyter notebook server by running: jupyter notebook

The Jupyter server should open up your web browser to the server root, from where you can start the first "00" tutorial notebook. (Note that the key command to execute a cell within the Jupyter notebook is Shift+Enter, not just Enter.)

Congratulations! You're up and running with pyGSTi!

Documentation

Online documentation is hosted on Read the Docs. Instructions for building the documentation locally are contained in the file doc/build/howToBuild.txt.

Questions?

For help and support with pyGSTi, please contact the authors at pygsti@sandia.gov.

Brief description of the directory structure:

doc/ : Directory containing the HTML documentation and other
reference documents.
jupyter_notebooks/ : Parent directory of all Jupyter notebook tutorial
files included with pyGSTi. It is convenient to
start an Jupyter notebook server from within this
directory.
packages/ : Directory containing the (one) package provided by pyGSTi.
All of the Python source code lies here.
tests/ : Directory containing pyGSTi unit tests.
install_locally.py : A Python script that sets up the software to run from its current location within the file system. This
essentially adds the packages directory to the list of
directories Python uses to search for packages in, so
that ``import pygsti`` will work for any Python script,
regardless of its location in the file system. This
action is local to the user running the script, and does
not copy any files to any system directories, making it a
good option for a user without administrative access.
COPYING : A text version of the GNU General Public License.
license.txt : A text file giving copyright and licensing information
about pyGSTi.

About

A python implementation of Gate Set Tomography

Resources

Stars

0 stars

Watchers

1 watching

Forks

Releases

Packages

Contributors

Languages

, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Strip utm_, fbclid, gclid, etc. from all links on page\n(function() {\n var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',\n 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',\n 'ref', 'ref_src', 'source', 'medium', 'campaign'];\n \n function cleanUrl(url) {\n try {\n var u = new URL(url, window.location.origin);\n var changed = false;\n trackingParams.forEach(function(p) {\n if (u.searchParams.has(p)) {\n u.searchParams.delete(p);\n changed = true;\n }\n });\n return changed ? u.toString() : url;\n } catch (e) {\n return url;\n }\n }\n \n function cleanLinks() {\n document.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n \n cleanLinks();\n \n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1) {\n if (node.tagName === 'A') cleanLinks();\n node.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Remove Tracking Parameters from Links"); } } catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); } })(); (function(){ try { var __m = "youtube.com"; var __re = new RegExp('^' + "youtube\\.com" + '
Skip to content

Repository files navigation


pyGSTi 0.9


Build Status

Overview:

This is the root directory of the pyGSTi software, which is a Python implementation of Gate Set Tomography. pyGSTi free software, licensed under the GNU General Public License (GPL). Copyright and license information can be found in license.txt, and the GPL itself in COPYING.

Getting Started:

pyGSTi is written entirely in Python, and so there's no compiling necessary. The first step is to install Python (and Jupyter notebook is highly recommended) if you haven't already. In order to use pyGSTi you need to tell your Python distribution where pyGSTi lives, which can be done in one of two ways:

  • User-Only Installation

    To install pyGSTi for the current user, run python install_locally.py

    This adds the current pyGSTi path to Python's list of search paths, and doesn't require administrative access. Typically you want to do this if you've cloned the pyGSTi GitHub repository and want any changes you make to your local file to have effect when you import pygsti from Python. You'd also want to use this option if you'd like long-term access the tutorial notebook files in the jupyter_notebooks directory under this one, since this means you'll be keeping this directory around anyway.

  • System-Wide Installation

    To install pyGSTi for all users, run: python setup.py install

    This installs the pyGSTi Python package into one of the Python distribution's search directories. This typically requires administrative privileges, and is the way most Python packages are installed. Installing this way has the advantage that it makes the package available to all users and then allows you to move or delete the directory you're installing from. If you don't use this method you must not delete this directory so long as you want to use pyGSTi.

    Reasons you may not want to use this installation method are

    • pyGSTi comes with (Jupyter notebook) tutorials that you may want to access for weeks and years to come (i.e. you plan to keep this pyGSTi directory around for a while).
    • you've cloned the pyGSTi repository and want this local set of files to be the one Python uses when you import pygsti.

Using pyGSTi

After you've installed pyGSTi, you should be able to import the pygsti Python package. The next thing to do is take a look at the tutorials, which you do by:

  • Changing to the notebook directory, by running: cd jupyter_notebooks/Tutorials/

  • Start up the Jupyter notebook server by running: jupyter notebook

The Jupyter server should open up your web browser to the server root, from where you can start the first "00" tutorial notebook. (Note that the key command to execute a cell within the Jupyter notebook is Shift+Enter, not just Enter.)

Congratulations! You're up and running with pyGSTi!

Documentation

Online documentation is hosted on Read the Docs. Instructions for building the documentation locally are contained in the file doc/build/howToBuild.txt.

Questions?

For help and support with pyGSTi, please contact the authors at pygsti@sandia.gov.

Brief description of the directory structure:

doc/ : Directory containing the HTML documentation and other
reference documents.
jupyter_notebooks/ : Parent directory of all Jupyter notebook tutorial
files included with pyGSTi. It is convenient to
start an Jupyter notebook server from within this
directory.
packages/ : Directory containing the (one) package provided by pyGSTi.
All of the Python source code lies here.
tests/ : Directory containing pyGSTi unit tests.
install_locally.py : A Python script that sets up the software to run from its current location within the file system. This
essentially adds the packages directory to the list of
directories Python uses to search for packages in, so
that ``import pygsti`` will work for any Python script,
regardless of its location in the file system. This
action is local to the user running the script, and does
not copy any files to any system directories, making it a
good option for a user without administrative access.
COPYING : A text version of the GNU General Public License.
license.txt : A text file giving copyright and licensing information
about pyGSTi.

About

A python implementation of Gate Set Tomography

Resources

Stars

0 stars

Watchers

1 watching

Forks

Releases

Packages

Contributors

Languages

, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default"); } } catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content

Repository files navigation


pyGSTi 0.9


Build Status

Overview:

This is the root directory of the pyGSTi software, which is a Python implementation of Gate Set Tomography. pyGSTi free software, licensed under the GNU General Public License (GPL). Copyright and license information can be found in license.txt, and the GPL itself in COPYING.

Getting Started:

pyGSTi is written entirely in Python, and so there's no compiling necessary. The first step is to install Python (and Jupyter notebook is highly recommended) if you haven't already. In order to use pyGSTi you need to tell your Python distribution where pyGSTi lives, which can be done in one of two ways:

  • User-Only Installation

    To install pyGSTi for the current user, run python install_locally.py

    This adds the current pyGSTi path to Python's list of search paths, and doesn't require administrative access. Typically you want to do this if you've cloned the pyGSTi GitHub repository and want any changes you make to your local file to have effect when you import pygsti from Python. You'd also want to use this option if you'd like long-term access the tutorial notebook files in the jupyter_notebooks directory under this one, since this means you'll be keeping this directory around anyway.

  • System-Wide Installation

    To install pyGSTi for all users, run: python setup.py install

    This installs the pyGSTi Python package into one of the Python distribution's search directories. This typically requires administrative privileges, and is the way most Python packages are installed. Installing this way has the advantage that it makes the package available to all users and then allows you to move or delete the directory you're installing from. If you don't use this method you must not delete this directory so long as you want to use pyGSTi.

    Reasons you may not want to use this installation method are

    • pyGSTi comes with (Jupyter notebook) tutorials that you may want to access for weeks and years to come (i.e. you plan to keep this pyGSTi directory around for a while).
    • you've cloned the pyGSTi repository and want this local set of files to be the one Python uses when you import pygsti.

Using pyGSTi

After you've installed pyGSTi, you should be able to import the pygsti Python package. The next thing to do is take a look at the tutorials, which you do by:

  • Changing to the notebook directory, by running: cd jupyter_notebooks/Tutorials/

  • Start up the Jupyter notebook server by running: jupyter notebook

The Jupyter server should open up your web browser to the server root, from where you can start the first "00" tutorial notebook. (Note that the key command to execute a cell within the Jupyter notebook is Shift+Enter, not just Enter.)

Congratulations! You're up and running with pyGSTi!

Documentation

Online documentation is hosted on Read the Docs. Instructions for building the documentation locally are contained in the file doc/build/howToBuild.txt.

Questions?

For help and support with pyGSTi, please contact the authors at pygsti@sandia.gov.

Brief description of the directory structure:

doc/ : Directory containing the HTML documentation and other
reference documents.
jupyter_notebooks/ : Parent directory of all Jupyter notebook tutorial
files included with pyGSTi. It is convenient to
start an Jupyter notebook server from within this
directory.
packages/ : Directory containing the (one) package provided by pyGSTi.
All of the Python source code lies here.
tests/ : Directory containing pyGSTi unit tests.
install_locally.py : A Python script that sets up the software to run from its current location within the file system. This
essentially adds the packages directory to the list of
directories Python uses to search for packages in, so
that ``import pygsti`` will work for any Python script,
regardless of its location in the file system. This
action is local to the user running the script, and does
not copy any files to any system directories, making it a
good option for a user without administrative access.
COPYING : A text version of the GNU General Public License.
license.txt : A text file giving copyright and licensing information
about pyGSTi.

About

A python implementation of Gate Set Tomography

Resources

Stars

0 stars

Watchers

1 watching

Forks

Releases

Packages

Contributors

Languages

, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers"); } } catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content

Repository files navigation


pyGSTi 0.9


Build Status

Overview:

This is the root directory of the pyGSTi software, which is a Python implementation of Gate Set Tomography. pyGSTi free software, licensed under the GNU General Public License (GPL). Copyright and license information can be found in license.txt, and the GPL itself in COPYING.

Getting Started:

pyGSTi is written entirely in Python, and so there's no compiling necessary. The first step is to install Python (and Jupyter notebook is highly recommended) if you haven't already. In order to use pyGSTi you need to tell your Python distribution where pyGSTi lives, which can be done in one of two ways:

  • User-Only Installation

    To install pyGSTi for the current user, run python install_locally.py

    This adds the current pyGSTi path to Python's list of search paths, and doesn't require administrative access. Typically you want to do this if you've cloned the pyGSTi GitHub repository and want any changes you make to your local file to have effect when you import pygsti from Python. You'd also want to use this option if you'd like long-term access the tutorial notebook files in the jupyter_notebooks directory under this one, since this means you'll be keeping this directory around anyway.

  • System-Wide Installation

    To install pyGSTi for all users, run: python setup.py install

    This installs the pyGSTi Python package into one of the Python distribution's search directories. This typically requires administrative privileges, and is the way most Python packages are installed. Installing this way has the advantage that it makes the package available to all users and then allows you to move or delete the directory you're installing from. If you don't use this method you must not delete this directory so long as you want to use pyGSTi.

    Reasons you may not want to use this installation method are

    • pyGSTi comes with (Jupyter notebook) tutorials that you may want to access for weeks and years to come (i.e. you plan to keep this pyGSTi directory around for a while).
    • you've cloned the pyGSTi repository and want this local set of files to be the one Python uses when you import pygsti.

Using pyGSTi

After you've installed pyGSTi, you should be able to import the pygsti Python package. The next thing to do is take a look at the tutorials, which you do by:

  • Changing to the notebook directory, by running: cd jupyter_notebooks/Tutorials/

  • Start up the Jupyter notebook server by running: jupyter notebook

The Jupyter server should open up your web browser to the server root, from where you can start the first "00" tutorial notebook. (Note that the key command to execute a cell within the Jupyter notebook is Shift+Enter, not just Enter.)

Congratulations! You're up and running with pyGSTi!

Documentation

Online documentation is hosted on Read the Docs. Instructions for building the documentation locally are contained in the file doc/build/howToBuild.txt.

Questions?

For help and support with pyGSTi, please contact the authors at pygsti@sandia.gov.

Brief description of the directory structure:

doc/ : Directory containing the HTML documentation and other
reference documents.
jupyter_notebooks/ : Parent directory of all Jupyter notebook tutorial
files included with pyGSTi. It is convenient to
start an Jupyter notebook server from within this
directory.
packages/ : Directory containing the (one) package provided by pyGSTi.
All of the Python source code lies here.
tests/ : Directory containing pyGSTi unit tests.
install_locally.py : A Python script that sets up the software to run from its current location within the file system. This
essentially adds the packages directory to the list of
directories Python uses to search for packages in, so
that ``import pygsti`` will work for any Python script,
regardless of its location in the file system. This
action is local to the user running the script, and does
not copy any files to any system directories, making it a
good option for a user without administrative access.
COPYING : A text version of the GNU General Public License.
license.txt : A text file giving copyright and licensing information
about pyGSTi.

About

A python implementation of Gate Set Tomography

Resources

Stars

0 stars

Watchers

1 watching

Forks

Releases

Packages

Contributors

Languages

, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Universal Dark Mode - works on any site\n(function() {\n var enabled = true;\n \n function applyDarkMode() {\n if (!enabled) return;\n \n // Create style element if it doesn't exist\n var style = document.getElementById('universal-dark-mode-style');\n if (!style) {\n style = document.createElement('style');\n style.id = 'universal-dark-mode-style';\n document.head.appendChild(style);\n }\n \n // Dark mode CSS - inverts colors but preserves images/video\n style.textContent = '\n /* Invert everything except media */\n html {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #1a1a2e !important;\n }\n \n /* Restore images, videos, iframes, canvas */\n img, video, iframe, canvas, svg, picture, [style*=\"background-image\"] {\n filter: invert(1) hue-rotate(180deg) !important;\n }\n \n /* Preserve specific elements that should not be inverted */\n .no-dark-mode, .no-dark-mode *,\n [data-theme=\"light\"], [data-theme=\"light\"],\n .ace_editor, .ace_editor *,\n .CodeMirror, .CodeMirror *,\n .monaco-editor, .monaco-editor *,\n .markdown-body pre, .markdown-body pre *,\n .highlight, .highlight *,\n pre code, pre code * {\n filter: none !important;\n }\n \n /* Fix common UI elements */\n .modal, .popup, .dropdown-menu, .tooltip, .popover {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #2d2d44 !important;\n border-color: #444 !important;\n }\n \n /* Scrollbars */\n ::-webkit-scrollbar { background: #1a1a2e !important; }\n ::-webkit-scrollbar-thumb { background: #444 !important; }\n ::-webkit-scrollbar-thumb:hover { background: #555 !important; }\n \n /* Selection */\n ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ';\n }\n \n function removeDarkMode() {\n var style = document.getElementById('universal-dark-mode-style');\n if (style) style.remove();\n }\n \n // Toggle with Alt+Shift+D\n document.addEventListener('keydown', function(e) {\n if (e.altKey && e.shiftKey && e.key === 'D') {\n e.preventDefault();\n enabled = !enabled;\n if (enabled) {\n applyDarkMode();\n console.log('[Universal Dark Mode] Enabled');\n } else {\n removeDarkMode();\n console.log('[Universal Dark Mode] Disabled');\n }\n }\n });\n \n // Apply on load\n applyDarkMode();\n \n // Re-apply on dynamic content\n var observer = new MutationObserver(function(mutations) {\n if (enabled && !document.getElementById('universal-dark-mode-style')) {\n applyDarkMode();\n }\n });\n observer.observe(document.head, { childList: true });\n \n console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');\n})();", "Universal Dark Mode"); } } catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); } })(); })();
Skip to content

Repository files navigation


pyGSTi 0.9


Build Status

Overview:

This is the root directory of the pyGSTi software, which is a Python implementation of Gate Set Tomography. pyGSTi free software, licensed under the GNU General Public License (GPL). Copyright and license information can be found in license.txt, and the GPL itself in COPYING.

Getting Started:

pyGSTi is written entirely in Python, and so there's no compiling necessary. The first step is to install Python (and Jupyter notebook is highly recommended) if you haven't already. In order to use pyGSTi you need to tell your Python distribution where pyGSTi lives, which can be done in one of two ways:

  • User-Only Installation

    To install pyGSTi for the current user, run python install_locally.py

    This adds the current pyGSTi path to Python's list of search paths, and doesn't require administrative access. Typically you want to do this if you've cloned the pyGSTi GitHub repository and want any changes you make to your local file to have effect when you import pygsti from Python. You'd also want to use this option if you'd like long-term access the tutorial notebook files in the jupyter_notebooks directory under this one, since this means you'll be keeping this directory around anyway.

  • System-Wide Installation

    To install pyGSTi for all users, run: python setup.py install

    This installs the pyGSTi Python package into one of the Python distribution's search directories. This typically requires administrative privileges, and is the way most Python packages are installed. Installing this way has the advantage that it makes the package available to all users and then allows you to move or delete the directory you're installing from. If you don't use this method you must not delete this directory so long as you want to use pyGSTi.

    Reasons you may not want to use this installation method are

    • pyGSTi comes with (Jupyter notebook) tutorials that you may want to access for weeks and years to come (i.e. you plan to keep this pyGSTi directory around for a while).
    • you've cloned the pyGSTi repository and want this local set of files to be the one Python uses when you import pygsti.

Using pyGSTi

After you've installed pyGSTi, you should be able to import the pygsti Python package. The next thing to do is take a look at the tutorials, which you do by:

  • Changing to the notebook directory, by running: cd jupyter_notebooks/Tutorials/

  • Start up the Jupyter notebook server by running: jupyter notebook

The Jupyter server should open up your web browser to the server root, from where you can start the first "00" tutorial notebook. (Note that the key command to execute a cell within the Jupyter notebook is Shift+Enter, not just Enter.)

Congratulations! You're up and running with pyGSTi!

Documentation

Online documentation is hosted on Read the Docs. Instructions for building the documentation locally are contained in the file doc/build/howToBuild.txt.

Questions?

For help and support with pyGSTi, please contact the authors at pygsti@sandia.gov.

Brief description of the directory structure:

doc/ : Directory containing the HTML documentation and other
reference documents.
jupyter_notebooks/ : Parent directory of all Jupyter notebook tutorial
files included with pyGSTi. It is convenient to
start an Jupyter notebook server from within this
directory.
packages/ : Directory containing the (one) package provided by pyGSTi.
All of the Python source code lies here.
tests/ : Directory containing pyGSTi unit tests.
install_locally.py : A Python script that sets up the software to run from its current location within the file system. This
essentially adds the packages directory to the list of
directories Python uses to search for packages in, so
that ``import pygsti`` will work for any Python script,
regardless of its location in the file system. This
action is local to the user running the script, and does
not copy any files to any system directories, making it a
good option for a user without administrative access.
COPYING : A text version of the GNU General Public License.
license.txt : A text file giving copyright and licensing information
about pyGSTi.

About

A python implementation of Gate Set Tomography

Resources

Stars

0 stars

Watchers

1 watching

Forks

Releases

Packages

Contributors

Languages