Installation#
xyzpy
is available on both pypi and conda-forge. While xyzpy
is itself pure python, the recommended distribution would be mambaforge for installing the various optional dependencies.
Installing with pip
:
pip install xyzpy
Installing with conda
:
conda install -c conda-forge xyzpy
Installing with mambaforge
:
mamba install xyzpy
Hint
Mamba is a faster version of conda
, and the -forge distritbution comes pre-configured with only the conda-forge
channel, which further simplifies and speeds up installing dependencies.
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