SCARR Installation

SCARR is the default framework used by CrackNuts for data analysis, and it also serves as the default format for trace acquisition (based on a specific directory structure using Zarr). It is recommended to install SCARR when performing data analysis.

The CrackNuts organization has forked this repository and will be improving the codebase, with plans to contribute relevant features back to the main repository. To use the latest data analysis features of CrackNuts, users are recommended to prioritize the SCARR version maintained by the CrackNuts organization.

1. Install directly from the git repository

   pip install "git+https://github.com/cracknuts-team/scarr.git"

   If you are unable to download from within China, try the following:

   pip install "git+https://gitee.com/cracknuts-team/scarr.git"

2. Download the code and install locally

   You can download the repository code in zip format locally via GitHub:

   

   After downloading, extract the archive, navigate into the directory, and run the following command to install:

   pip install .

   Alternatively, clone the code locally using git, enter the directory, and execute the same command above to install.

   After successful installation, enter Python and execute import scarr. If no error occurs, the installation was successful.