Skip to content

Commit d0de08e

Browse files
committed
update readme and prepare release 1.2.3
1 parent d45f8b2 commit d0de08e

File tree

2 files changed

+49
-2
lines changed

2 files changed

+49
-2
lines changed

CHANGELOG.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
1212
### Changed
1313

1414

15-
## [v1.2.1]
15+
## [v1.2.3]
1616
### Added
1717

1818
- implement a new diagonalisation method in DORT to avoid numerical instabilities, especially in active mode. It can be activated with rtsolver_options=dict(diagonalization_method="shur") in make_model. If good results are reported, this may become the default option as it seems as fast as the direct, origianl, eigenvalue solver.

README.md

Lines changed: 48 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,53 @@ with examples in the ['smrt-model' github organization](https://github.com/smrt-
99

1010
If you want to try without installing anything on your computer, use free mybinder.org notenooks: [![Binder](https://mybinder.org/badge.svg)](https://mybinder.org/v2/gh/smrt-model/smrt/master?filepath=examples/iba_onelayer.ipynb)
1111

12+
Quick Installation
13+
--------------------
14+
15+
To install the latest stable release:
16+
17+
```console
18+
pip install smrt
19+
```
20+
21+
Alternatively, the latest developments are available using:
22+
23+
```console
24+
pip install git+https://github.com/smrt-model/smrt.git
25+
```
26+
27+
or by ['manual installation'](https://smrt-model.science/getstarted.html).
28+
29+
30+
A simple example
31+
--------------------
32+
33+
An example to calculate the brightness temperature from a one-layer snowpack.
34+
35+
```python
36+
37+
from smrt import make_snowpack, sensor_list, make_model
38+
39+
# create a snowpack
40+
snowpack = make_snowpack(thickness=10., # snowpack depth in m
41+
microstructure_model="sticky_hard_spheres",
42+
density=320.0, # density in kg/m3
43+
temperature=260, # temperature in Kelvin
44+
radius=100e-6) # scatterers raidus in m
45+
46+
# create the sensor (AMSRE, channel 37 GHz vertical polarization)
47+
radiometer = sensor_list.amsre('37V')
48+
49+
# create the model including the scattering model (IBA) and the radiative transfer solver (DORT)
50+
m = make_model("iba", "dort")
51+
52+
# run the model
53+
result = m.run(radiometer, snowpack)
54+
55+
print(result.TbV())
56+
57+
```
58+
1259

1360
License information
1461
--------------------
@@ -29,4 +76,4 @@ Other contributions
2976
- Marion Leduc-Leballeur
3077
- Mai Winstrup
3178
- Carlo Marin
32-
79+
- Justin Murfitt

0 commit comments

Comments
 (0)