Installation#

There are several possible ways to install this package:

Conda - conda-forge#

Install from conda-forge:

conda install -c conda-forge hklpy2

Pip - PyPI#

Install from the Python Package Index (PyPI) repository:

pip install hklpy2

Pip - Source#

Install directly from the GitHub source code repository. Either:

pip install https://github.com/prjemian/hklpy2/archive/main.zip

or editable install (this is for developers) from local clone of source code.

First, clone the repository (into directory hklpy2):

git clone https://github.com/prjemian/hklpy2

Then, install from the new hklpy2 directory:

pip install -e hklpy2 --no-deps

See also

prjemian/hklpy2

Development#

Follow these steps (in bash shell) to setup a conda environment fordevelopment and testing:

1export HKLPY2_ENV=hklpy2
2conda create -y -n "${HKLPY2_ENV}" pyepics hkl tiled bson python pandoc
3conda activate "${HKLPY2_ENV}"
4pip install --pre tiled
5pip install --pre -e .[all]