Installation

From PyPI

pip install xyzrender

Or with uv:

uv tool install xyzrender

To test without installing:

uvx xyzrender

From Source

git clone https://github.com/aligfellow/xyzrender.git
cd xyzrender
pip install .

Or with uv:

git clone https://github.com/aligfellow/xyzrender.git
cd xyzrender
uv tool install .

Optional dependencies

Some features require additional packages:

pip install 'xyzrender[smi]'      # SMILES input (rdkit)
pip install 'xyzrender[cif]'      # CIF input + ASE GUI viewer (ase)
pip install 'xyzrender[v]'        # v viewer for interactive rotation (vmol)
pip install 'xyzrender[all]'      # everything above

xyzrender auto-detects resvg-py and uses it when available. Without it, CairoSVG is used as fallback (filters silently ignored in raster output).

Development setup

Requires uv and just.

git clone https://github.com/aligfellow/xyzrender.git
cd xyzrender
just setup

Available just commands:

Command	Description
just check	Run lint + type-check + tests
just lint	Format and lint with ruff
just type	Type-check with ty
just test	Run pytest with coverage
just fix	Auto-fix lint issues
just build	Build distribution
just setup	Install all dev dependencies