From 5ac465d1819468a88dec4be373f1c094b6f2e40c Mon Sep 17 00:00:00 2001 From: Jermiah Joseph <44614774+jjjermiah@users.noreply.github.com> Date: Sat, 3 Feb 2024 18:29:07 -0500 Subject: [PATCH 1/2] Update README.md --- README.md | 23 ++++++++++++----------- 1 file changed, 12 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index 72b9497..4aa7016 100644 --- a/README.md +++ b/README.md @@ -25,12 +25,15 @@ - ***Validate doownloads with MD5 checksums*** for downloaded images - **Auto-sort** DICOM files using a user-defined pattern of DICOM tags with specialized ***DICOMSorter class*** -See Documentation at [NBIA-Toolkit Read The Docs](https://nbia-toolkit.readthedocs.io/en/latest/) +> [!NOTE] +> For a thorough description of the package and its available features, please refer to the Documentation at [NBIA-Toolkit Read The Docs](https://nbia-toolkit.readthedocs.io/en/latest/) ## Installation -`nbiatoolkit` is currently under development. +> [!WARNING] +> `nbiatoolkit` is currently under development and is not guaranteed to be stable. + It is made available via PyPI and can be installed using pip: **** ```bash @@ -38,9 +41,9 @@ pip install nbiatoolkit ``` ## CLI Usage +> [!TIP] +> For quick access to the NBIA, the toolkit also provides a command line interface (CLI) -# getCollections Output -nbia-toolkit also provides a command line interface (CLI) to query the NBIA database for some queries. ``` bash NBIAToolkit-Output > NBIAToolkit --version _ ______ _______ ______ ____ _ __ @@ -80,14 +83,12 @@ dicomsort [-h] [-u USERNAME] [-p PASSWORD] Interested in contributing? Check out the contributing guidelines. Please note that this project is released with a Code of Conduct. By contributing to this project, you agree to abide by its terms. ## License - `nbiatoolkit` was created by Jermiah Joseph. It is licensed under the terms of the MIT license. ## User Agreements and Disclaimers -The NBIA-toolkit is NOT a product of the National Cancer Institute (NCI) and is not endorsed by the NCI. -The NBIA-toolkit is provided as an open-source tool based on the [NBIA REST API](https://wiki.cancerimagingarchive.net/display/Public/NBIA+Advanced+REST+API+Guide). -The NBIA-toolkit is provided "AS IS" without warranty of any kind. - -In no event shall the authors or contributors be liable for any claim, damages or other liability, arising from, out of or in connection with the NBIA-toolkit or the use or other dealings in the NBIA-toolkit. +> [!IMPORTANT] +>The NBIA-toolkit is NOT a product of the National Cancer Institute (NCI) and is not endorsed by the NCI. +> Users of the NBIA-toolkit are required to abide by the NBIA REST API Terms of Service and the [NBIA Data Usage Policies and Restrictions](https://www.cancerimagingarchive.net/data-usage-policies-and-restrictions/) +> The NBIA-toolkit is provided as an open-source tool based on the [NBIA REST API](https://wiki.cancerimagingarchive.net/display/Public/NBIA+Advanced+REST+API+Guide) and is provided "AS IS" without warranty of any kind. +> In no event shall the authors or contributors be liable for any claim, damages or other liability, arising from, out of or in connection with the NBIA-toolkit or the use or other dealings in the NBIA-toolkit. -Users of the NBIA-toolkit are required to abide by the NBIA REST API Terms of Service and the [NBIA Data Usage Policies and Restrictions](https://www.cancerimagingarchive.net/data-usage-policies-and-restrictions/) From 0d46ccfee49b00278cbb7514847ce89ec9760c6e Mon Sep 17 00:00:00 2001 From: Jermiah Joseph <44614774+jjjermiah@users.noreply.github.com> Date: Sat, 3 Feb 2024 19:10:13 -0500 Subject: [PATCH 2/2] Update README.md --- README.md | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/README.md b/README.md index 4aa7016..543ad48 100644 --- a/README.md +++ b/README.md @@ -41,8 +41,7 @@ pip install nbiatoolkit ``` ## CLI Usage -> [!TIP] -> For quick access to the NBIA, the toolkit also provides a command line interface (CLI) +For quick access to the NBIA, the toolkit also provides a command line interface (CLI) ``` bash NBIAToolkit-Output > NBIAToolkit --version