Installation

The xcal package is currently only available to download and install from source available from XCAL.

Step 1: Clone repository

git clone git@github.com:cabouman/xcal.git
cd xcal

Step 2: Install xcal

Two options are listed below for installing xcal. Option 1 only requires that a bash script be run, but it is less flexible. Option 2 explains how to perform manual installation.

Option 1: Clean install from dev_scripts

To do a clean install, use the command:

cd dev_scripts
source ./clean_install_all.sh
cd ..

Option 2: Manual install

  1. Create conda environment: Create a new conda environment named xcal using the following commands:

    conda remove env --name xcal --all
    conda create --name xcal python=3.10
    conda activate xcal
    conda install ipykernel
    python -m ipykernel install --user --name xcal --display-name xcal
    
  2. Install package:

    pip install -r requirements.txt
    pip install .