Skip to content

Commit d2a1b55

Browse files
committed
Polish public repository metadata docs
1 parent 0612f37 commit d2a1b55

3 files changed

Lines changed: 8 additions & 12 deletions

File tree

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
Numerical experiments for a one-dimensional split-step Fourier solver for the time-dependent Schrödinger equation.
44

5-
This repo is intentionally just the reproducibility side: Python code, generated data, regression tests, and result figures. It does not include the paper source, LaTeX build files, or private submission notes.
5+
This repo is intentionally just the reproducibility side: Python code, generated data, regression tests, and result figures. It does not include paper source files, LaTeX build files, or submission notes.
66

77
![Diagnostic workflow](assets/readme/workflow.svg)
88

@@ -157,7 +157,7 @@ The full run refreshes:
157157
- `data/time_convergence.csv`
158158
- `data/spatial_convergence.csv`
159159

160-
The script does not write manuscript helper TeX files by default. There is a `--write-tex` switch for private manuscript workflows, but this repository is meant to stay focused on code and inspectable numerical outputs.
160+
The script does not write TeX helper files by default. There is a `--write-tex` switch for local article-preparation workflows, but this repository is meant to stay focused on code and inspectable numerical outputs.
161161

162162
## Tests
163163

data/README.md

Lines changed: 3 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -2,19 +2,15 @@
22

33
This directory is generated by:
44

5-
```powershell
6-
python scripts\generate_figures.py --root .
5+
```bash
6+
python generate_figures.py --root .
77
```
88

99
Important files:
1010

1111
- `results_summary.json`: raw numerical diagnostics and package-version metadata.
1212
- `results_summary.txt`: plain-text diagnostic summary.
13-
- `parameter_table.tex`: generated LaTeX parameter table.
14-
- `diagnostic_table.tex`: generated LaTeX diagnostic table.
15-
- `method_comparison_table.tex`: generated LaTeX method-comparison table.
16-
- `precision_table.tex`: generated LaTeX precision-sensitivity table.
1713
- `time_convergence.csv`: time-step convergence data.
1814
- `spatial_convergence.csv`: grid-refinement data.
1915

20-
The manuscript uses rounded values from the generated TeX tables and `manuscript/results_macros.tex`. The JSON file is the audit trail for exact values.
16+
The JSON file is the audit trail for exact values. Use `--write-tex` only when a local article-preparation workflow needs helper tables.

figures/README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,8 @@
22

33
This directory contains vector PDF figures generated by:
44

5-
```powershell
6-
python scripts\generate_figures.py --root .
5+
```bash
6+
python generate_figures.py --root .
77
```
88

9-
The figures are derived from deterministic numerical experiments in `scripts/generate_figures.py`. They should be regenerated together with `data/results_summary.json` and `manuscript/results_macros.tex` whenever the diagnostics or parameters change.
9+
The figures are derived from deterministic numerical experiments in `generate_figures.py`. Regenerate them together with `data/results_summary.json` whenever diagnostics or parameters change.

0 commit comments

Comments
 (0)