Installation#

conda#

polyxios is packaged on conda-forge:

conda install -c conda-forge polyxios

Development install#

Clone the repo, then use spin to manage the build:

pip install spin
spin setup       # first-time: upstream remote + build deps (libomp on macOS)
spin install     # compiled install
spin install -e  # editable install - source changes reflected immediately

Dependencies#

  • Python >= 3.12

  • NumPy >= 1.24

Optional:

  • Cython >= 3.0 (compiled hot-paths; pure Python fallbacks included)

  • h5py >= 3.0, for the HDF5 heavy data of XDMF files and for the formats that are HDF5 files outright - VTKHDF, MED, CGNS, H5M and HMF - pip install "polyxios[hdf5]". Without it XDMF’s inline and binary flavours still read and write, and an HDF5 file or reference raises UnsupportedFormatError naming the extra.

  • netCDF4 >= 1.6, for Exodus II files - pip install "polyxios[netcdf]". Without it the format raises UnsupportedFormatError naming the extra.

  • lazrs >= 0.5, for LAZ-compressed LAS files - pip install "polyxios[laz]". A plain .las needs nothing; a compressed one raises MissingPackageError naming the extra.

  • FURY >= 2, for pxios viz - pip install "polyxios[viz]".