# 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:
```bash
pip install hs3
```
Alternatively, you can clone this repository and install the package locally:
```bash
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:
```bash
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:
```bash
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.
Raw data
{
"_id": null,
"home_page": "https://github.com/hep-statistics-serialization-standard/python-hep-statistics-serialization-standard/tree/master",
"name": "hs3",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": null,
"keywords": null,
"author": "Carsten Burgard",
"author_email": "cburgard@cern.ch",
"download_url": "https://files.pythonhosted.org/packages/53/c3/056f7479a96fcb11bd898c0d8087e37098c2a32c42bd647be635df110659/hs3-1.0.2.tar.gz",
"platform": null,
"description": "# HS$^3$ Utilities\n\nPython HS$^3$ Utilities (`hs3`) is a collection of command-line tools and\nutilities designed to support the High-Energy Physics Statistics\nSerialization Standard (HS$^3$). This package provides tools for working\nwith HS$^3$ JSON files, including functionality for generating GraphML\nrepresentations and diffing HS$^3$ files.\n\n## Features\n\n- **`hs3diff`**: A tool to compare two HS$^3$ JSON files and generate a diff.\n- **`hs3tographml`**: A tool to convert HS$^3$ JSON files into GraphML format for visualization.\n\n## Installation\n\nYou can install HS$^3$ Utilities from PyPI using pip:\n\n```bash\npip install hs3\n```\n\nAlternatively, you can clone this repository and install the package locally:\n\n```bash\ngit clone https://github.com/hep-statistics-serialization-standard/python-hep-statistics-serialization-standard\ncd python-hep-statistics-serialization-standard\npip install .\n```\n\n## Usage\n\n### hs3diff\n\n`hs3diff` is used to compare two HS$^3$ JSON files and output the differences.\n\n### Usage Example:\n\n```bash\nhs3diff file1.json file2.json\n```\n\nThis command will output the differences between `file1.json` and `file2.json`.\n\n### hs3tographml\n\n`hs3tographml` converts an HS$^3$ JSON file into a GraphML file, which can be visualized using tools like Gephi.\n\n### Usage Example:\n\n```bash\nhs3tographml -i model.json -o model.graphml\n```\n\nThis command will convert `model.json` into `model.graphml`.\n\n### Options\n- `-i`, `--input`: Input JSON file (required).\n- `-o`, `--output`: Output GraphML file (required).\n- `-l`, `--likelihood`: Name of the likelihood to use (optional).\n\n## Contributing\n\nContributions are welcome! If you\u2019d like to contribute to HS$^3$\nUtilities, please follow these steps:\n\n- Fork the repository.\n- Create a new branch (`git checkout -b feature-branch`).\n- Make your changes and commit them (git commit -am 'Add new feature').\n- Push to the branch (git push origin feature-branch).\n- Open a Pull Request.\n\nPlease ensure your code follows the project's coding standards and is\nwell-tested.\n\n## License\n\nThis project is licensed under the BSD 3-Clause License. See the\nLICENSE file for details.\n\n## Authors\n\n- Carsten Burgard - cburgard@cern.ch\n\n## Acknowledgments\n\nSpecial thanks to the contributors and the HEP statistics standard\ncommunity for their ongoing support and feedback.\n",
"bugtrack_url": null,
"license": "BSD-3-Clause",
"summary": "Utilities for the HS3 standard in high-energy physics",
"version": "1.0.2",
"project_urls": {
"Homepage": "https://github.com/hep-statistics-serialization-standard/python-hep-statistics-serialization-standard/tree/master"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "20bc10b54a7c09cdbebe69fbd2945cc3f64b5d9f5ec446e55f3a966120bd99ba",
"md5": "778cb9cc10e854ba41f5a31252b068d1",
"sha256": "7b9ca3c56cdd40de49b5d99c6f28e25b077b75590f8a84cd863f173bc339fb1d"
},
"downloads": -1,
"filename": "hs3-1.0.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "778cb9cc10e854ba41f5a31252b068d1",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.6",
"size": 9015,
"upload_time": "2024-08-26T09:51:56",
"upload_time_iso_8601": "2024-08-26T09:51:56.410933Z",
"url": "https://files.pythonhosted.org/packages/20/bc/10b54a7c09cdbebe69fbd2945cc3f64b5d9f5ec446e55f3a966120bd99ba/hs3-1.0.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "53c3056f7479a96fcb11bd898c0d8087e37098c2a32c42bd647be635df110659",
"md5": "e6d6f21901e5bfeaf4529a4fd5d8bf43",
"sha256": "d4d0157e904eb7a8ba3d53706e3ce18e7b5f34f85cc791f4f6bf6c6bf73fe0cc"
},
"downloads": -1,
"filename": "hs3-1.0.2.tar.gz",
"has_sig": false,
"md5_digest": "e6d6f21901e5bfeaf4529a4fd5d8bf43",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 11527,
"upload_time": "2024-08-26T09:51:58",
"upload_time_iso_8601": "2024-08-26T09:51:58.095027Z",
"url": "https://files.pythonhosted.org/packages/53/c3/056f7479a96fcb11bd898c0d8087e37098c2a32c42bd647be635df110659/hs3-1.0.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-08-26 09:51:58",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "hep-statistics-serialization-standard",
"github_project": "python-hep-statistics-serialization-standard",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "hs3"
}
JSON
