Generate case summaries based on aggregations. #270
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| @@ -16,8 +16,10 @@ | |||
| class Case(Document): | |||
| """Class for representing a case in Sumo""" | |||
|
|
|||
| def __init__(self, sumo: SumoClient, metadata: Dict, pit: Pit = None): | |||
| def __init__(self, sumo: SumoClient, metadata: Dict, summary: Dict, | |||
| @@ -16,8 +16,10 @@ | |||
| class Case(Document): | |||
| """Class for representing a case in Sumo""" | |||
|
|
|||
| def __init__(self, sumo: SumoClient, metadata: Dict, pit: Pit = None): | |||
| def __init__(self, sumo: SumoClient, metadata: Dict, summary: Dict, | |||
There was a problem hiding this comment.
The name summary may be confusing, as the term is quite established for some specific data produced by simulators. Other synonyms that can be considered?
|
Probably not a breaking change: the Case constructor is only called from CaseCollection.
… On 4 Dec 2023, at 09:26, Per Olav Eide Svendsen ***@***.***> wrote:
@perolavsvendsen commented on this pull request.
In src/fmu/sumo/explorer/objects/case.py <#270 (comment)>:
> @@ -16,8 +16,10 @@
class Case(Document):
"""Class for representing a case in Sumo"""
- def __init__(self, sumo: SumoClient, metadata: Dict, pit: Pit = None):
+ def __init__(self, sumo: SumoClient, metadata: Dict, summary: Dict,
Breaking change?
—
Reply to this email directly, view it on GitHub <#270 (review)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AAIDQOV3M5FUHJSSXZNXQFLYHWCK3AVCNFSM6AAAAABAFRTK72VHI2DSMVQWIX3LMV43YUDVNRWFEZLROVSXG5CSMV3GSZLXHMYTONRRHAZDQMRVGE>.
You are receiving this because you authored the thread.
|
|
“sommaire”?
… or “overview”, which is the term used in #256.
… On 4 Dec 2023, at 09:27, Per Olav Eide Svendsen ***@***.***> wrote:
@perolavsvendsen commented on this pull request.
In src/fmu/sumo/explorer/objects/case.py <#270 (comment)>:
> @@ -16,8 +16,10 @@
class Case(Document):
"""Class for representing a case in Sumo"""
- def __init__(self, sumo: SumoClient, metadata: Dict, pit: Pit = None):
+ def __init__(self, sumo: SumoClient, metadata: Dict, summary: Dict,
The name summary may be confusing, as the term is quite established for some specific data produced by simulators. Other synonyms that can be considered?
—
Reply to this email directly, view it on GitHub <#270 (review)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AAIDQOQOG4QM3CNUBH2QYPLYHWCOHAVCNFSM6AAAAABAFRTK72VHI2DSMVQWIX3LMV43YUDVNRWFEZLROVSXG5CSMV3GSZLXHMYTONRRHAZDSNZWGE>.
You are receiving this because you authored the thread.
|
I think "summary" is the most intuitive one, but I fear that this particular word is broken beyond repair and too closely associated with "summary-data". I believe we have used this term in this context already in the same code base... The only useful suggestions I could get from ChatGPT were:
|
|
I think I'll just go for "overview" - it has roughly the same meaning as summary, and is also what was suggested in the issue. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Done as part of the
_next_batchmethod of class DocumentCollection.