Installation

Note

Recommended Install

CRISPy is actively being developed at the moment, install from the source (see Option 3) to stay up-to-date with the latest version.

System Requirements

CRISPy is compatible with the following environments: - Python 3.8 or later. - Dependencies include numpy, astropy, scipy, scikit-image, and scikit-learn.

Instructions

1. Install from PyPI:

   The easiest way to install CRISPy is through PyPI. Run the following command in your terminal:

   pip install crispy-learn
   

2. Install from Source: to install the latest developing version, clone the CRISPy GitHub repository:

   git clone https://github.com/mcyc/crispy.git
   cd crispy
   pip install -e .
   

   To use a specific version using a tag, for example, v1.2.0, run the following after the initial install:

   git checkout v1.2.0
   git pull
   

   Note

   If you encounter issues with pre-existing versions of dependencies or want to ensure that the pinned versions of CRISPy’s dependencies are installed, use the following command:

   pip install --upgrade --force-reinstall --no-cache-dir -e .
   

   This command ensures that all dependencies are freshly installed, replacing any older or conflicting versions.

3. Dependencies: CRISPy will automatically install its dependencies during installation. If any issues occur, install them manually:

   pip install numpy scipy astropy joblib scikit-image scikit-learn
   

Verification

To verify the installation, open a Python interpreter and import CRISPy:

import crispy
print(crispy.__version__)

If no errors occur, CRISPy is installed correctly.