Skip to content

Commit 0612f37

Browse files
committed
Polish reproducibility package
1 parent b995e02 commit 0612f37

36 files changed

Lines changed: 263 additions & 63 deletions

.gitignore

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@ __pycache__/
33
.pytest_cache/
44
.mypy_cache/
55
.ruff_cache/
6+
.ipynb_checkpoints/
67
.venv/
78
venv/
89
env/
@@ -21,7 +22,6 @@ Thumbs.db
2122
*.synctex.gz
2223
*.tex
2324
results_macros.tex
24-
build/
2525
submission_package/
2626
internal_notes/
2727
Brandon_Deonarine_SSF_LaTeX_Preprint*

CITATION.cff

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,18 @@
11
cff-version: 1.2.0
2-
message: "If you use this Split-Step Fourier Schrodinger propagation package, please cite the associated manuscript."
3-
title: "Discrete Unitarity and Reproducible Diagnostics for Split-Step Fourier Schrodinger Propagation"
2+
message: "If you use this Split-Step Fourier Schrödinger propagation package, please cite this repository."
3+
title: "Finite-Dimensional Unitarity and Reproducible Diagnostics for Split-Step Fourier Schrödinger Propagation"
44
type: software
55
authors:
66
- family-names: Deonarine
77
given-names: Brandon
8-
abstract: "Reproducibility package for a journal-style manuscript on finite-dimensional discrete unitarity and diagnostic benchmarks for one-dimensional split-step Fourier Schrodinger propagation."
8+
abstract: "Reproducibility package for finite-dimensional unitarity and diagnostic benchmarks for one-dimensional split-step Fourier Schrödinger propagation."
99
keywords:
1010
- split-step Fourier
11-
- Schrodinger equation
11+
- Schrödinger equation
1212
- Strang splitting
1313
- spectral methods
1414
- reproducible diagnostics
1515
license: MIT
1616
repository-code: "https://github.com/M3RCU3Y/SSF"
1717
date-released: "2026-05-22"
18-
version: "journal-submission-prep"
18+
version: "0.1.0"

LICENSE

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,12 @@
11
MIT License
22

3-
Copyright (c) 2026 Brandon Deonarine
3+
Copyright (c) 2026 Brandon Deonarine
4+
5+
This license applies to the Split-Step Fourier Schrodinger propagation source
6+
package, including the figure-generation code, regression tests, generated
7+
data, and documentation in this repository. The manuscript text and figures
8+
should be reused according to the policy of the final publisher or preprint
9+
server when the paper is submitted or archived.
410

511
Permission is hereby granted, free of charge, to any person obtaining a copy
612
of this software and associated documentation files (the "Software"), to deal

README.md

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Split-Step Fourier Diagnostics
22

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

55
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.
66

@@ -21,6 +21,7 @@ The repository contains:
2121
├── assets/readme/ PNG previews used in this README
2222
├── .github/workflows/tests.yml CI smoke checks
2323
├── requirements.txt
24+
├── requirements-lock.txt
2425
└── environment.yml
2526
```
2627

@@ -115,6 +116,12 @@ python -m venv .venv
115116
python -m pip install -r requirements.txt
116117
```
117118

119+
For an exact local environment snapshot, use `requirements-lock.txt`.
120+
121+
```bash
122+
python -m pip install -r requirements-lock.txt
123+
```
124+
118125
Using `conda`:
119126

120127
```bash
@@ -183,4 +190,4 @@ The experiments use dimensionless units and periodic grids. Boundary-tail diagno
183190

184191
## Citation
185192

186-
If you use the code or generated diagnostics, cite this repository and the accompanying manuscript. Citation metadata is provided in `CITATION.cff`.
193+
If you use the code or generated diagnostics, cite this repository. Citation metadata is provided in `CITATION.cff`.

assets/readme/barrier-heatmap.png

30.9 KB
Loading

assets/readme/free-heatmap.png

28.6 KB
Loading

assets/readme/harmonic-center.png

38.3 KB
Loading
36.3 KB
Loading

assets/readme/time-convergence.png

62 KB
Loading

assets/readme/unitarity-defect.png

26.4 KB
Loading

0 commit comments

Comments
 (0)