Skip to content

Commit 5c6bb63

Browse files
committed
docs(readme): change Title; tiny polish
1 parent 37ff3d0 commit 5c6bb63

File tree

1 file changed

+8
-9
lines changed

1 file changed

+8
-9
lines changed

README.md

Lines changed: 8 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,22 @@
1-
# Software and Computing for Applied Physics Project
1+
# MCTRANSPORT Project
22
![License: MIT](https://img.shields.io/badge/license-MIT-green)
33
![Coverage](https://img.shields.io/badge/coverage-100%25-brightgreen)
44

55
## Installation
66
It requires Python and git.
7-
Tested on Python 3.103.12.
7+
Tested on Python 3.10-3.12.
88
```bash
9-
# (Optional) Create and activate a virtual environment
9+
# (Optional) Create and activate a virtual environment:
1010
python -m venv .venv
11-
# Windows (PowerShell)
11+
# Windows (PowerShell):
1212
. .\.venv\Scripts\Activate.ps1
13-
# macOS/Linux
13+
# macOS/Linux:
1414
# source .venv/bin/activate
1515
```
1616
After cloning the repository:
1717
```bash
1818
cd <project-directory>
19-
# Install the package and runtime dependencies
19+
# Install the package and runtime dependencies:
2020
pip install .
2121
# Or install the editable version (this is also optional):
2222
# pip install -e .[dev]
@@ -95,7 +95,6 @@ The free path **`L`** follows an exponential distribution with mean **`λ`**:
9595
</p>
9696

9797
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-
9998
With the property:
10099

101100
<p align="center">
@@ -245,7 +244,7 @@ mctransport absorption-only -N 50000 -d 1.5 -l 0.8 --seed 123 --terse --precisio
245244
# absorption-only,50000,1.5,0.8,123,0.15318
246245
```
247246

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.
249248

250249
---
251250

@@ -289,7 +288,7 @@ mctransport-graph
289288
# Example, all the parameters defined
290289
mctransport-graph --N 200000 --lam 1.5 --seed 7 --dmin 0 --dmax 6 --points 25 --outdir output_directory
291290
```
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)`**.
293292

294293
The script produces two outputs:
295294
- CSV: **`results_absorption_sweep.csv`** with columns 'distance', 'T_mc', 'T_theory', 'SE';

0 commit comments

Comments
 (0)