PECOS-packages / PECOS

A Python framework, library, and set of tools for exploring, developing, and evaluating quantum error-correction protocols.
Other
29 stars 6 forks source link

Feature more simulators #21

Closed PabloAndresCQ closed 9 months ago

PabloAndresCQ commented 1 year ago

Draft PR to gather initial feedback about current approach to add simulators.

Currently adding:

PabloAndresCQ commented 1 year ago

Pre-commit failing because CI ruff output seems to disagree with my local ruff output. Might be a versioning issue?

Either way, hopefully this is fine for now just to gather initial feedback.

qartik commented 1 year ago

Pre-commit failing because CI ruff output seems to disagree with my local ruff output. Might be a versioning issue?

Yeah, most likely. Could you also include an update to ruff version in your PR to v0.1.5 at https://github.com/PECOS-packages/PECOS/blob/6b994aa5daf4bb6267bad401c01a8d6a4c1af08f/.pre-commit-config.yaml#L22

You can locally test whether the CI will pass by issuing pre-commit run --all-files or make lint.

PabloAndresCQ commented 1 year ago

You can locally test whether the CI will pass by issuing pre-commit run --all-files or make lint.

I'm doing:

python -m pip install pre-commit
pre-commit run --all-files

and everything passes in my machine, but not in CI :/ Ruff version seems to be 0.1.5.

If I try make lint I get make: .venv/bin/python: Command not found which seems to be just some absolute path I'd need to change.

qartik commented 1 year ago

.venv/bin/python: Command not found which seems to be just some absolute path I'd need to change.

It sounds like you were not inside a virtual environment. Consider doing the following listed under installation instructions for development:

python -m venv .venv
source .venv/bin/activate
pip install -U pip setuptools
pip install -r requirements.txt
pre-commit install
pip install -e .

I just pushed the fix so it should be good now.

qciaran commented 9 months ago

Everything seems to be working well. Awesome. I would say just merge in the development branch to check if there is any conflict, add the following copyright header to your files, and switch this from a draft to a full PR and it is probably good to go.

# Copyright 2023 The PECOS Developers
#
# Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with
# the License.You may obtain a copy of the License at
#
#     https://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an
# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the
# specific language governing permissions and limitations under the License.