Skip to content

Commit 752a2f0

Browse files
added directory structure
1 parent 45e8fe9 commit 752a2f0

1 file changed

Lines changed: 15 additions & 3 deletions

File tree

README.md

Lines changed: 15 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,18 @@ To assist readers in connecting the book material with the Python implementation
2626

2727
**Enhancement:** Unlike the original code provided on the disc with the book, this Python version includes integrated plotting routines to visualize key outputs immediately.
2828

29+
---
30+
31+
## 📂 Project Structure
32+
33+
```text
34+
bookCodePython/
35+
├── examples/ # Textbook example scripts organized by chapter
36+
├── src/ # Core propagation source code
37+
├── requirements.txt # Optional: Python dependencies
38+
├── LICENSE
39+
└── README.md
40+
```
2941

3042
---
3143

@@ -43,14 +55,14 @@ pip install numpy matplotlib scipy
4355

4456
Clone the repository and add the root directory to your PYTHONPATH, or simply run the examples from the root:
4557

46-
```
58+
```bash
4759
git clone https://github.com/jdschmidt-opticalscientist/bookCodePython.git
4860
cd bookCodePython
4961
```
5062

5163
### 3. Run an Example
5264

53-
```
65+
```bash
5466
python examples/Chapter9/pt_source_atmos_setup.py
5567
```
5668

@@ -64,6 +76,6 @@ Note: This license applies specifically to this Python translation. The original
6476

6577
## Development Quality
6678

67-
![Python CI](https://github.com/jdschmidt-opticalscientist/bookcodePython/actions/workflows/main.yml/badge.svg?branch=main)
79+
![Python CI](https://github.com/jdschmidt-opticalscientist/bookCodePython/actions/workflows/main.yml/badge.svg?branch=main)
6880

6981
We use GitHub Actions to ensure code quality through automated linting and unit testing.

0 commit comments

Comments
 (0)