Skip to content

Commit

Permalink
update the documentation.
Browse files Browse the repository at this point in the history
  • Loading branch information
Dongchen Zhang committed Aug 23, 2023
1 parent 026f329 commit dc613a3
Showing 1 changed file with 6 additions and 0 deletions.
6 changes: 6 additions & 0 deletions book_source/03_topical_pages/03_pecan_xml.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -750,13 +750,16 @@ The following tags can be used for state data assimilation. More detailed inform
```xml
<state.data.assimilation>
<process.variance>TRUE</process.variance>
<aqq.Init>1</aqq.Init>
<bqq.Init>1</bqq.Init>
<sample.parameters>FALSE</sample.parameters>
<adjustment>TRUE</adjustment>
<censored.data>FALSE</censored.data>
<FullYearNC>TRUE</FullYearNC>
<NC.Overwrite>FALSE</NC.Overwrite>
<NC.Prefix>sipnet.out</NC.Prefix>
<q.type>SINGLE</q.type>
<free.run>FALSE</free.run>
<by.site>FALSE</by.site>
<Localization.FUN>Local.support</Localization.FUN>
<scalef>1</scalef>
Expand Down Expand Up @@ -836,13 +839,16 @@ The following tags can be used for state data assimilation. More detailed inform
```

* **process.variance** : [optional] TRUE/FLASE flag for if process variance should be estimated (TRUE) or not (FALSE). If TRUE, a generalized ensemble filter will be used. If FALSE, an ensemble Kalman filter will be used. Default is FALSE.
* **aqq.Init** : [optional] The initial value of aqq used for estimate the Q distribution, the default value is 1.
* **bqq.Init** : [optional] The initial value of bqq used for estimate the Q distribution, the default value is 1.
* **sample.parameters** : [optional] TRUE/FLASE flag for if parameters should be sampled for each ensemble member or not. This allows for more spread in the intial conditions of the forecast.
* **adjustment** : [optional] Bool variable decide if you want to adjust analysis results by the likelihood.
* **censored.data** : [optional] Bool variable decide if you want to do MCMC sampling for the forecast ensemble space, the default is FALSE.
* **FullYearNC** : [optional] Bool variable decide if you want to generate the full-year netcdf file when there is a overlap in time, the default is TRUE.
* **NC.Overwrite** : [optional] Bool variable decide if you want to overwrite the previous netcdf file when there is a overlap in time, the default is FALSE.
* **NC.Prefix** : [optional] The prefix for the generation of the full-year netcdf file, the default is sipnet.out.
* **q.type** : [optional] The type of process variance that will be estimated, the default is SINGLE.
* **free.run** : [optional] If it's a free run without any observations, the default is FALSE.
* **by.site** : [optional] The flag, that is exclusively used by the `analysis_sda_block` function, decide if we want to consider the underlying networks between sites. The default is FALSE.
* **Localization.FUN** : [optional] The localization function name for the localization operation, the default is Local.support.
* **scalef** : [optional] The scale parameter used for the localization operation, the smaller the value is, the sites are more isolated.
Expand Down

0 comments on commit dc613a3

Please sign in to comment.