Installation¶
xyzpy is available on both pypi and
conda-forge. While xyzpy is
pure python itself, the preferred way to install it is with
pixi, which creates isolated and reproducible environments
that can mix packages from conda-forge (the
default) and also pypi.
Installing with pixi (preferred):
pixi init xyzpy-project
cd xyzpy-project
pixi add xyzpy
Installing with pip:
pip install xyzpy
# or
uv pip install xyzpy
It is recommended to use uv to install and
manage purely pypi based environments.
Installing with conda / mamba:
conda install -c conda-forge xyzpy
miniforge is the recommended way
to manage and install a conda-based environment.
Installing the latest version directly from github:
If you want to checkout the latest version of features and fixes, you can install directly from the github repository:
pip install -U git+https://github.com/jcmgray/xyzpy.git
Installing a local, editable development version:
If you want to make changes to the source code and test them out, you can install a local editable version of the package:
git clone https://github.com/jcmgray/xyzpy.git
pip install --no-deps -U -e xyzpy/
Dependencies¶
xyzpy is itself a pure python package, built atop the following libraries:
numpy - ndarrays
xarray - labelled ndarrays
joblib - serialization and parallel processing
tqdm - progress bars
pandas - dataframes
and the optional plotting functionality is provided by:
matplotlib - plotting
bokeh - interactive plotting