https://github.com/cqcl/phir
PHIR (PECOS High-level Intermediate Representation) Spec and data model
Science Score: 26.0%
This score indicates how likely this project is to be science-related based on various indicators:
-
○CITATION.cff file
-
✓codemeta.json file
Found codemeta.json file -
✓.zenodo.json file
Found .zenodo.json file -
○DOI references
-
○Academic publication links
-
○Committers with academic emails
-
○Institutional organization owner
-
○JOSS paper metadata
-
○Scientific vocabulary similarity
Low similarity (10.2%) to scientific vocabulary
Keywords
Keywords from Contributors
Repository
PHIR (PECOS High-level Intermediate Representation) Spec and data model
Basic Info
- Host: GitHub
- Owner: CQCL
- License: bsd-3-clause
- Language: Python
- Default Branch: main
- Homepage: https://cqcl.github.io/phir/
- Size: 2.09 MB
Statistics
- Stars: 4
- Watchers: 11
- Forks: 1
- Open Issues: 2
- Releases: 13
Topics
Metadata Files
README.md
PHIR: PECOS High-level Intermediate Representation
phir models the PHIR specification as a Pydantic model.
See our docs.
Included is the tool phir-cli that provides validation and pretty printing on the command line.
Prerequisites
Python >=3.10
Installation
Just issue pip install phir to obtain the latest stable release.
phir CLI
The package includes a CLI for directly validating PHIR JSON files using the command line.
```sh ❯ phir-cli -h usage: phir-cli [-h] [-s] [-v] [jsonfile]
Validates and pretty prints valid PHIR
positional arguments: jsonfile json file to validate against PHIR spec
options: -h, --help show this help message and exit -s, --schema dump JSON schema of the PHIR model and exit -v, --version show program's version number and exit ```
Development
Clone the repository and run:
sh
uv sync
uv run pre-commit install
See Makefile for other useful commands.
Testing
Issue make tests from the root directory.
Owner
- Name: Cambridge Quantum
- Login: CQCL
- Kind: organization
- Location: Cambridge, UK
- Website: http://www.cambridgequantum.com
- Repositories: 48
- Profile: https://github.com/CQCL
Quantum Software and Technologies
GitHub Events
Total
- Issues event: 3
- Watch event: 2
- Delete event: 76
- Issue comment event: 4
- Push event: 109
- Pull request review event: 46
- Pull request event: 97
- Fork event: 1
- Create event: 74
Last Year
- Issues event: 3
- Watch event: 2
- Delete event: 76
- Issue comment event: 4
- Push event: 109
- Pull request review event: 46
- Pull request event: 97
- Fork event: 1
- Create event: 74
Committers
Last synced: 7 months ago
Top Committers
| Name | Commits | |
|---|---|---|
| Kartik Singhal | k****l@q****m | 105 |
| dependabot[bot] | 4****] | 74 |
| pre-commit-ci[bot] | 6****] | 64 |
| github-actions[bot] | 4****] | 10 |
| Asa-Kosto-QTM | 1****M | 1 |
| Alec Edgington | a****n@q****m | 1 |
| Ciaran Ryan-Anderson | c****n@q****m | 1 |
Committer Domains (Top 20 + Academic)
Issues and Pull Requests
Last synced: 6 months ago
All Time
- Total issues: 7
- Total pull requests: 181
- Average time to close issues: 4 months
- Average time to close pull requests: 1 day
- Total issue authors: 2
- Total pull request authors: 4
- Average comments per issue: 0.0
- Average comments per pull request: 0.07
- Merged pull requests: 168
- Bot issues: 0
- Bot pull requests: 171
Past Year
- Issues: 2
- Pull requests: 102
- Average time to close issues: about 2 months
- Average time to close pull requests: 1 day
- Issue authors: 1
- Pull request authors: 3
- Average comments per issue: 0.0
- Average comments per pull request: 0.06
- Merged pull requests: 92
- Bot issues: 0
- Bot pull requests: 98
Top Authors
Issue Authors
- qartik (4)
- qciaran (3)
- dependabot[bot] (1)
- pre-commit-ci[bot] (1)
Pull Request Authors
- dependabot[bot] (129)
- pre-commit-ci[bot] (119)
- qartik (14)
- github-actions[bot] (10)
Top Labels
Issue Labels
Pull Request Labels
Packages
- Total packages: 1
-
Total downloads:
- pypi 9,640 last-month
- Total dependent packages: 2
- Total dependent repositories: 0
- Total versions: 10
- Total maintainers: 1
pypi.org: phir
A data model and validation tool for PHIR (PECOS High-level Intermediate Representation).
- Documentation: https://cqcl.github.io/phir/
- License: BSD 3-Clause License Copyright (c) 2023-2024, Quantinuum LLC Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: 1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. 2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. 3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
-
Latest release: 0.3.3
published almost 2 years ago