Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update about-section of readme #3442

Merged
merged 1 commit into from
May 27, 2022
Merged

Update about-section of readme #3442

merged 1 commit into from
May 27, 2022

Conversation

dafeda
Copy link
Contributor

@dafeda dafeda commented May 27, 2022

Issue
Resolves #my_issue

Approach
Short description of the approach

Pre review checklist

  • Added appropriate release note label
  • PR title captures the intent of the changes, and is fitting for release notes.
  • Commit history is consistent and clean, in line with the contribution guidelines.

Adding labels helps the maintainers when writing release notes. This is the list of release note labels.

README.md Outdated
ERT - Ensemble based Reservoir Tool - is designed for running
ensembles of dynamical models such as reservoir models,
in order to do sensitivity analysis and data assimilation.
Supports data assimilation using ES, ES-MDA and IES.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think we can type out ES, ES-MDA and IES

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fixed

README.md Outdated
Comment on lines 17 to 22
ERT - Ensemble based Reservoir Tool - is designed for running
ensembles of dynamical models such as reservoir models,
in order to do sensitivity analysis and data assimilation.
Supports data assimilation using the Ensemble Smoother (ES),
Ensemble Smoother with Multiple Data Assimilation (ES-MDA) and
Iterative Ensemble Smoother (IES).
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
ERT - Ensemble based Reservoir Tool - is designed for running
ensembles of dynamical models such as reservoir models,
in order to do sensitivity analysis and data assimilation.
Supports data assimilation using the Ensemble Smoother (ES),
Ensemble Smoother with Multiple Data Assimilation (ES-MDA) and
Iterative Ensemble Smoother (IES).
ERT - Ensemble based Reservoir Tool - is designed for running
ensembles of dynamical models such as reservoir models,
in order to do sensitivity analysis and data assimilation.
Supports data assimilation using the Ensemble Smoother (ES),
Ensemble Smoother with Multiple Data Assimilation (ES-MDA) and
Iterative Ensemble Smoother (IES) methods.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

or algorithms or something..

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't think that is necessary since a "Smoother" is a known method.
Hence a sentence like "Data assimilation using the Ensemble Smoother." is complete.

README.md Outdated
ERT - Ensemble based Reservoir Tool - is designed for running
ensembles of dynamical models such as reservoir models,
in order to do sensitivity analysis and data assimilation.
Supports data assimilation using the Ensemble Smoother (ES),
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"Supports" -> "It supports" ?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I propose "ERT supports" since "It" leads to the sentence being in the passive voice which I don't particularly like.

@codecov-commenter
Copy link

Codecov Report

Merging #3442 (570991e) into main (e662696) will increase coverage by 4.51%.
The diff coverage is n/a.

❗ Current head 570991e differs from pull request most recent head 44d0573. Consider uploading reports for the commit 44d0573 to get more accurate results

@@            Coverage Diff             @@
##             main    #3442      +/-   ##
==========================================
+ Coverage   60.81%   65.33%   +4.51%     
==========================================
  Files         314      603     +289     
  Lines       31386    47736   +16350     
  Branches     4221     4221              
==========================================
+ Hits        19088    31186   +12098     
- Misses      10781    15190    +4409     
+ Partials     1517     1360     -157     
Impacted Files Coverage Δ
libres/lib/enkf/field.cpp 0.70% <0.00%> (ø)
libres/lib/config/conf.cpp 61.06% <0.00%> (ø)
libres/lib/enkf/gen_kw.cpp 59.61% <0.00%> (ø)
libres/lib/python/init.cpp 22.58% <0.00%> (ø)
libres/lib/enkf/surface.cpp 2.63% <0.00%> (ø)
libres/lib/rms/rms_file.cpp 0.00% <0.00%> (ø)
libres/lib/enkf/time_map.cpp 43.46% <0.00%> (ø)
libres/lib/enkf/block_obs.cpp 42.03% <0.00%> (ø)
libres/lib/enkf/container.cpp 7.69% <0.00%> (ø)
libres/lib/enkf/enkf_main.cpp 44.03% <0.00%> (ø)
... and 336 more

📣 Codecov can now indicate which changes are the most critical in Pull Requests. Learn more

@dafeda dafeda merged commit 38ccd89 into equinor:main May 27, 2022
@dafeda dafeda deleted the about_readme branch May 27, 2022 16:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants