|
1 |
| -# Software and Computing for Applied Physics Project |
| 1 | +# MCTRANSPORT Project |
2 | 2 | 
|
3 | 3 | 
|
4 | 4 |
|
5 | 5 | ## Installation
|
6 | 6 | It requires Python and git.
|
7 |
| -Tested on Python 3.10–3.12. |
| 7 | +Tested on Python 3.10-3.12. |
8 | 8 | ```bash
|
9 |
| -# (Optional) Create and activate a virtual environment |
| 9 | +# (Optional) Create and activate a virtual environment: |
10 | 10 | python -m venv .venv
|
11 |
| -# Windows (PowerShell) |
| 11 | +# Windows (PowerShell): |
12 | 12 | . .\.venv\Scripts\Activate.ps1
|
13 |
| -# macOS/Linux |
| 13 | +# macOS/Linux: |
14 | 14 | # source .venv/bin/activate
|
15 | 15 | ```
|
16 | 16 | After cloning the repository:
|
17 | 17 | ```bash
|
18 | 18 | cd <project-directory>
|
19 |
| -# Install the package and runtime dependencies |
| 19 | +# Install the package and runtime dependencies: |
20 | 20 | pip install .
|
21 | 21 | # Or install the editable version (this is also optional):
|
22 | 22 | # pip install -e .[dev]
|
@@ -95,7 +95,6 @@ The free path **`L`** follows an exponential distribution with mean **`λ`**:
|
95 | 95 | </p>
|
96 | 96 |
|
97 | 97 | where the mean and the variance are <img src="https://latex.codecogs.com/png.latex?\bg_black\mathbb{E}[L]=\lambda" /> and <img src="https://latex.codecogs.com/png.latex?\bg_black\mathrm{Var}[L]=\lambda^2" />.
|
98 |
| - |
99 | 98 | With the property:
|
100 | 99 |
|
101 | 100 | <p align="center">
|
@@ -245,7 +244,7 @@ mctransport absorption-only -N 50000 -d 1.5 -l 0.8 --seed 123 --terse --precisio
|
245 | 244 | # absorption-only,50000,1.5,0.8,123,0.15318
|
246 | 245 | ```
|
247 | 246 |
|
248 |
| -Important: directories for --output must already exist; the program does not attempt to create missing directories and will exit with error 3 if they do not exist. |
| 247 | +Important: directories for **`--output`** must already exist; the program does not attempt to create missing directories and will exit with error 3 if they do not exist. |
249 | 248 |
|
250 | 249 | ---
|
251 | 250 |
|
@@ -289,7 +288,7 @@ mctransport-graph
|
289 | 288 | # Example, all the parameters defined
|
290 | 289 | mctransport-graph --N 200000 --lam 1.5 --seed 7 --dmin 0 --dmax 6 --points 25 --outdir output_directory
|
291 | 290 | ```
|
292 |
| -This method builds an equally spaced grid of distances and creates **`d_vals`** as **`linspace(dmin, dmax, points)`**. |
| 291 | +This second method builds an equally spaced grid of distances and creates **`d_vals`** as **`np.linspace(dmin, dmax, points)`**. |
293 | 292 |
|
294 | 293 | The script produces two outputs:
|
295 | 294 | - CSV: **`results_absorption_sweep.csv`** with columns 'distance', 'T_mc', 'T_theory', 'SE';
|
|
0 commit comments