Getting started
Install dcmview, open an approved DICOM file or study directory, and stop the temporary viewer when you are finished.
Choose an install channel
Section titled “Choose an install channel”The Python package is the shortest supported path on Linux x64, macOS x64, macOS arm64, and Windows x64. Its wheel bundles the same Rust binary used by every other integration.
| Environment | Supported install path |
|---|---|
| Linux x64 | dcmview-py from PyPI or a GitHub Release archive |
| macOS x64 or arm64 | dcmview-py from PyPI or a GitHub Release archive |
| Windows x64 | dcmview-py, a GitHub Release archive, or the VS Code extension |
| VS Code on a supported host | dcmview from the VS Code Marketplace |
| Another platform | Build the Rust binary from source |
You need Python 3.9 or later for the PyPI package.
Install the stable release
Section titled “Install the stable release”python -m pip install --user dcmview-py==0.2.12The package installs two console commands, dcmview and dcmview-py. Use dcmview as the primary command.
If your shell cannot find a user-installed command, reopen the shell or add Python’s user script directory to PATH. See installation troubleshooting before installing another copy.
Verify the installation
Section titled “Verify the installation”dcmview --versiondcmview 0.2.12You can also inspect the full command help:
dcmview --helpInspect a first file
Section titled “Inspect a first file”Choose a synthetic or properly authorized DICOM file already on your machine:
dcmview ./scan.dcmdcmview binds an available loopback port, starts discovery, and opens the viewer in your default browser. The first valid object can appear while a larger directory scan is still running.
For a directory, pass the directory path. Discovery is recursive by default:
dcmview ./study-directoryIn the viewer:
- Select a file or logical series in Explorer.
- Use the mouse wheel or Left/Right arrows to move through frames.
- Press
W, then drag to change window and level; pressPto pan orZto zoom. - Open Tags to inspect DICOM metadata.
Press Ctrl+C in the launching terminal to stop the server. There is no database or saved viewer session to clean up.
If a browser cannot open
Section titled “If a browser cannot open”Ask dcmview to print the URL instead:
dcmview --no-browser ./study-directorydcmview: server running at http://127.0.0.1:<port>Open the printed URL on the same machine. If the files are on another server, follow the remote inspection guide instead of exposing the viewer publicly.