Skip to content

Commit

Permalink
feat: Update pyproject.toml and README based of ImagingDataCommons/id…
Browse files Browse the repository at this point in the history
…c-index
  • Loading branch information
jcfr committed Mar 10, 2024
1 parent 6948270 commit 6083956
Show file tree
Hide file tree
Showing 2 changed files with 35 additions and 8 deletions.
37 changes: 31 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,20 +4,45 @@
[![Documentation Status][rtd-badge]][rtd-link]

[![PyPI version][pypi-version]][pypi-link]
[![Conda-Forge][conda-badge]][conda-link]
[![PyPI platforms][pypi-platforms]][pypi-link]

[![GitHub Discussion][github-discussions-badge]][github-discussions-link]
[![Discourse Forum][discourse-forum-badge]][discourse-forum-link]

<!-- SPHINX-START -->

## About

`idc-index-data` is a Python package providing the index to query and download
data hosted by the
[NCI Imaging Data Commons (IDC)](https://imaging.datacommons.cancer.gov).

## Usage

This Python package bundles the `idc_index.csv.zip` archive and is intended to
be used by the [idc-index](https://pypi.org/project/idc-index/) Python package.

## Acknowledgment

This software is maintained by the IDC team, which has been funded in whole or
in part with Federal funds from the NCI, NIH, under task order no. HHSN26110071
under contract no. HHSN261201500003l.

If this package helped your research, we would appreciate if you could cite IDC
paper below.

> Fedorov, A., Longabaugh, W. J. R., Pot, D., Clunie, D. A., Pieper, S. D.,
> Gibbs, D. L., Bridge, C., Herrmann, M. D., Homeyer, A., Lewis, R., Aerts, H.
> J. W., Krishnaswamy, D., Thiriveedhi, V. K., Ciausu, C., Schacherer, D. P.,
> Bontempi, D., Pihl, T., Wagner, U., Farahani, K., Kim, E. & Kikinis, R.
> _National Cancer Institute Imaging Data Commons: Toward Transparency,
> Reproducibility, and Scalability in Imaging Artificial Intelligence_.
> RadioGraphics (2023). https://doi.org/10.1148/rg.230180
<!-- prettier-ignore-start -->
[actions-badge]: https://github.com/ImagingDataCommons/idc-index-data/workflows/CI/badge.svg
[actions-link]: https://github.com/ImagingDataCommons/idc-index-data/actions
[conda-badge]: https://img.shields.io/conda/vn/conda-forge/idc-index-data
[conda-link]: https://github.com/conda-forge/idc-index-data-feedstock
[github-discussions-badge]: https://img.shields.io/static/v1?label=Discussions&message=Ask&color=blue&logo=github
[github-discussions-link]: https://github.com/ImagingDataCommons/idc-index-data/discussions
[discourse-forum-badge]: https://img.shields.io/discourse/https/discourse.canceridc.dev/status.svg
[discourse-forum-link]: https://discourse.canceridc.dev/
[pypi-link]: https://pypi.org/project/idc-index-data/
[pypi-platforms]: https://img.shields.io/pypi/pyversions/idc-index-data
[pypi-version]: https://img.shields.io/pypi/v/idc-index-data
Expand Down
6 changes: 4 additions & 2 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -7,13 +7,15 @@ build-backend = "hatchling.build"
name = "idc-index-data"
authors = [
{ name = "Andrey Fedorov", email = "[email protected]" },
{ name = "Vamsi Thiriveedhi", email = "[email protected]" },
{ name = "Jean-Christophe Fillion-Robin", email = "[email protected]" },
]
description = "ImagingDataCommons index to query and download data."
readme = "README.md"
license.file = "LICENSE"
requires-python = ">=3.8"
classifiers = [
"Development Status :: 1 - Planning",
"Development Status :: 4 - Beta",
"Intended Audience :: Science/Research",
"Intended Audience :: Developers",
"License :: OSI Approved :: MIT License",
Expand Down Expand Up @@ -52,7 +54,7 @@ docs = [
[project.urls]
Homepage = "https://github.com/ImagingDataCommons/idc-index-data"
"Bug Tracker" = "https://github.com/ImagingDataCommons/idc-index-data/issues"
Discussions = "https://github.com/ImagingDataCommons/idc-index-data/discussions"
Discussions = "https://discourse.canceridc.dev/"
Changelog = "https://github.com/ImagingDataCommons/idc-index-data/releases"


Expand Down

0 comments on commit 6083956

Please sign in to comment.