Skip to content

Commit 9999a04

Browse files
committed
feat: enhance install.sh with resume, repair, and uninstall support
1 parent ca6a1aa commit 9999a04

5 files changed

Lines changed: 648 additions & 66 deletions

File tree

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,3 +30,4 @@ data/
3030

3131
# Claude Code guidance
3232
CLAUDE.md
33+
.install_progress

README.md

Lines changed: 48 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -31,17 +31,56 @@ CIMFlow consists of two main components:
3131

3232
## Prerequisites
3333

34-
Before installing, ensure you have the following system dependencies:
34+
### Python Environment
3535

36-
- **Python**: 3.11+
37-
- **Build Tools**: `cmake` (>=3.20), `ninja-build`, `make`, `build-essential`
38-
- **Compiler**: `clang`, `lld`, `ccache`
39-
- **Java**: `openjdk-11-jdk` (for ANTLR parser)
40-
- **Libraries**: `libeigen3-dev`, `libunwind-dev`
36+
- **Python 3.11 or later** is required.
37+
38+
We recommend using Conda for Python environment management:
39+
40+
```bash
41+
conda create -n cimflow python=3.11
42+
conda activate cimflow
43+
```
44+
45+
> **Note:** If you don't have Conda installed, see the [Miniconda installation guide](https://docs.conda.io/en/latest/miniconda.html).
46+
47+
Alternatively, you can use venv:
48+
49+
```bash
50+
python3.11 -m venv .venv
51+
source .venv/bin/activate
52+
```
53+
54+
### System Dependencies
55+
56+
Install the required system packages (Ubuntu/Debian):
57+
58+
```bash
59+
# Build tools
60+
sudo apt install build-essential cmake ninja-build ccache
61+
62+
# Clang toolchain (for LLVM/MLIR build)
63+
sudo apt install clang lld
64+
65+
# Java Development Kit (for ANTLR parser)
66+
sudo apt install openjdk-11-jdk
67+
68+
# Required libraries
69+
sudo apt install libeigen3-dev libunwind-dev
70+
```
4171

4272
## Installation
4373

44-
To install CIMFlow, its dependencies, and handle submodules, run the installation script:
74+
### 1. Clone the Repository
75+
76+
```bash
77+
git clone https://github.com/BUAA-CI-LAB/CIMFlow.git
78+
cd CIMFlow
79+
```
80+
81+
### 2. Run Installation Script
82+
83+
With your virtual environment activated, run the installation script:
4584

4685
```bash
4786
./install.sh
@@ -53,6 +92,8 @@ This script will:
5392
3. Install the Python package and CLI tools.
5493
4. Generate the default configuration in `config/tool_paths.json`.
5594

95+
> **Tip:** Run `./install.sh --help` for additional options (resume, repair, uninstall, etc.).
96+
5697
## Configuration
5798

5899
Runtime paths are defined in `config/tool_paths.json`. This file is automatically created during installation.

examples/batch.json

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@
1111
"k": 16,
1212
"b": 16,
1313
"c": 64,
14-
"batch_size": 1,
14+
"batch_size": 8,
1515
"strategy": "dp"
1616
},
1717
{
@@ -21,8 +21,8 @@
2121
"k": 16,
2222
"b": 16,
2323
"c": 64,
24-
"batch_size": 1,
24+
"batch_size": 8,
2525
"strategy": "dp"
2626
}
2727
]
28-
}
28+
}

0 commit comments

Comments
 (0)