Skip to content

Commit

Permalink
[docs] Add missing docstrings
Browse files Browse the repository at this point in the history
  • Loading branch information
giordano committed Nov 15, 2024
1 parent 2545a7e commit 8726f2d
Showing 1 changed file with 15 additions and 0 deletions.
15 changes: 15 additions & 0 deletions docs/src/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -118,6 +118,21 @@ ParticleDA.get_covariance_state_observation_given_previous_state
ParticleDA.get_covariance_observation_observation_given_previous_state
```

### Other function you may want to extend

```@docs
ParticleDA.get_state_indices_correlated_to_observations
ParticleDA.get_initial_state_mean!
ParticleDA.write_snapshot
ParticleDA.write_state
ParticleDA.get_covariance_initial_state
ParticleDA.init_filter
ParticleDA.sample_proposal_and_compute_log_weights!
ParticleDA.write_observation
ParticleDA.write_weights
ParticleDA.get_initial_state_mean
```

### Input parameters

You can store the input parameters in an YAML file with the following structure
Expand Down

0 comments on commit 8726f2d

Please sign in to comment.