Skip to content

Commit e2daedc

Browse files
DAEKYU YOONDAEKYU YOON
DAEKYU YOON
authored and
DAEKYU YOON
committed
Track Starlight content docs
1 parent 0d78c98 commit e2daedc

17 files changed

Lines changed: 455 additions & 1 deletion

‎.gitignore‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,4 +12,4 @@ dist/
1212
.netrc
1313
Arepo/
1414
Enzo/
15-
docs/
15+
/docs/

‎src/content/docs/en/basics.mdx‎

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
---
2+
title: Basics
3+
description: Core concepts before diving into any simulation code.
4+
sidebar:
5+
order: 1
6+
---
7+
8+
# Core concepts before touching any codebase
9+
10+
If you understand what is being solved and which numerical trade-offs matter, code documentation becomes easier to read.
11+
12+
## Minimum concept set
13+
14+
- **Hydrodynamics + gravity**: many astrophysical problems require both.
15+
- **Discretization**: continuous equations become cells or particles.
16+
- **Resolution**: more detail costs more memory and runtime.
17+
- **Time integration**: stable timestep control is critical.
18+
19+
## Practical reading order
20+
21+
1. Pick a target problem (galaxy formation, cluster evolution, idealized tests).
22+
2. Compare method families (mesh, AMR, particle-based).
23+
3. Check assumptions (boundary conditions, cooling, feedback models).
24+
25+
## Next pages
26+
27+
- [Arepo](/en/codes/arepo/)
28+
- [Enzo](/en/codes/enzo/)
29+
- [Gadget](/en/codes/gadget/)
30+
- [Gizmo](/en/codes/gizmo/)

‎src/content/docs/en/codes/arepo.mdx‎

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
---
2+
title: Arepo
3+
description: Beginner-oriented profile of Arepo.
4+
sidebar:
5+
order: 1
6+
---
7+
8+
# Arepo
9+
10+
This is a foundation-level summary for first-time readers.
11+
12+
## Quick snapshot
13+
14+
- **Method family**: Moving-mesh finite-volume hydrodynamics
15+
- **Main strengths**: Strong fluid interface handling with adaptive behavior
16+
- **Watch-outs**: Configuration complexity can be high for newcomers
17+
- **When to consider**: Projects that need adaptive gas dynamics detail
18+
19+
## Reading policy for future expansion
20+
21+
When extending this page, connect each technical claim to at least one source category:
22+
23+
- official documentation
24+
- paper citation
25+
- versioned code reference
26+
27+
## Continue
28+
29+
- [Compare table](/en/compare/)
30+
- [Glossary](/en/glossary/)

‎src/content/docs/en/codes/enzo.mdx‎

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
---
2+
title: Enzo
3+
description: Beginner-oriented profile of Enzo.
4+
sidebar:
5+
order: 2
6+
---
7+
8+
# Enzo
9+
10+
This is a foundation-level summary for first-time readers.
11+
12+
## Quick snapshot
13+
14+
- **Method family**: Eulerian AMR (Adaptive Mesh Refinement)
15+
- **Main strengths**: Hierarchical refinement over large dynamic ranges
16+
- **Watch-outs**: Refinement strategy choices strongly affect outcomes
17+
- **When to consider**: Problems that benefit from adaptive structured grids
18+
19+
## Reading policy for future expansion
20+
21+
When extending this page, connect each technical claim to at least one source category:
22+
23+
- official documentation
24+
- paper citation
25+
- versioned code reference
26+
27+
## Continue
28+
29+
- [Compare table](/en/compare/)
30+
- [Glossary](/en/glossary/)

‎src/content/docs/en/codes/gadget.mdx‎

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
---
2+
title: Gadget
3+
description: Beginner-oriented profile of Gadget.
4+
sidebar:
5+
order: 3
6+
---
7+
8+
# Gadget
9+
10+
This is a foundation-level summary for first-time readers.
11+
12+
## Quick snapshot
13+
14+
- **Method family**: TreePM gravity with SPH family workflows
15+
- **Main strengths**: Large historical ecosystem in cosmological simulations
16+
- **Watch-outs**: SPH formulation and settings must be validated carefully
17+
- **When to consider**: Established cosmological pipelines in particle-based setups
18+
19+
## Reading policy for future expansion
20+
21+
When extending this page, connect each technical claim to at least one source category:
22+
23+
- official documentation
24+
- paper citation
25+
- versioned code reference
26+
27+
## Continue
28+
29+
- [Compare table](/en/compare/)
30+
- [Glossary](/en/glossary/)

‎src/content/docs/en/codes/gizmo.mdx‎

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
---
2+
title: Gizmo
3+
description: Beginner-oriented profile of Gizmo.
4+
sidebar:
5+
order: 4
6+
---
7+
8+
# Gizmo
9+
10+
This is a foundation-level summary for first-time readers.
11+
12+
## Quick snapshot
13+
14+
- **Method family**: Mesh-free finite-mass / finite-volume methods
15+
- **Main strengths**: Particle flexibility with modern hydro options
16+
- **Watch-outs**: Method mode and parameters must match science goals
17+
- **When to consider**: Particle-adaptive workflows seeking improved hydro treatment
18+
19+
## Reading policy for future expansion
20+
21+
When extending this page, connect each technical claim to at least one source category:
22+
23+
- official documentation
24+
- paper citation
25+
- versioned code reference
26+
27+
## Continue
28+
29+
- [Compare table](/en/compare/)
30+
- [Glossary](/en/glossary/)

‎src/content/docs/en/compare.mdx‎

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
---
2+
title: Compare
3+
description: Side-by-side view of Arepo, Enzo, Gadget, and Gizmo.
4+
sidebar:
5+
order: 3
6+
---
7+
8+
# Side-by-side code comparison
9+
10+
This matrix is intentionally compact for beginners. Add details only with source-backed claims.
11+
12+
| Code | Method family | Typical strength | Potential caveat |
13+
| --- | --- | --- | --- |
14+
| Arepo | Moving-mesh finite-volume | Fluid interface handling + adaptivity | Broad configuration space |
15+
| Enzo | Eulerian AMR grid | Hierarchical refinement control | Refinement sensitivity |
16+
| Gadget | TreePM + SPH family | Broad historical usage in cosmology | SPH setting dependence |
17+
| Gizmo | Mesh-free finite-mass/volume | Particle adaptivity + modern hydro behavior | Mode and parameter tuning |
18+
19+
## Code pages
20+
21+
- [Arepo](/en/codes/arepo/)
22+
- [Enzo](/en/codes/enzo/)
23+
- [Gadget](/en/codes/gadget/)
24+
- [Gizmo](/en/codes/gizmo/)

‎src/content/docs/en/glossary.mdx‎

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
---
2+
title: Glossary
3+
description: Shared terminology for multilingual consistency.
4+
sidebar:
5+
order: 4
6+
---
7+
8+
# Core simulation glossary
9+
10+
Use one preferred translation per source term to keep multilingual pages consistent.
11+
12+
## Terms
13+
14+
- **Hydrodynamics**: numerical treatment of fluid motion, shocks, and mixing.
15+
- **N-body**: time evolution of many gravitationally interacting particles.
16+
- **AMR (Adaptive Mesh Refinement)**: selective local grid refinement.
17+
- **SPH (Smoothed Particle Hydrodynamics)**: particle-based fluid model using kernel-weighted neighbors.
18+
- **Resolution**: smallest scale represented numerically.
19+
- **Initial conditions**: starting state that strongly constrains later outcomes.
20+
21+
## Policy
22+
23+
- English term is the source-of-truth key.
24+
- Korean and future locales map translations to that same key.

‎src/content/docs/en/index.mdx‎

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
---
2+
title: Home
3+
description: Beginner-first guide to astrophysical simulation codes.
4+
sidebar:
5+
label: Home
6+
order: 0
7+
---
8+
9+
# Start learning astrophysical simulation from zero.
10+
11+
This site introduces four widely discussed simulation codes and explains core concepts in a beginner-friendly order.
12+
13+
## Suggested learning path
14+
15+
1. Read [Basics](/en/basics/) first.
16+
2. Visit each code page: [Arepo](/en/codes/arepo/), [Enzo](/en/codes/enzo/), [Gadget](/en/codes/gadget/), [Gizmo](/en/codes/gizmo/).
17+
3. Use [Compare](/en/compare/) and [Glossary](/en/glossary/) to build context.
18+
19+
## Scope of this foundation release
20+
21+
- Locale support now: English and Korean
22+
- Content policy: English is source-of-truth, Korean follows as translation
23+
- Accuracy policy: keep technical claims tied to official docs, papers, and version notes
24+
25+
## Quick jump
26+
27+
- [Simulation Basics](/en/basics/)
28+
- [Code Comparison](/en/compare/)
29+
- [Glossary](/en/glossary/)

‎src/content/docs/ko/basics.mdx‎

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
---
2+
title: 기초
3+
description: 코드에 들어가기 전에 알아야 할 핵심 개념.
4+
sidebar:
5+
order: 1
6+
---
7+
8+
# 코드 보기 전에 먼저 익힐 개념
9+
10+
무엇을 계산하는지와 수치 방법의 트레이드오프를 이해하면 코드 문서 읽기가 쉬워집니다.
11+
12+
## 최소 개념 세트
13+
14+
- **유체역학 + 중력**: 천체물리 문제에서 함께 다루는 경우가 많습니다.
15+
- **이산화(Discretization)**: 연속 방정식을 셀/입자로 근사합니다.
16+
- **해상도(Resolution)**: 해상도 상승은 계산 비용 상승과 연결됩니다.
17+
- **시간적분(Time integration)**: 안정적 timestep 제어가 핵심입니다.
18+
19+
## 실전 학습 순서
20+
21+
1. 문제 목표를 정합니다 (은하 형성, 클러스터, 이상화 테스트 등).
22+
2. 방법 계열을 비교합니다 (mesh, AMR, particle).
23+
3. 가정을 점검합니다 (경계조건, 냉각, feedback).
24+
25+
## 다음 페이지
26+
27+
- [Arepo](/ko/codes/arepo/)
28+
- [Enzo](/ko/codes/enzo/)
29+
- [Gadget](/ko/codes/gadget/)
30+
- [Gizmo](/ko/codes/gizmo/)

0 commit comments

Comments
 (0)