Skip to content

Commit 10dd8de

Browse files
committed
Update the docs
1 parent eae1fe4 commit 10dd8de

4 files changed

Lines changed: 16 additions & 46 deletions

File tree

docs/tutorials/dev_getting_started.rst

Lines changed: 4 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -642,24 +642,16 @@ climate index.
642642
## options related to producing time series plots, often to compare against
643643
## observations and previous runs
644644
645-
# start and end years for timeseries analysis. Use endYear = end to indicate
646-
# that the full range of the data should be used. If errorOnMissing = False,
647-
# the start and end year will be clipped to the valid range. Otherwise, out
648-
# of bounds values will lead to an error. In a "control" config file used in
649-
# a "main vs. control" analysis run, the range of years must be valid and
650-
# cannot include "end" because the original data may not be available.
645+
# start and end years for timeseries analysis. Out-of-bounds values will lead
646+
# to an error.
651647
startYear = 1
652648
endYear = 5
653649
654650
[index]
655651
## options related to producing nino index.
656652
657-
# start and end years for El Nino 3.4 analysis. Use endYear = end to indicate
658-
# that the full range of the data should be used. If errorOnMissing = False,
659-
# the start and end year will be clipped to the valid range. Otherwise, out
660-
# of bounds values will lead to an error. In a "control" config file used in
661-
# a "main vs. control" analysis run, the range of years must be valid and
662-
# cannot include "end" because the original data may not be available.
653+
# start and end years for El Nino 3.4 analysis. Out-of-bounds values will lead
654+
# to an error.
663655
startYear = 1
664656
endYear = 5
665657

docs/tutorials/getting_started.rst

Lines changed: 4 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -443,24 +443,16 @@ climate index.
443443
## options related to producing time series plots, often to compare against
444444
## observations and previous runs
445445
446-
# start and end years for timeseries analysis. Use endYear = end to indicate
447-
# that the full range of the data should be used. If errorOnMissing = False,
448-
# the start and end year will be clipped to the valid range. Otherwise, out
449-
# of bounds values will lead to an error. In a "control" config file used in
450-
# a "main vs. control" analysis run, the range of years must be valid and
451-
# cannot include "end" because the original data may not be available.
446+
# start and end years for timeseries analysis. Out-of-bounds values will lead
447+
# to an error.
452448
startYear = 1
453449
endYear = 5
454450
455451
[index]
456452
## options related to producing nino index.
457453
458-
# start and end years for El Nino 3.4 analysis. Use endYear = end to indicate
459-
# that the full range of the data should be used. If errorOnMissing = False,
460-
# the start and end year will be clipped to the valid range. Otherwise, out
461-
# of bounds values will lead to an error. In a "control" config file used in
462-
# a "main vs. control" analysis run, the range of years must be valid and
463-
# cannot include "end" because the original data may not be available.
454+
# start and end years for timeseries analysis. Out-of-bounds values will lead
455+
# to an error.
464456
startYear = 1
465457
endYear = 5
466458

docs/users_guide/config/index.rst

Lines changed: 4 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -13,22 +13,15 @@ determine the start and end years of climate indices (such as El Ni |n~| o
1313
[index]
1414
## options related to producing nino index.
1515

16-
# start and end years for El Nino 3.4 analysis. Use endYear = end to indicate
17-
# that the full range of the data should be used. If errorOnMissing = False,
18-
# the start and end year will be clipped to the valid range. Otherwise, out
19-
# of bounds values will lead to an error. In a "control" config file used in
20-
# a "main vs. control" analysis run, the range of years must be valid and
21-
# cannot include "end" because the original data may not be available.
16+
# start and end years for El Nino 3.4 analysis. Out-of-bounds values will lead
17+
# to an error.
2218
startYear = 1
23-
endYear = end
19+
endYear = 20
2420

2521
Start and End Year
2622
------------------
2723

2824
A custom config file should specify a start and end year for time axis.
29-
If ``errorOnMissing = False`` in the ``input`` section and the start or end
30-
year is beyond the range of the simulation, the range will be reduced to those
31-
dates with available data and a warning message will be displayed. If
32-
``errorOnMissing = True``, out of range year will produce an error.
25+
Out of range year will produce an error.
3326

3427

docs/users_guide/config/timeSeries.rst

Lines changed: 4 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -16,23 +16,16 @@ for anomalies::
1616
# only the anomaly over a later span of years is of interest.
1717
# anomalyRefYear = 249
1818

19-
# start and end years for timeseries analysis. Use endYear = end to indicate
20-
# that the full range of the data should be used. If errorOnMissing = False,
21-
# the start and end year will be clipped to the valid range. Otherwise, out
22-
# of bounds values will lead to an error. In a "control" config file used in
23-
# a "main vs. control" analysis run, the range of years must be valid and
24-
# cannot include "end" because the original data may not be available.
19+
# start and end years for timeseries analysis. Out-of-bounds values will lead
20+
# to an error.
2521
startYear = 1
26-
endYear = end
22+
endYear = 20
2723

2824
Start and End Year
2925
------------------
3026

3127
A custom config file should specify a start and end year for time series.
32-
If ``errorOnMissing = False`` in the ``input`` section and the start or end
33-
year is beyond the range of the simulation, the range will be reduced to those
34-
dates with available data and a warning message will be displayed. If
35-
``errorOnMissing = True``, out of range year will produce an error.
28+
Out of range year will produce an error.
3629

3730

3831
Anomaly Reference Year

0 commit comments

Comments
 (0)