Chore/docs #88
Closed
Chore/docs #88
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
- Move .pre-commit-config.yaml, .pylintrc, and CONTRIBUTING.md to superconducting/ - Update pyproject.toml to reference .pylintrc in same directory - Update CONTRIBUTING.md with correct repository paths This consolidates all configuration files at the same level as pyproject.toml for better organization and easier maintenance.
Pylint automatically discovers .pylintrc in the same directory, so the [tool.pylint.main] section is unnecessary.
Add standard Python project exclusions including: - Virtual environments (.venv/, venv/) - Python cache files (*.pyc, __pycache__/) - Test artifacts (.coverage, htmlcov/) - IDE files (.vscode/, .idea/, .DS_Store) - Build artifacts (dist/, build/, *.egg-info/) - Tool caches (.mypy_cache/, .ruff_cache/, .pre-commit-cache/) Note: uv.lock is intentionally tracked for reproducible builds.
Add comprehensive CI workflow that: - Runs on push to master, styx-ci-cd, and KAVR_12182025 branches - Triggers on pull requests to master, styx-ci-cd, and KAVR_12182025 - Tests on Python 3.10, 3.11, and 3.12 - Uses uv for fast dependency installation - Runs pre-commit hooks on changed files only (not all files) - Runs pytest with coverage reporting - Uploads coverage to Codecov for Python 3.12 The workflow uses --from-ref and --to-ref to run pre-commit only on changed files in the current commit/PR, not the entire codebase.
Create initial test suite with: - test_imports.py: Verify all main packages can be imported - test_sanity.py: Basic sanity tests to verify test infrastructure - __init__.py: Mark tests as a proper Python package Also update .pre-commit-config.yaml to: - Remove explicit --rcfile argument (pylint finds .pylintrc automatically) - Exclude tests/ directory from pylint checks This provides a foundation for the test suite and allows CI to run successfully. The tests verify that: - Core packages (calibrations, quam_config, calibration_utils) can be imported - Key dependencies are available - Python version is 3.10+ - Basic pytest functionality works
Integrate CI/CD improvements including pre-commit hooks, linting configuration, and contributing guidelines. Resolved conflict by keeping pyproject.toml from styx-ci-cd to maintain project configuration and dependencies. Changes: - Add .pre-commit-config.yaml for automated code quality checks - Add .pylintrc for Python linting configuration - Add CONTRIBUTING.md with development guidelines - Keep pyproject.toml with updated dependencies and tooling - Add uv.lock for dependency locking - Update .gitignore for Python project exclusions
Add __init__.py files to calibration_utils and calibrations directories to make them valid Python packages. This fixes the dependency installation failure in GitHub Actions CI workflow.
- Add README.md for the superconducting package - Update pyproject.toml to reference correct README path - Update uv.lock after dependency resolution This fixes the build failure where hatchling couldn't find ../README.md
- Fix clone URL to point to correct repository (CS_installations) - Add git checkout step to switch to KAVR_12182025 branch - Add [project.optional-dependencies] for pip compatibility - Keep [dependency-groups] for uv compatibility - Update uv.lock after pyproject.toml changes Both installation methods now work correctly: - uv sync --group dev --prerelease=allow - pip install -e ".[dev]"
first version for QUA docker
…l deps) (#12) * chore: add time-of-flight calibration * chore: fix pre-commit pylint config for CI * chore: fix pre-commit pylint config for CI(2nd) * chore: align code with pylint rules * fix: use local pylint * fix(lint): clarify pylint disables and preserve I/Q naming - Preserve I/Q naming convention - Suppress optional runtime-only imports - No global pylint relaxation; file/line-level only --------- Co-authored-by: sebastianorbell-qm <Sebastian.Orbell@quantum-machines.co>
… by focussing on diffs [skip ci]
chore: removing pylint comments in ToF(MW)
chore: add Resonator Spectroscopy (from rebase)
chore: add/modify workflow
…jazz chore: add precommit (chore/styx-precommit-zz-off-jazz)
chore: add xy-c-delay
…pec-vs-coupler chore: add qubit spec vs coupler flux
…oupler chore: add resonator spec vs coupler flux
chore: add minor typos
chore: re-numbering the files according to the workflow graph
Testing infrastructure and CI tiers
Add unit tests for coupler zero point
Updated node parameters and experiment descriptions for clarity and specificity across multiple experiments.
…-wide Feature: modify resonator spec wide
…ler-flux-set-dc fix(resonator): change pulse to set dc
…-distortion chore: add a new node of coupler flux long distortion
…short-dist chore: add a new node for coupler flux short distortion
…-nodes chore: delete not needed nodes
Fix to docker for Qua
KevinAVR
requested review from
Kyung-hoon-Jung0,
cjwu-qm,
paulQM and
sebastianorbell-qm
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Hi guys, I worked with customer to create the docs folder for understanding this folder to onboard a person into contributing as soon as possible. It also did a few modifications, please provide your feedback and if you think it is useful.
I think it will be to guide a person to onboard into the node contribution