Skip to content

Commit fd0c800

Browse files
committed
Update: documentation
1 parent 5c19a21 commit fd0c800

File tree

5 files changed

+33
-1
lines changed

5 files changed

+33
-1
lines changed

INSTALL.md

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -67,4 +67,18 @@ the `kaleidoscope` directory and type
6767

6868
pytest
6969

70-
The `pytest` output is printed to the console.
70+
The `pytest` output will be printed to the console and will read like, e.g.:
71+
72+
============================ test session starts =============================
73+
platform ...
74+
rootdir: Developer/github/kaleidoscope
75+
configfile: pyproject.toml
76+
testpaths: test
77+
plugins: ...
78+
collected 14 items
79+
80+
test/kaleidoscope/main/test_processor.py ..... [ 35%]
81+
test/kaleidoscope/test_generators.py . [ 42%]
82+
test/kaleidoscope/test_reader.py .... [ 71%]
83+
test/kaleidoscope/test_writer.py .... [100%]
84+
======================= 14 passed in 152.59s (0:02:32) =======================

README.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -117,3 +117,21 @@ otherwise. Warning and error messages are sent to the standard error stream.
117117
### Recovery operations
118118

119119
There are no recovery operations.
120+
121+
## Expected output
122+
123+
Kaleidoscope generates variants of source data which exhibit simulated errors.
124+
At present, only uncorrelated random errors are simulated. Normalized errors
125+
will have a mean value of zero and a standard deviation of unity, with statistical
126+
deviations implied by constraints on the error probability distribution and the
127+
(limited) number of variants generated.
128+
129+
![Map](/doc/map-mean-Sea%20surface%20temperature.png)
130+
![Map](/doc/map-std-Sea%20surface%20temperature.png)
131+
![Map](/doc/map-range-Sea%20surface%20temperature.png)
132+
133+
Examples above illustrate the mean, the standard deviation and the minimum-to-maximum
134+
range of normalized simulated errors for an ensemble of ten variants of global monthly
135+
sea surface temperature (January 2000). The standard deviation and range of normalized
136+
errors is reduced at the North Pole and in the Weddell and Ross Sea due to constraints
137+
imposed by the freezing point of seawater.
2.32 MB
Loading
2.24 MB
Loading
2.23 MB
Loading

0 commit comments

Comments
 (0)