search

CliMA / EnsembleKalmanProcesses.jl

Implements Optimization and approximate uncertainty quantification algorithms, Ensemble Kalman Inversion, and Ensemble Kalman Processes.
https://clima.github.io/EnsembleKalmanProcesses.jl/dev
Apache License 2.0
80 stars 18 forks source link

A few potential README improvements #408

Open glwagner opened 1 month ago

glwagner commented 1 month ago
  1. Move the "citing us" to the bottom of the README

Because people don't need to cite until they actually start using the code! Also, add a link to the JOSS. The README just says "cite our article" but doesn't give a link.

  1. Add a code snippet illustrating usage

This could be part of the "getting started" section. It really helps ground the information that we receive --- what are we trying to do here? --- otherwise the flow / decision charts can be disorienting if this is the very first time you've seen the package.

Hopefully it can be quite short, eg 20 lines or less.

odunbar commented 2 weeks ago

Hi @glwagner thanks for the comment, I'm just back off vacation, and will look at addressing these soon!