| Name | xaitk-jatic JSON |
| Version |
0.4.2
JSON |
| download |
| home_page | None |
| Summary | Integration package to support interfacing, implementation and example needs for the JATIC. |
| upload_time | 2024-11-18 23:56:52 |
| 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.
|
# 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
The following steps assume the source tree has been acquired locally.
Install the current version via pip:
```bash
pip install xaitk-jatic
```
Alternatively, you can also use [Poetry](https://python-poetry.org/):
```bash
poetry install --sync --with dev-linting,dev-testing,dev-docs
```
See [here for more installation documentation](
https://xaitk-jatic.readthedocs.io/en/latest/installation.html).
<!-- :auto installation: -->
<!-- :auto getting-started: -->
## Getting Started
We provide a number of examples based on Jupyter notebooks in the
`./examples/` directory to show usage of the `xaitk-jatic` package in a number
of different contexts.
Contributions are welcome!
See the [CONTRIBUTING.md](./CONTRIBUTING.md) file for details.
<!-- :auto getting-started: -->
<!-- :auto documentation: -->
## Documentation
Documentation snapshots for releases as well as the latest master are hosted
on [ReadTheDocs](https://xaitk-jatic.readthedocs.io/en/latest/).
The sphinx-based documentation may also be built locally for the most
up-to-date reference:
```bash
# Install dependencies
poetry install --sync --with dev-linting,dev-testing,dev-docs
# Navigate to the documentation root.
cd docs
# Build the docs.
poetry run make html
# Open in your favorite browser!
firefox _build/html/index.html
```
<!-- :auto documentation: -->
<!-- :auto developer-tools: -->
## Developer tools
**pre-commit hooks**
pre-commit hooks are used to ensure that any code meets all linting and
formatting guidelines required. After installing, this will always run before
committing to ensure that any commits are following the standards, but you
can also manually run the check without committing. If you want to commit
despite there being errors, you can add `--no-verify` to your commit command.
Installing pre-commit hooks:
```bash
# Ensure that all dependencies are installed
poetry install --sync --with dev-linting,dev-testing,dev-docs
# Initialize pre-commit for the repository
poetry run pre-commit install
# Run pre-commit check on all files
poetry run pre-commit run --all-files
```
<!-- :auto developer-tools: -->
<!-- :auto contributing: -->
## Contributing
- We follow the general guidelines outlined in the
[JATIC Design Principles](https://cdao.pages.jatic.net/public/program/design-principles/).
- We use the Git Flow branching strategy.
- See [docs/release_process.rst](./docs/release_process.rst) for detailed release information.
- See [CONTRIBUTING.md](./CONTRIBUTING.md) for additional contributing information.
<!-- :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/15/03/9ddeaa4c7a5f98f1349bfff6dc7037a854dc2aedd625566fd25f5eda4a25/xaitk_jatic-0.4.2.tar.gz",
"platform": null,
"description": "# 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\nThe following steps assume the source tree has been acquired locally.\n\nInstall the current version via pip:\n```bash\npip install xaitk-jatic\n```\n\nAlternatively, you can also use [Poetry](https://python-poetry.org/):\n```bash\npoetry install --sync --with dev-linting,dev-testing,dev-docs\n```\n\nSee [here for more installation documentation](\nhttps://xaitk-jatic.readthedocs.io/en/latest/installation.html).\n<!-- :auto installation: -->\n\n<!-- :auto getting-started: -->\n## Getting Started\nWe provide a number of examples based on Jupyter notebooks in the\n`./examples/` directory to show usage of the `xaitk-jatic` package in a number\nof different contexts.\n\nContributions are welcome!\nSee the [CONTRIBUTING.md](./CONTRIBUTING.md) file for details.\n<!-- :auto getting-started: -->\n\n<!-- :auto documentation: -->\n## Documentation\nDocumentation snapshots for releases as well as the latest master are hosted\non [ReadTheDocs](https://xaitk-jatic.readthedocs.io/en/latest/).\n\nThe sphinx-based documentation may also be built locally for the most\nup-to-date reference:\n```bash\n# Install dependencies\npoetry install --sync --with dev-linting,dev-testing,dev-docs\n# Navigate to the documentation root.\ncd docs\n# Build the docs.\npoetry run make html\n# Open in your favorite 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 are used to ensure that any code meets all linting and\nformatting guidelines required. After installing, this will always run before\n committing to ensure that any commits are following the standards, but you\n can also manually run the check without committing. If you want to commit\n despite there being errors, you can add `--no-verify` to your commit command.\n\nInstalling pre-commit hooks:\n```bash\n# Ensure that all dependencies are installed\npoetry install --sync --with dev-linting,dev-testing,dev-docs\n# Initialize pre-commit for the repository\npoetry run pre-commit install\n# Run pre-commit check on all files\npoetry run pre-commit run --all-files\n```\n<!-- :auto developer-tools: -->\n\n<!-- :auto contributing: -->\n## Contributing\n- We follow the general guidelines outlined in the\n[JATIC Design Principles](https://cdao.pages.jatic.net/public/program/design-principles/).\n- We use the Git Flow branching strategy.\n- See [docs/release_process.rst](./docs/release_process.rst) for detailed release information.\n- See [CONTRIBUTING.md](./CONTRIBUTING.md) for additional contributing information.\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\n**Product Owner**: Austin Whitesell (MITRE) @awhitesell\n\n**Scrum Master / Tech Lead**: Brandon RichardWebster (Kitware) @b.richardwebster\n\n**Deputy Tech Lead**: Emily Veenhuis (Kitware) @emily.veenhuis\n\n<!-- :auto contacts: -->\n",
"bugtrack_url": null,
"license": "Apache-2.0",
"summary": "Integration package to support interfacing, implementation and example needs for the JATIC.",
"version": "0.4.2",
"project_urls": {
"Documentation": "https://xaitk-jatic.readthedocs.io/"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "98b3559ba2b0d5463701e3d910204d64d78369ff5d24bcad983d3bec4d0aca74",
"md5": "3fa65580187b0d0613cddcc3fa30a585",
"sha256": "9c0799d8670bae7ceb71d832c85fc6131a6bdb985223edb34938a304402dff85"
},
"downloads": -1,
"filename": "xaitk_jatic-0.4.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "3fa65580187b0d0613cddcc3fa30a585",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.9",
"size": 16092,
"upload_time": "2024-11-18T23:56:51",
"upload_time_iso_8601": "2024-11-18T23:56:51.419160Z",
"url": "https://files.pythonhosted.org/packages/98/b3/559ba2b0d5463701e3d910204d64d78369ff5d24bcad983d3bec4d0aca74/xaitk_jatic-0.4.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "15039ddeaa4c7a5f98f1349bfff6dc7037a854dc2aedd625566fd25f5eda4a25",
"md5": "b7006d7937d5c300e1027114e4c79630",
"sha256": "d1ba32c0d8fbfcee3fa6e149b7a7341ae570b1a79a927d21aa040d519f9c7886"
},
"downloads": -1,
"filename": "xaitk_jatic-0.4.2.tar.gz",
"has_sig": false,
"md5_digest": "b7006d7937d5c300e1027114e4c79630",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.9",
"size": 15232,
"upload_time": "2024-11-18T23:56:52",
"upload_time_iso_8601": "2024-11-18T23:56:52.376620Z",
"url": "https://files.pythonhosted.org/packages/15/03/9ddeaa4c7a5f98f1349bfff6dc7037a854dc2aedd625566fd25f5eda4a25/xaitk_jatic-0.4.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-11-18 23:56:52",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "xaitk-jatic"
}
