PySDM icon indicating copy to clipboard operation
PySDM copied to clipboard

refactor Paraview code & parcel-model animations

Open olastrz opened this issue 4 months ago • 1 comments

olastrz avatar Oct 08 '25 12:10 olastrz

Codecov Report

:white_check_mark: All modified and coverable lines are covered by tests. :white_check_mark: Project coverage is 86.55%. Comparing base (64877ed) to head (125edbe). :warning: Report is 6 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #1725      +/-   ##
==========================================
+ Coverage   86.50%   86.55%   +0.04%     
==========================================
  Files         412      413       +1     
  Lines       10372    10455      +83     
==========================================
+ Hits         8972     9049      +77     
- Misses       1400     1406       +6     

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

:rocket: New features to boost your workflow:
  • :snowflake: Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

codecov[bot] avatar Oct 08 '25 13:10 codecov[bot]

@olastrz, kudos for the new visualisation!

Here is some feedback on the code:

  • [x] since we are creating a new examples subfolder, let's move the new notebook there and add badges pointing to it to the __init__.py file
  • [x] let's add an entry in the examples/docs/pysdm_examples_landing.md list of examples
  • [x] instead of the 4 "pylint disable:" comments, let's fix the issues reported by pylint (disable=protected-access seems to be the only inevitable one)
  • [x] since we are adding a new module to PySDM - the exporter, we need to cover it with a unit test
  • [x] the change of "mass_of_dry_air=44 * si.kg" to "mass_of_dry_air=66666 * si.kg," in the simulation.py files potentially influences other code in the Pyrcel example - if this setting is crucial, let's make it alterable from outside while keeping the original value as default
  • [x] there is a leftover print statement and c:\Users\strza\Desktop\PySDM\examples\PySDM_examples\Pyrcel\../../../PySDM/exporters/ output present in the commited notebook
  • [x] the paraview_simulation.py file name seems misleading as it does not perform any simulation
  • [x] the except subprocess.CalledProcessError as e: print("Error during script execution:") print("STDERR:", e.stderr) print("STDOUT:", e.stdout) block seems unneeded as without the except statement, the same would be printed anyhow?
  • [x] the sys.path.append(exporters_path) logic is not needed - we can do from PySDM.exporters import ...
  • [x] for the camera position settings, let's do max 4 significant digits (now we have figures like 1548.945972263949)
  • [x] let's remove any remaining code comments (and wherever these are needed to understand the code, let's include the relevant information in function or variable names)

slayoo avatar Nov 21 '25 23:11 slayoo

kudos @olastrz !

slayoo avatar Nov 29 '25 13:11 slayoo