Revert "Revert "IO for ovf and vtk""

[samjrholt]

Reverts ubermag/discretisedfield#486

[github-actions[bot]]

PR Analysis

• 🎯 Main theme: Adding dimensionality checks for OVF and VTK file conversions

• 📝 PR summary: This PR reintroduces changes that were previously reverted, adding checks to ensure that OVF and VTK file conversions only occur for 3-dimensional fields. It also includes tests for these new checks.

• 📌 Type of PR: Bug fix

• 🧪 Relevant tests added: Yes

• ⏱️ Estimated effort to review [1-5]: 2 The PR is relatively straightforward, adding a few lines of code and corresponding tests. However, it requires knowledge of the project and the specific file formats to fully understand the changes.

• 🔒 Security concerns: No security concerns found

  PR Feedback

• 💡 General suggestions: The changes in this PR are clear and well-implemented. The addition of tests for the new checks is particularly good. However, it would be beneficial to add comments explaining why these checks are necessary, for the benefit of future contributors.

• 🤖 Code feedback:

  • relevant file: discretisedfield/field.py suggestion: Consider adding a comment explaining why the dimensionality check is necessary for VTK conversion. [medium] relevant line: "+ if self.mesh.region.ndim != 3:"

  • relevant file: discretisedfield/io/ovf.py suggestion: Similar to the previous suggestion, consider adding a comment explaining why the dimensionality check is necessary for OVF conversion. [medium] relevant line: "+ if self.mesh.region.ndim != 3:"

How to use

To invoke the PR-Agent, add a comment using one of the following commands: /review [-i]: Request a review of your Pull Request. For an incremental review, which only considers changes since the last review, include the '-i' option. /describe: Modify the PR title and description based on the contents of the PR. /improve [--extended]: Suggest improvements to the code in the PR. Extended mode employs several calls, and provides a more thorough feedback. /ask \<QUESTION>: Pose a question about the PR. /update_changelog: Update the changelog based on the PR's contents.

To edit any configuration parameter from configuration.toml, add --config_path=new_value For example: /review --pr_reviewer.extra_instructions="focus on the file: ..." To list the possible configuration parameters, use the /config command.