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.

Sign up for GitHub

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

Jump to bottom

Scenario documentation #280

Merged
merged 34 commits into from
Apr 27, 2023
Merged

Scenario documentation #280

merged 34 commits into from
Apr 27, 2023

Conversation

calderinisystemorph
Copy link
Contributor

No description provided.

@dcolleoni dcolleoni added documentation Improvements or additions to documentation scenario related to scenario labels Apr 24, 2023
@dcolleoni dcolleoni added this to the v1.3.0 milestone Apr 24, 2023
@dcolleoni
Copy link
Contributor

dcolleoni commented Apr 24, 2023 •
edited
Loading

In general, I think we need to provide more information.
Ex.

  1. can a user add new scenarios
  2. can many files be imported for the same scenario (what is our recommendation)
  3. which data need to be imported for each scenario (is not enough to mention the relaxed query - add simple examples to describe what happens)
  4. which recalculation occur in which cases (reimport of BE CF, reimport of SCE CF, reimport of ACT,YC,... BE or SCE)
  5. in which cases it make sense to import 0 values and why
  6. other?

@calderinisystemorph
Copy link
Contributor Author

calderinisystemorph commented Apr 25, 2023 •
edited
Loading

1 can a user add new scenarios => discussed in Datamodel / Scenario
2 can many files be imported for the same scenario (what is our recommendation) => discussed in Datamodel / Scenario
3 which data need to be imported for each scenario (is not enough to mention the relaxed query - add simple examples to describe what happens) => discussed in Importer / Scenario Implementation

@calderinisystemorph calderinisystemorph marked this pull request as ready for review April 26, 2023 14:24
@dcolleoni dcolleoni merged commit eae687a into develop Apr 27, 2023
@dcolleoni dcolleoni deleted the Scenario_documentation branch April 27, 2023 22:16
@dcolleoni dcolleoni linked an issue Apr 27, 2023 that may be closed by this pull request
Produce Documentation around Scenario #243
Closed
tkukuljan
tkukuljan reviewed May 8, 2023
View reviewed changes
ifrs17/DataModel/DataStructure.ipynb
"\n### Dependecy with Best Estimate scenario: across periods",
"\n",
"\nWhen a stress scenario is imported for a period $P$ and a previous period $P-1$ is available, the End of Period values ($P-1$) of the Best Estimate scenario is considered as Beginning of Period ($P$) for the stressed and no-stress scenarios. This implies that:",
"\n1. scenarios can be occasionally not be calculated without impacting their calculation in future periods,",
Copy link
Contributor

Choose a reason for hiding this comment

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

typo

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@tkukuljan tkukuljan tkukuljan left review comments

@dcolleoni dcolleoni dcolleoni approved these changes

Assignees

@calderinisystemorph calderinisystemorph

Labels
documentation Improvements or additions to documentation scenario related to scenario
Projects
IFRS17 Calculation Engine
Status: ✅ Done
Milestone
v1.3.0
Development

Successfully merging this pull request may close these issues.

Produce Documentation around Scenario
3 participants
@calderinisystemorph @dcolleoni @tkukuljan