Skip to content

Latest commit

 

History

History
55 lines (38 loc) · 1.3 KB

README.md

File metadata and controls

55 lines (38 loc) · 1.3 KB
Raw

conda build Anaconda-Server Version

k2dist

k2dist is a tool to compute orientation factor (kappa2) distributions.

k2dist GUI

Building and installation

k2dist can be installed from the source code in a python environment that resolves all necessary dependencies. Alternatively, k2dist can be installed via conda.

Source

To install k2dist from the source clone the git repository and run the setup script.

git clone https://gitlab.peulen.xyz/tpeulen/k2dist
cd k2dist
python setup.py install

After installing k2dist you can open the GUI from the commandline.

k2dist

Conda

k2dist depends on common python packages that can be installed from conda-forge. The easiest installation path is using conda/mamba

mamba install k2dist -c tpeulen

To avoid potential conflicts k2dist can be installed in a separate environment.

conda env create -n k2dist
conda activate k2dist
mamba install k2dist -c tpeulen

k2dist can be started from the command line as follows:

k2dist