Skip to content

Commit 8a8f825

Browse files
committed
✏️ Update README
1 parent c506a94 commit 8a8f825

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ The output will be multi-dimensional arrays, which may be useful for parameter s
1515
## Features
1616

1717
- **Grid calculation:** ndRADEX has a simple `run()` function, where all parameters of RADEX can be griddable (i.e., they can be list-like with length of more than one).
18-
- **Builtin RADEX:** ndRADEX provides builtin RADEX binaries in the package, which are automatically built during the package installation. You don't need any additional setups.
18+
- **Builtin RADEX:** ndRADEX provides builtin RADEX binaries in the package, which are automatically downloaded and built during the package installation. You don't need any additional setups.
1919
- **Multiprocessing:** ndRADEX supports multiprocessing RADEX run by default. At least twice speedup is expected compared to single processing.
2020
- **Handy I/O:** The output of ndRADEX is a [xarray]'s Dataset, a standard multi-dimensional data structure as well as [pandas]. You can handle it in the same manner as NumPy and pandas (i.e., element-wise operation, save/load data, plotting, etc).
2121

@@ -52,9 +52,9 @@ For example, to get RADEX results of CO(1-0) with kinetic temperature of 100 K,
5252
```
5353

5454
where `'co'` is a name of [LAMDA] datafile without extension (.dat), and `'1-0'` is a name of transition.
55-
All available values are listed in [List of available LAMDA datafiles and transitions](https://github.com/astropenguin/ndradex/wiki/List-of-available-LAMDA-datafiles-and-transitions).
55+
The available values are listed in [List of available LAMDA datafiles and transitions](https://github.com/astropenguin/ndradex/wiki/List-of-available-LAMDA-datafiles-and-transitions).
5656
Note that you don't need to any download datafiles:
57-
ndRADEX automatically does this.
57+
ndRADEX automatically manage this.
5858

5959
In this case, other parameters like line width, background temperature are default values defined in the function.
6060
The geometry of escape probability is uniform (`'uni'`) by default.
@@ -106,7 +106,7 @@ As a natural extension, you can run grid RADEX calculation like:
106106
There are 13 parameters which can be griddable:
107107
`QN_ul` (transition name), `T_kin` (kinetic temeperature), `N_mol` (column density), `n_H2` (H2 density), `n_pH2` (para-H2 density), `n_oH2` (ortho-H2 density), `n_e` (electron density), `n_H` (atomic hydrogen density), `n_He` (Helium density), `n_Hp` (ionized hydrogen density), `T_bg` (background temperature), `dv` (line width), and `geom` (photon escape geometry).
108108

109-
The output is a [xarray]'s Dataset with three dimensions of (`QN_ul`, `T_kin`, `n_H2`):
109+
The output of this example is a [xarray]'s Dataset with three dimensions of (`QN_ul`, `T_kin`, `n_H2`):
110110

111111
```python
112112
>>> print(ds)

0 commit comments

Comments
 (0)