Skip to content

Commit

Permalink
Update README for PyPI package
Browse files Browse the repository at this point in the history
  • Loading branch information
KrisThielemans committed Nov 1, 2024
1 parent 6307fb9 commit c30ccfc
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 2 deletions.
9 changes: 9 additions & 0 deletions python/README.pypi.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# PETSIRD Python SDK

The [Emission Tomography Standardization Initiative (ETSI)](https://etsinitiative.org/)
is working towards establishing a standard for PET Raw Data, called PETSIRD ("PET ETSI Raw Data").

This python package contains the python SDK to read/write PETSIRD data.

Examples for how to use this package are available at
https://github.com/ETSInitiative/PETSIRD/tree/main/python
6 changes: 4 additions & 2 deletions python/pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ build-backend = "setuptools.build_meta"
name = "petsird"
dynamic = ["version"]
description = "Library and tools for working with PET Emission Tomography Standardization Initiative Raw Data (PETSIRD) data"
readme = "README.md"
readme = "README.pypi.md"
authors = [
# TODO
{name = "Kris Thielemans", email = "[email protected]"},
Expand All @@ -28,7 +28,9 @@ classifiers = [
"Programming Language :: Python :: 3.10",
"Programming Language :: Python :: 3.11",
"Programming Language :: Python :: 3.12",
"Programming Language :: Python :: 3 :: Only"]
"Programming Language :: Python :: 3 :: Only",
"Intended Audience :: Science/Research",
"Topic :: Scientific/Engineering :: Medical Science Apps."]

[tool.setuptools.packages.find]
include = ["petsird", "petsird.*"]
Expand Down

0 comments on commit c30ccfc

Please sign in to comment.