Skip to content

Commit aa100ae

Browse files
committed
added instructions on how to install CC3D
1 parent f306909 commit aa100ae

1 file changed

Lines changed: 123 additions & 0 deletions

File tree

docs/releases/4.8.0.md

Lines changed: 123 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -118,3 +118,126 @@ We have overhauled how you capture your simulations:
118118
parameter handling.
119119
- Fixed folder access and file handling bugs during long-running
120120
operations.
121+
122+
# 🚀 How to Install
123+
124+
## Option 1: Conda / Mamba (Recommended)
125+
126+
### 🔹 Quick install (existing environment)
127+
128+
```bash
129+
mamba install -c compucell3d -c conda-forge compucell3d=4.8.0
130+
```
131+
132+
Launch Player:
133+
134+
```bash
135+
python -m cc3d.player5
136+
```
137+
138+
---
139+
140+
### 🔹 Recommended clean installation (best stability)
141+
142+
```bash
143+
conda create -n cc3d_480 python=3.12 -c conda-forge
144+
conda activate cc3d_480
145+
conda install -c conda-forge mamba
146+
mamba install -c conda-forge -c compucell3d compucell3d=4.8.0
147+
```
148+
149+
👉 On Windows, you may also run:
150+
151+
```bash
152+
set PYTHONIOENCODING=utf-8
153+
```
154+
155+
---
156+
157+
### ⚠️ Notes
158+
159+
- Use **conda-forge + compucell3d channels only**
160+
- Avoid `main` channel to prevent conflicts
161+
- `mamba` is strongly recommended
162+
163+
---
164+
165+
## Option 2: Binary Downloads
166+
167+
👉 https://sourceforge.net/projects/cc3d/files/
168+
169+
---
170+
171+
### 🪟 Windows
172+
173+
- Choose appropriate installer (.exe)
174+
- If GPU issues occur → use no-GPU installer
175+
176+
If CC3D fails after upgrade:
177+
- Remove old installation directory
178+
- Remove `_settings.sqlite` if needed
179+
180+
---
181+
182+
### 🍎 macOS
183+
184+
Before installing:
185+
```bash
186+
rm -rf ~/CompuCell3D
187+
```
188+
189+
#### Apple Silicon (M1/M2/M3)
190+
191+
```bash
192+
chmod +x cc3d-installer-osx-4.8.0-arm64.sh
193+
./cc3d-installer-osx-4.8.0-arm64.sh
194+
```
195+
196+
#### Intel Macs
197+
198+
Binaries coming soon.
199+
200+
---
201+
202+
### 🐧 Linux
203+
204+
```bash
205+
chmod +x cc3d-installer-linux-4.8.0-x86-64bit.sh
206+
./cc3d-installer-linux-4.8.0-x86-64bit.sh
207+
```
208+
209+
Install location:
210+
~/CompuCell3D
211+
212+
---
213+
214+
# ▶️ Running CompuCell3D
215+
216+
Player:
217+
```bash
218+
python -m cc3d.player5
219+
```
220+
221+
Twedit++:
222+
```bash
223+
python -m cc3d.twedit5
224+
```
225+
226+
Headless:
227+
```bash
228+
python -m cc3d.run_script
229+
```
230+
231+
---
232+
233+
# 📦 Optional: Install Demos
234+
235+
Download from:
236+
https://github.com/CompuCell3D/CompuCell3D/tree/master/CompuCell3D/core/Demos
237+
238+
Place in:
239+
~/CompuCell3D/Demos
240+
241+
---
242+
243+

0 commit comments

Comments
 (0)