Metadata-Version: 2.3
Name: cardio
Version: 2026.1.3
Summary: A simple web-based viewer for 3D and 4D ('cine') medical imaging data.
Keywords: Medical,Imaging,3D,4D,Visualization
Author: Davis Marc Vigneault
Author-email: Davis Marc Vigneault <davis.vigneault@gmail.com>
License: Apache Software License 2.0
         
         Copyright (c) 2023, Davis Marc Vigneault
         
         Licensed under the Apache License, Version 2.0 (the "License");
         you may not use this file except in compliance with the License.
         You may obtain a copy of the License at
         
         http://www.apache.org/licenses/LICENSE-2.0
         
         Unless required by applicable law or agreed to in writing, software
         distributed under the License is distributed on an "AS IS" BASIS,
         WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
         See the License for the specific language governing permissions and
         limitations under the License.
Classifier: Development Status :: 3 - Alpha
Classifier: Environment :: Web Environment
Classifier: Intended Audience :: Healthcare Industry
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Natural Language :: English
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: JavaScript
Classifier: Topic :: Scientific/Engineering :: Image Processing
Classifier: Topic :: Scientific/Engineering :: Medical Science Apps.
Classifier: Topic :: Scientific/Engineering :: Visualization
Requires-Dist: trame-vuetify>=3.0.2
Requires-Dist: trame-vtk>=2.9.1
Requires-Dist: itk>=5.4.4.post1
Requires-Dist: vtk>=9.5.0
Requires-Dist: tomlkit>=0.13.3
Requires-Dist: numpy>=2.2.6
Requires-Dist: pydantic>=2.11.7
Requires-Dist: pydantic-settings>=2.0.0
Requires-Dist: trame>=3.12.0
Requires-Dist: trame-client>=3.10.1
Requires-Dist: ruff>=0.12.10 ; extra == 'dev'
Requires-Dist: isort>=6.0.1 ; extra == 'dev'
Requires-Dist: bumpver>=2025.1131 ; extra == 'dev'
Requires-Dist: pytest>=8.4.1 ; extra == 'dev'
Requires-Dist: coverage>=7.10.4 ; extra == 'dev'
Maintainer: Davis Marc Vigneault
Maintainer-email: Davis Marc Vigneault <davis.vigneault@gmail.com>
Requires-Python: >=3.10
Project-URL: repository, https://github.com/sudomakeinstall/cardio
Provides-Extra: dev
Description-Content-Type: text/markdown

# cardio

`cardio` is a simple web-based viewer for 3D and 4D ('cine') medical imaging data,
built primarily on [trame](https://github.com/kitware/trame),
[vtk](https://github.com/kitware/vtk), and
[itk](https://github.com/insightsoftwareconsortium/itk).  `cardio` can render sequences
of mesh files (e.g., `*.obj` files), segmentation files (e.g., `*.nii.gz` files with
discrete labels) and volume renderings of grayscale images (e.g., `*.nii.gz` files with
continuous values).  `cardio` is launched from the commandline and may be configured via
commandline arguments, a static TOML configuration file, or a combination of the two.

## Quickstart

### Installation

```bash
$ cd /path/to/your/project
$ uv init
$ uv add cardio
$ . ./.venv/bin/activate
(project) cardio --version
cardio 2026.1.3
```

### Developing

Ensuring you have all required dependencies:

```bash
$ uv sync --all-extras
```

Pre-commit checklist:

```bash
$ isort .
$ ruff format
$ pytest -v
```

Uploading:

```bash
$ bumpver update
$ uv build --no-sources
$ uv publish --token <pypi_api_key>
```
