跳到主要内容
版本：预览版 🚧

上位机软件安装

CrackNuts上位机提供一个基于 Python 的开发 SDK，默认集成开发环境为 Jupyter，并在其中内置了便于使用的设备控制与数据采集组件。用户也可以在非 Jupyter 环境下，通过标准的 Python 脚本对设备进行控制。

使用本 SDK 需要具备基本的 Python 编程知识。如果您尚不熟悉 Python，推荐参考 廖雪峰的 Python 教程 进行学习。

CrackNuts 上位机作为一个 Python 库，支持通过 pip 直接安装，也可使用我们提供的快速安装脚本进行配置。快速安装脚本将自动创建一个 Conda 虚拟环境，并在其中安装 CrackNuts 及其相关依赖。

您可以根据需求选择以下任一方式进行安装。

快速命令安装​

当您的电脑中没有任何Python环境或者没有安装任何Python虚拟环境时，推荐您使用快速安装方式进行安装。安装后，将执行以下操作：

  1. 安装Miniconda（如果系统中存在则使用已安装版本）
  2. 创建名称为cracknuts的虚拟环境，并指定Python版本为12.3
  3. 安装CrackNuts依赖（最新稳定版）
  4. 创建两个桌面快捷方式：CrackNuts 和 CrackNuts Tutorials，便于快速进入虚拟环境或打开教程。

目前快速安装脚本支持Windows系统和Linux，MacOS系统将在后续版本中支持。

提示

在国内的用户可选择国内网络推荐脚本进行安装，其将使用国内服务器进行安装文件的下载，并自动配置conda和pip的国内镜像，以加快安装速度。

curl https://raw.githubusercontent.com/cracknuts-team/cracknuts/refs/heads/main/install/win-install.ps1 -o "cracknuts-win-install.ps1"; powershell -ExecutionPolicy Bypass -File ".\cracknuts-win-install.ps1"; del "cracknuts-win-install.ps1"

国内网络推荐脚本：

curl https://gitee.com/cracknuts-team/cracknuts/raw/main/install/install.ps1 -o "cracknuts-win-install.ps1"; powershell -ExecutionPolicy Bypass -File ".\cracknuts-win-install.ps1" -EnableChinaConfig; del "cracknuts-win-install.ps1"

Windows安装成功后，桌面出现两个快捷方式：

alt text

双击CrackNuts快捷方式或在开始菜单点击CrackNuts图标，将打开CrackNuts的Conda虚拟环境，您可以开始使用CrackNuts进行设备控制和数据采集的操作。

双击CrackNuts Tutorials快捷方式或在开始菜单点击CrackNuts Tutorials图标，将使用Jupyter打开教程目录，您可在其中选择自己感兴趣的章节进行学习。

PIP安装​

如果您熟悉Python和虚拟环境的配置您也可以通过pip的方式进行安装。使用pip安装时，推荐创建虚拟环境进行安装，以避免对系统的Python环境造成影响。

环境需要​

如果您需要把CrackNuts安装到已有的Python环境中，或者在Jupyter环境中使用CrackNuts，请确保您的环境满足以下要求：

  • Python 版本 3.12.5 或以上版本（可以运行python --versioin检查，Linux和MacOS用户在非虚拟环境下需要执行python3 --version），或者使用Conda、uv等能够管理Python版本的虚拟环境工具进行指定。

  • 如果使用Jupyter进行开发，并且需要在已有的的环境中使用CrackNuts，请确保已经安装Jupyter版本为以下所列出的或以上的版本（可以运行jupyter --version进行验证）。

IPython          : 8.28.0
ipykernel        : 6.29.5
ipywidgets       : 8.1.5
jupyter_client   : 8.6.3
jupyter_core     : 5.7.2
jupyter_server   : 2.14.2
jupyterlab       : 4.2.5
nbclient         : 0.10.0
nbconvert        : 7.16.4
nbformat         : 5.10.4
notebook         : 7.2.2
traitlets        : 5.14.3

关于虚拟环境的更多信息，可以访问 Python虚拟环境 进行学习，或者参考【使用技巧-Python虚拟环境】进行配置。

安装​

在国内环境中可配置国内镜像以加快依赖安装速度，参考【使用技巧-PIP镜像配置】 进行配置。

在命令行中执行如下命令进行安装：

pip install cracknuts[jupyter]

如果您是在已有的Jupyter的环境中进行安装，可仅安装核心库：

pip install cracknuts

安装成功后，执行cracknuts welcome可查看欢迎信息。

更新​

通过以上两种方式安装成功后，可以进入到CrackNuts的环境执行一下命令进行更新， 如果在国内环境下配置的镜像没有CrackNuts最新的版本可指定pypi仓库进行更新

pip install -U cracknuts[jupyter]