Skip reality checks during translation

rogersamso commented 1 year ago

Description

Reality checks may be included in Vensim models, which are NOT executed during simulation.

Currently, PySD is not able to parse these expressions, which have the following form:

name :THE CONDITION: condition :IMPLIES: consequence
name :TEST INPUT: variable = expr

With this PR, we prevent PySD from crashing when it finds these expressions.

Reality checks will not be included in the translated model, as they may be run using currently existing PySD functionality.

Type of change

Bug fix (non-breaking change which fixes an issue)
New feature (non-breaking change which adds functionality)

PR verification (to be filled by reviewers)

[x] The code follows the PEP 8 style
[x] The new code has been tested properly for all the possible cases
[x] The overall coverage has not dropped and other features have not been broken.
[x] If new features have been added, they have been properly documented
[x] docs/whats_new.rst has been updated
[x] PySD version has been updated

enekomartinmartinez commented 1 year ago

Hi @rogersamso thank you for opening the PR

Could you please add the # pragma: no cover in the new str methods to avoid counting them for coverage?

Could you also move the new test model to the test-models repo and include it there with the canonical output when running it with Vensim ( in the regular way, not using reality checks)?

enekomartinmartinez commented 1 year ago

@rogersamso can you please create a new What's New section in documentation with the new features? and also update package version to 3.9.0?

rogersamso commented 1 year ago

@enekomartinmartinez I think this one is ready. I will now add more tests for #390. Will you want to make #390 v3.9.1? Or what's your plan?

enekomartinmartinez commented 1 year ago

Hi, thanks @rogersamso No, the idea is to merge both in dev-3.9.0 and be all the new features part of the new release.

As soon as I merge it in the dev branch I would ask you to merge that branch to the other branch where you are working and update the what's new there.

enekomartinmartinez commented 1 year ago

@rogersamso I have made some small fixes, as soon as the tests pass I will merge it! :)

SDXorg / pysd