ansys / ansys/pydpf-core

Implement Field versioning to track modifications and trigger necessary updates

Open
#562 1 comment 0 reactions 0 assignees View on GitHub
enhancement
Dominant language
Python
Stars
91
Forks
25
Avg merge
1d 8h
Merged PRs (30d)
41

Description

While solving an issue regarding the update of MeshedRegion.grid when MeshedRegion.set_coordinates is called, the need to associate a version number to fields seemed to make sense, because there is no way to intercept every potential data modification action which occurs on the data.
So for example, if someone were to modify the coordinates field's data directly without using the proper setter, that would not currently be detected. Same if an action were to modify it server-side. There would be no way to know the MeshedRegion.grid or any other object based on that data requires updating.

Contributor guide

Open the contributing guide

Research direction

Start by tracing MeshedRegion.grid and MeshedRegion.set_coordinates, then inspect how the coordinates field can be modified directly or server-side. Clarify where field versions must be stored and observed, and define done as detecting every supported modification so dependent objects such as MeshedRegion.grid can be updated.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
backend-api-design
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.