HS$^3$ Utilities
Python HS$^3$ Utilities (hs3) is a collection of command-line tools and
utilities designed to support the High-Energy Physics Statistics
Serialization Standard (HS$^3$). This package provides tools for working
with HS$^3$ JSON files, including functionality for generating GraphML
representations and diffing HS$^3$ files.
Features
hs3diff: A tool to compare two HS$^3$ JSON files and generate a diff.hs3tographml: A tool to convert HS$^3$ JSON files into GraphML format for visualization.
Installation
You can install HS$^3$ Utilities from PyPI using pip:
pip install hs3
Alternatively, you can clone this repository and install the package locally:
git clone https://github.com/hep-statistics-serialization-standard/python-hep-statistics-serialization-standard
cd python-hep-statistics-serialization-standard
pip install .
Usage
hs3diff
hs3diff is used to compare two HS$^3$ JSON files and output the differences.
Usage Example:
hs3diff file1.json file2.json
This command will output the differences between file1.json and file2.json.
hs3tographml
hs3tographml converts an HS$^3$ JSON file into a GraphML file, which can be visualized using tools like Gephi.
Usage Example:
hs3tographml -i model.json -o model.graphml
This command will convert model.json into model.graphml.
Options
-i,--input: Input JSON file (required).-o,--output: Output GraphML file (required).-l,--likelihood: Name of the likelihood to use (optional).
Contributing
Contributions are welcome! If you’d like to contribute to HS$^3$ Utilities, please follow these steps:
- Fork the repository.
- Create a new branch (
git checkout -b feature-branch). - Make your changes and commit them (git commit -am 'Add new feature').
- Push to the branch (git push origin feature-branch).
- Open a Pull Request.
Please ensure your code follows the project's coding standards and is well-tested.
License
This project is licensed under the BSD 3-Clause License. See the LICENSE file for details.
Authors
- Carsten Burgard - cburgard@cern.ch
Acknowledgments
Special thanks to the contributors and the HEP statistics standard community for their ongoing support and feedback.
Metadata
Release files for hs3 1.0.2
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| hs3-1.0.2.tar.gz | 11.5 kB | Without provenance | Details for hs3-1.0.2.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| hs3-1.0.2-py3-none-any.whl | Python 3 | none | any | Details for hs3-1.0.2-py3-none-any.whl |
Total release size: 20.5 kB
Release files / hs3-1.0.2.tar.gz
| Download URL | hs3-1.0.2.tar.gz |
|---|---|
| Size | 11.5 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
d4d0157e904eb7a8ba3d53706e3ce18e7b5f34f85cc791f4f6bf6c6bf73fe0cc
|
|
BLAKE2b-256 checksum How to use checksums |
53c3056f7479a96fcb11bd898c0d8087e37098c2a32c42bd647be635df110659
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/5.0.1.dev0+g94f810c.d20240510 CPython/3.12.5
|
Release files / hs3-1.0.2-py3-none-any.whl
| Download URL | hs3-1.0.2-py3-none-any.whl |
|---|---|
| Size | 9.0 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
7b9ca3c56cdd40de49b5d99c6f28e25b077b75590f8a84cd863f173bc339fb1d
|
|
BLAKE2b-256 checksum How to use checksums |
20bc10b54a7c09cdbebe69fbd2945cc3f64b5d9f5ec446e55f3a966120bd99ba
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/5.0.1.dev0+g94f810c.d20240510 CPython/3.12.5
|
Security for hs3 1.0.2
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.