| Name | xaitk-jatic JSON |
| Version |
0.4.3
JSON |
| download |
| home_page | None |
| Summary | Integration package to support interfacing, implementation and example needs for the JATIC. |
| upload_time | 2024-12-16 19:20:38 |
| maintainer | None |
| docs_url | None |
| author | Kitware, Inc. |
| requires_python | <4.0,>=3.9 |
| license | Apache-2.0 |
| keywords |
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
<!-- :auto badges: -->
[](https://pypi.org/project/xaitk-jatic/)
[](https://xaitk-jatic.readthedocs.io/en/latest/?badge=latest)
<!-- :auto badges: -->
# XAITK JATIC Integrations
"Bucket" to house various examples and resources related to
[`xaitk-saliency`](https://github.com/xaitk/xaitk-saliency)
integration and scaling for JATIC use as part of the JATIC program.
<!-- :auto installation: -->
## Installation
Ensure the source tree is acquired locally before proceeding.
To install the current version via `pip`:
```bash
pip install xaitk-jatic
```
Alternatively, you can use [Poetry](https://python-poetry.org/):
```bash
poetry install
```
Certain plugins may require additional runtime dependencies. Details on these requirements can be found [here](https://xaitk-jatic.readthedocs.io/en/latest/implementations.html).
For more detailed installation instructions, visit the [installation documentation](https://xaitk-jatic.readthedocs.io/en/latest/installation.html).
<!-- :auto installation: -->
<!-- :auto getting-started: -->
## Getting Started
Explore usage examples of the `xaitk-jatic` package in various contexts using the Jupyter notebooks provided in the `./examples/` directory.
Contributions are encouraged! For more details, refer to the [CONTRIBUTING.md](./CONTRIBUTING.md) file.
<!-- :auto getting-started: -->
<!-- :auto documentation: -->
## Documentation
Documentation for both release snapshots and the latest master branch is available on [ReadTheDocs](https://xaitk-jatic.readthedocs.io/en/latest/).
To build the Sphinx-based documentation locally for the latest reference:
```bash
# Install dependencies
poetry install --sync --with linting,tests,docs
# Navigate to the documentation root
cd docs
# Build the documentation
poetry run make html
# Open the generated documentation in your browser
firefox _build/html/index.html
```
<!-- :auto documentation: -->
<!-- :auto developer-tools: -->
## Developer Tools
### Pre-commit Hooks
Pre-commit hooks ensure that code complies with required linting and formatting guidelines. These hooks run automatically before commits but can also be executed manually. To bypass checks during a commit, use the `--no-verify` flag.
To install and use pre-commit hooks:
```bash
# Install required dependencies
poetry install --sync --with linting,tests,docs
# Initialize pre-commit hooks for the repository
poetry run pre-commit install
# Run pre-commit checks on all files
poetry run pre-commit run --all-files
```
<!-- :auto developer-tools: -->
<!-- :auto contributing: -->
## Contributing
- Follow the [JATIC Design Principles](https://cdao.pages.jatic.net/public/program/design-principles/).
- Adopt the Git Flow branching strategy.
- Detailed release information is available in [docs/release_process.rst](./docs/release_process.rst).
- Additional contribution guidelines can be found in [CONTRIBUTING.md](./CONTRIBUTING.md).
<!-- :auto contributing: -->
<!-- :auto license: -->
## License
[Apache 2.0](./LICENSE)
<!-- :auto license: -->
<!-- :auto contacts: -->
## Contacts
**Principal Investigator**: Brian Hu (Kitware) @brian.hu
**Product Owner**: Austin Whitesell (MITRE) @awhitesell
**Scrum Master / Tech Lead**: Brandon RichardWebster (Kitware) @b.richardwebster
**Deputy Tech Lead**: Emily Veenhuis (Kitware) @emily.veenhuis
<!-- :auto contacts: -->
Raw data
{
"_id": null,
"home_page": null,
"name": "xaitk-jatic",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.9",
"maintainer_email": null,
"keywords": null,
"author": "Kitware, Inc.",
"author_email": "xaitk@kitware.com",
"download_url": "https://files.pythonhosted.org/packages/32/1f/ed37bc858844d3cf010fae77916ee9d8dd0b7160fad878918fb9071b98c9/xaitk_jatic-0.4.3.tar.gz",
"platform": null,
"description": "<!-- :auto badges: -->\n[](https://pypi.org/project/xaitk-jatic/)\n\n[](https://xaitk-jatic.readthedocs.io/en/latest/?badge=latest)\n<!-- :auto badges: -->\n\n# XAITK JATIC Integrations\n\n\"Bucket\" to house various examples and resources related to\n[`xaitk-saliency`](https://github.com/xaitk/xaitk-saliency)\nintegration and scaling for JATIC use as part of the JATIC program.\n\n<!-- :auto installation: -->\n## Installation\nEnsure the source tree is acquired locally before proceeding.\n\nTo install the current version via `pip`:\n```bash\npip install xaitk-jatic\n```\n\nAlternatively, you can use [Poetry](https://python-poetry.org/):\n```bash\npoetry install\n```\n\nCertain plugins may require additional runtime dependencies. Details on these requirements can be found [here](https://xaitk-jatic.readthedocs.io/en/latest/implementations.html).\n\nFor more detailed installation instructions, visit the [installation documentation](https://xaitk-jatic.readthedocs.io/en/latest/installation.html).\n<!-- :auto installation: -->\n\n<!-- :auto getting-started: -->\n## Getting Started\nExplore usage examples of the `xaitk-jatic` package in various contexts using the Jupyter notebooks provided in the `./examples/` directory.\n\nContributions are encouraged! For more details, refer to the [CONTRIBUTING.md](./CONTRIBUTING.md) file.\n<!-- :auto getting-started: -->\n\n<!-- :auto documentation: -->\n## Documentation\nDocumentation for both release snapshots and the latest master branch is available on [ReadTheDocs](https://xaitk-jatic.readthedocs.io/en/latest/).\n\nTo build the Sphinx-based documentation locally for the latest reference:\n```bash\n# Install dependencies\npoetry install --sync --with linting,tests,docs\n# Navigate to the documentation root\ncd docs\n# Build the documentation\npoetry run make html\n# Open the generated documentation in your browser\nfirefox _build/html/index.html\n```\n<!-- :auto documentation: -->\n\n<!-- :auto developer-tools: -->\n## Developer Tools\n\n### Pre-commit Hooks\nPre-commit hooks ensure that code complies with required linting and formatting guidelines. These hooks run automatically before commits but can also be executed manually. To bypass checks during a commit, use the `--no-verify` flag.\n\nTo install and use pre-commit hooks:\n```bash\n# Install required dependencies\npoetry install --sync --with linting,tests,docs\n# Initialize pre-commit hooks for the repository\npoetry run pre-commit install\n# Run pre-commit checks on all files\npoetry run pre-commit run --all-files\n```\n<!-- :auto developer-tools: -->\n\n<!-- :auto contributing: -->\n## Contributing\n- Follow the [JATIC Design Principles](https://cdao.pages.jatic.net/public/program/design-principles/).\n- Adopt the Git Flow branching strategy.\n- Detailed release information is available in [docs/release_process.rst](./docs/release_process.rst).\n- Additional contribution guidelines can be found in [CONTRIBUTING.md](./CONTRIBUTING.md).\n<!-- :auto contributing: -->\n\n<!-- :auto license: -->\n## License\n[Apache 2.0](./LICENSE)\n<!-- :auto license: -->\n\n<!-- :auto contacts: -->\n## Contacts\n\n**Principal Investigator**: Brian Hu (Kitware) @brian.hu\n**Product Owner**: Austin Whitesell (MITRE) @awhitesell\n**Scrum Master / Tech Lead**: Brandon RichardWebster (Kitware) @b.richardwebster\n**Deputy Tech Lead**: Emily Veenhuis (Kitware) @emily.veenhuis\n<!-- :auto contacts: -->",
"bugtrack_url": null,
"license": "Apache-2.0",
"summary": "Integration package to support interfacing, implementation and example needs for the JATIC.",
"version": "0.4.3",
"project_urls": {
"Documentation": "https://xaitk-jatic.readthedocs.io/"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "0f0f9024f30de8e75ed7410904ae2e081baff22866a8729073335b6a7ad212c0",
"md5": "17da98204381bf8b03c39e504b4569c3",
"sha256": "f4408ab3b4a02de8d953a0fa68c64dd9378369ced2ce43a1b72e0d58d00df60c"
},
"downloads": -1,
"filename": "xaitk_jatic-0.4.3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "17da98204381bf8b03c39e504b4569c3",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.9",
"size": 16129,
"upload_time": "2024-12-16T19:20:37",
"upload_time_iso_8601": "2024-12-16T19:20:37.618964Z",
"url": "https://files.pythonhosted.org/packages/0f/0f/9024f30de8e75ed7410904ae2e081baff22866a8729073335b6a7ad212c0/xaitk_jatic-0.4.3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "321fed37bc858844d3cf010fae77916ee9d8dd0b7160fad878918fb9071b98c9",
"md5": "304dcd6793379cca8243b2ed974fc6b0",
"sha256": "9c3f1668927f52eca752a04702f7d55b1c7c7b48a5f11dbcad0f616c4c635d4b"
},
"downloads": -1,
"filename": "xaitk_jatic-0.4.3.tar.gz",
"has_sig": false,
"md5_digest": "304dcd6793379cca8243b2ed974fc6b0",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.9",
"size": 15635,
"upload_time": "2024-12-16T19:20:38",
"upload_time_iso_8601": "2024-12-16T19:20:38.901294Z",
"url": "https://files.pythonhosted.org/packages/32/1f/ed37bc858844d3cf010fae77916ee9d8dd0b7160fad878918fb9071b98c9/xaitk_jatic-0.4.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-12-16 19:20:38",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "xaitk-jatic"
}
