diff --git a/.editorconfig b/.editorconfig deleted file mode 100644 index 6bc21bf..0000000 --- a/.editorconfig +++ /dev/null @@ -1,22 +0,0 @@ -# EditorConfig -# https://editorconfig.org - -root = true - -[*] -charset = utf-8 -end_of_line = lf -indent_size = 2 -indent_style = space -insert_final_newline = true -trim_trailing_whitespace = true - -[*.md] -trim_trailing_whitespace = false - -[*.py] -indent_size = 4 - -[Makefile] -indent_size = 1 -indent_style = tab diff --git a/.github/README.md b/.github/README.md index 8a37c3f..fff744e 100644 --- a/.github/README.md +++ b/.github/README.md @@ -1,39 +1,11 @@ -# Q-CTRL Template +# Q-CTRL Notebooks Public -A good description is clear, short, and to the point. Describe the purpose of the project and what it does. Your README should contain only the necessary information for **developers** to get started **contributing** to your project. - -## Installation - -Describe how to install the project locally then **DELETE THIS LINE**. For example: - -```shell -git clone git@github.com:qctrl/[REPOSITORY].git -cd [REPOSITORY] -install... -``` +Q-CTRL Notebooks Public contains [Jupyter](https://jupyter.org/) Notebooks with examples of how to use Q-CTRL products to solve quantum control problems. ## Usage -Describe how to use the project after installation then **DELETE THIS LINE**. For example: - -```shell -run... -``` +Open the notebooks using your favorite [Jupyter](https://jupyter.org/) Notebook viewer/editor. ## Contributing See [Contributing](https://code.q-ctrl.com/contributing). - -## Credits - -Replace `[REPOSITORY]` in the URL below with the name of the repository then **DELETE THIS LINE**. - -See [Contributors](https://github.com/qctrl/[REPOSITORY]/graphs/contributors). - -## License - -- If **Unlicensed:** - - Delete this entire [License](#license) section. -- **DELETE THIS LIST**. - -See [LICENSE](https://github.com/qctrl/[REPOSITORY]/blob/master/LICENSE). diff --git a/README.md b/README.md deleted file mode 100644 index 4ade73f..0000000 --- a/README.md +++ /dev/null @@ -1,7 +0,0 @@ -# Q-CTRL Template - -A good description is clear, short, and to the point. Describe the purpose of the project and what it does. Your README should contain only the necessary information for **customers** to get started **using** your project. - -## Version - -This project follows the [Semantic Versioning](https://semver.org/) standard. diff --git a/package.json b/package.json deleted file mode 100644 index 09b4dd8..0000000 --- a/package.json +++ /dev/null @@ -1,88 +0,0 @@ -# How to use this file -# - Copy this file to the root of your repository -# - Update the values as per the instructions in the comments (let's pretend JSON supports comments) -# - Remove all comments -# - Add any other fields required for your package -# -# More information -# - https://code.q-ctrl.com/packaging#javascript -# - https://docs.npmjs.com/configuring-npm/package-json - -{ - # name: The "Install" name as defined in https://code.q-ctrl.com/naming-conventions/#packages - "name": "@qctrl/template", - - # version: The "Version" as defined in https://code.q-ctrl.com/releases#version - "version": "1.2.3", - - # description: The "Package" name as defined in https://code.q-ctrl.com/naming-conventions/#packages - "description": "Q-CTRL Template", - - # keywords: Add to this list as appropriate. - "keywords": [ - "black opal", - "boulder opal", - "fire opal", - "nisq", - "open controls", - "q control", - "q ctrl", - "q-control", - "q-ctrl", - "qcontrol", - "qctrl", - "quantum", - "quantum algorithms", - "quantum circuits", - "quantum coding", - "quantum coding software", - "quantum computing", - "quantum control", - "quantum control software", - "quantum control theory", - "quantum engineering", - "quantum error correction", - "quantum firmware", - "quantum fundamentals", - "quantum sensing", - "qubit", - "qudit" - ], - - # homepage: DO NOT EDIT - "homepage": "https://q-ctrl.com", - - # bugs: DO NOT EDIT - "bugs": { - "url" : "https://q-ctrl.com/contact", - "email" : "support@q-ctrl.com" - }, - - # license: The license as defined in https://code.q-ctrl.com/licensing - # Commercial = "SEE LICENSE IN LICENSE" - # Open source = "Apache-2.0" - # Unlicensed = "UNLICENSED" - "license": "Apache-2.0", - - # author: DO NOT EDIT - "author": { - "name": "Q-CTRL", - "email": "support@q-ctrl.com", - "url": "https://q-ctrl.com" - }, - - # main: DO NOT EDIT - "main": "index.js", - - # repository: A link to the public GitHub repository. Omit if the repository is private - "repository": { - "type": "git", - "url": "git+https://github.com/qctrl/template.git" - } - - # engines: The minimum engine versions. Add to this list as appropriate. - "engines": { - "node": ">=18", - "pnpm": ">=8.6.12" - }, -} diff --git a/pyproject.toml b/pyproject.toml deleted file mode 100644 index a6b5ba3..0000000 --- a/pyproject.toml +++ /dev/null @@ -1,121 +0,0 @@ -# How to use this file -# - Copy this file to the root of your repository -# - Update the values as per the instructions in the comments -# - Remove all comments -# -# More information -# - https://code.q-ctrl.com/packaging#python -# - https://python-poetry.org/docs/pyproject/ - -[tool.poetry] - -# name: The "Install" name as defined in https://code.q-ctrl.com/naming-conventions/#packages -name = "qctrl-template" - -# version: The "Version" as defined in https://code.q-ctrl.com/releases#version -version = "1.2.3" - -# description: The "Package" name as defined in https://code.q-ctrl.com/naming-conventions/#packages -description = "Q-CTRL Template" - -# license: The license as defined in https://code.q-ctrl.com/licensing -# Commercial = "https://q-ctrl.com/terms" -# Open source = "Apache-2.0" -# Unlicensed = "" -license = "Apache-2.0" - -# authors: DO NOT EDIT -authors = ["Q-CTRL "] - -# maintainers: DO NOT EDIT -maintainers = ["Q-CTRL "] - -# readme: DO NOT EDIT - the README.md file as defined in https://github.com/qctrl/template/blob/master/README.md -readme = "README.md" - -# homepage: DO NOT EDIT -homepage = "https://q-ctrl.com" - -# repository: A link to the public GitHub repository. Remove it if the repository is private. -repository = "https://github.com/qctrl/template" - -# documentation: A link to the "User documentation" as defined in https://code.q-ctrl.com/documentation#user-documentation -# Remove it if not needed. -documentation = "" - -# keywords: DO NOT EDIT -keywords = [ - "black opal", - "boulder opal", - "fire opal", - "nisq", - "open controls", - "q control", - "q ctrl", - "q-control", - "q-ctrl", - "qcontrol", - "qctrl", - "quantum", - "quantum algorithms", - "quantum circuits", - "quantum coding", - "quantum coding software", - "quantum computing", - "quantum control", - "quantum control software", - "quantum control theory", - "quantum engineering", - "quantum error correction", - "quantum firmware", - "quantum fundamentals", - "quantum sensing", - "qubit", - "qudit" -] - -# classifiers: Do not edit, unless the package only supports a subset of Python versions. -# In that case, remove unsupported versions from the classifiers. -classifiers = [ - "Development Status :: 5 - Production/Stable", - "Environment :: Console", - "Intended Audience :: Developers", - "Intended Audience :: Education", - "Intended Audience :: Science/Research", - "Natural Language :: English", - "Operating System :: OS Independent", - "Programming Language :: Python :: 3.9", - "Programming Language :: Python :: 3.10", - "Programming Language :: Python :: 3.11", - "Programming Language :: Python :: 3.12", - "Topic :: Internet :: WWW/HTTP", - "Topic :: Scientific/Engineering :: Physics", - "Topic :: Scientific/Engineering :: Visualization", - "Topic :: Software Development :: Embedded Systems", - "Topic :: System :: Distributed Computing" -] - -# packages: The "Import" name as defined in https://code.q-ctrl.com/naming-conventions -packages = [ - { include = "qctrltemplate" }, -] - -# urls: DO NOT EDIT -[tool.poetry.urls] -LinkedIn = "https://www.linkedin.com/company/q-ctrl/" -Facebook = "https://www.facebook.com/qctrl" -X = "https://x.com/qctrlHQ" -YouTube = "https://www.youtube.com/qctrl" -GitHub = "https://github.com/qctrl" - -# Uncomment the following 2 blocks if the package requires access to the Internal PyPI. -# # Use the internal PyPI as the main source: DO NOT EDIT -# [[tool.poetry.source]] -# name = "Q-CTRL PyPI" -# url = "https://pypi.q-ctrl.com/simple" -# priority = "primary" - -# # Use the public PyPI as the supplemental source: DO NOT EDIT -# [[tool.poetry.source]] -# name = "PyPI" -# priority = "supplemental"