# ringo

**Repository Path**: restgroup/ringo

## Basic Information

- **Project Name**: ringo
- **Description**: REST install in one go
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2026-05-31
- **Last Updated**: 2026-07-02

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# REST Windows 安装脚本

用于在 Windows 上安装 [REST](https://gitee.com/restgroup/rest) 的自动化脚本，REST 是一个电子结构计算工具。灵感来自 [ABACUS Windows Installer](https://github.com/deepmodeling/abacus-develop/tree/develop/tools/windows)。

> **免责声明：** 这些脚本会自动执行 conda/PATH/WSL 修改和网络下载。使用即表示您接受所有风险。如果您希望手动安装，请参考 [REST 官方文档](https://rest-doc.readthedocs.io/zh_CN/user/install.html)。

## 快速开始

右键点击 `install-rest.bat` → **以管理员身份运行**，然后选择安装方式。

| 安装方式 | 说明 |
|---|---|
| Native Windows | 直接在 Windows 上安装 conda + REST |
| WSL2 | 在 Ubuntu WSL2 环境中安装 Linux 版 REST。**更稳定，推荐使用。** |

## 安装内容

### Native Windows
- 如未检测到 conda，将安装 **Miniforge3** 至 `[盘符]:\REST\miniforge`
- 创建 conda 环境 `rest-py311` 并安装 REST
- 创建启动器 `[盘符]:\REST\bin\rest.cmd` → 添加至用户 PATH
- 安装盘符可由用户选择，默认排除系统盘（C:）

### WSL2
- 在 WSL 内安装 **Miniforge3** 至 `~/rest-miniforge`
- 创建 conda 环境 `rest-py311` 并安装 REST
- 创建启动器 `~/rest_scripts/rest`
- 创建 Windows 封装脚本 `[盘符]:\REST\bin\rest.cmd` → 添加至用户 PATH

## 使用方法

安装完成后，打开一个**新的**终端。**推荐使用 Windows Terminal**——支持 UTF-8、多标签页和现代渲染。如未安装，可在 Microsoft Store 免费获取。

- **Windows Terminal** — `Win + R` → `wt` → 回车，或开始菜单搜索 `Terminal`
- **PowerShell** — `Win + R` → `powershell` → 回车
- **命令提示符** — `Win + R` → `cmd` → 回车

然后运行：

```cmd
rest
rest --help
```

对于 WSL 安装，也可以直接进入 Linux Shell：

```cmd
wsl -d Ubuntu
```

## 卸载

运行 `uninstall-rest.bat`。它会自动检测安装类型和位置，并清理 conda 环境、Miniforge、启动器和 PATH 条目。

## 注意事项

- **控制台快速编辑模式：** Windows 控制台的快速编辑模式会在点击窗口时暂停输出。如果脚本看起来卡住了，右键点击或按 Esc 解冻。请避免在脚本运行时点击控制台窗口。
- **推荐使用 WSL2：** REST 的 Linux conda 包比 Windows 版更稳定。如果 Native Windows 安装遇到问题，请尝试 WSL2。
- 默认启用 **BFSU 镜像**以加速下载。在提示时输入 `n` 可使用默认下载通道。
- conda 环境名称为 `rest-py311`，从 `conda-forge`、`restgroup` 和 `mokit` 三个通道安装。