Skip to content

Commit 37eae59

Browse files
committed
update readme
1 parent 0558310 commit 37eae59

File tree

1 file changed

+1
-12
lines changed

1 file changed

+1
-12
lines changed

README.md

Lines changed: 1 addition & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -7,23 +7,12 @@ A flexible and efficient solver for the 1D Nonlinear Schrödinger Equation (NLSE
77

88
## Overview
99

10-
This package provides a comprehensive framework for solving the 1D NLSE:
10+
This package provides a numerical framework for solving the 1D NLSE:
1111

1212
$$i \frac{\partial \psi}{\partial t} + \frac{1}{2} \frac{\partial^2 \psi}{\partial x^2 } + |\psi|^2 \psi = 0,$$
1313

1414
where $\psi$ is the complex wave function.
1515

16-
## Features
17-
18-
- **Multiple Scenarios**: Single soliton, two-soliton collision, breather solutions, modulation instability
19-
- **Enhanced Numerical Stability**: DOP853 solver, adaptive time-stepping, conservation law monitoring
20-
- **High Performance**: Optional Numba JIT compilation for speed
21-
- **Flexible Configuration**: Support for both YAML and TXT configuration files
22-
- **Progress Tracking**: Real-time progress bars with tqdm
23-
- **Comprehensive Logging**: Detailed logs for each simulation
24-
- **Professional Visualization**: FiveThirtyEight-style animations
25-
- **Data Management**: NetCDF output format with institutional metadata
26-
- **Conservation Monitoring**: Real-time tracking of conserved quantities
2716

2817
## Installation
2918

0 commit comments

Comments
 (0)