Skip to content

Commit c297e3d

Browse files
Update readme for flow/brevity
1 parent 91a359c commit c297e3d

File tree

1 file changed

+8
-16
lines changed

1 file changed

+8
-16
lines changed

README.md

Lines changed: 8 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -12,24 +12,16 @@ Streamfall leverages the Julia language and ecosystem to provide:
1212
- Support for modelling and assessment of interacting systems
1313
- A wide range of performance metrics
1414

15-
This package includes implementations of the following:
16-
- GR4J
17-
- HyMod
18-
- IHACRES
19-
- SIMHYD
20-
2115
Performance is expected to be similar to implementations in C and Fortran.
2216

23-
Naive timings (using `@time`) for an example dataset spanning 1963-07-05 - 2014-12-31 (18808 days, approximately 51.5 years)
17+
This package includes implementations of the following
18+
(with naive timings using the `@time` macro):
19+
- GR4J [0.015274 seconds (224.75 k allocations: 5.584 MiB)]
20+
- HyMod [0.016502 seconds (469.25 k allocations: 12.902 MiB)]
21+
- IHACRES [0.021734 seconds (675.63 k allocations: 17.773 MiB)]
22+
- SIMHYD [0.022818 seconds (600.39 k allocations: 16.768 MiB)]
2423

25-
- SimpleHyModNode \
26-
0.016502 seconds (469.25 k allocations: 12.902 MiB)
27-
- GR4JNode \
28-
0.015274 seconds (224.75 k allocations: 5.584 MiB)
29-
- SIMHYDNode \
30-
0.022818 seconds (600.39 k allocations: 16.768 MiB)
31-
- IHACRESBilinearNode \
32-
0.021734 seconds (675.63 k allocations: 17.773 MiB)
24+
Timings were taken using an example dataset spanning 1963-07-05 - 2014-12-31 (18808 days, approximately 51.5 years)
3325

3426
The IHACRES rainfall-runoff model was previously implemented with [ihacres_nim](https://github.com/ConnectedSystems/ihacres_nim) but has since been ported to pure Julia.
3527

@@ -43,7 +35,7 @@ Streamfall is now registered! The latest release version can be installed with:
4335
] add Streamfall
4436
```
4537

46-
or the latest development version from GitHub with `dev` () or `add`:
38+
or the latest development version from GitHub with `dev` or `add`:
4739

4840
```julia
4941
# Editable install

0 commit comments

Comments
 (0)