equinor / flownet

FlowNet - Data-Driven Reservoir Predictions
GNU General Public License v3.0
63 stars 29 forks source link

Documentation #406

Closed olwijn closed 3 years ago

olwijn commented 3 years ago

We need a fully-detailed documentation of all configuration file keywords and options in order to expose all functionality to the users and to be able to test it properly. For each keyword the documentation should clarify if it is required or optional, what default values are, how it interacts with other keywords, and it should provide examples of usage. Next to such a reference manual it would be good to have a technical reference including descriptions of algorithms and best practices.