feat: read OVF meshunit and use in region.units

[lang-m]

Closes #316

[github-actions[bot]]

PR Analysis

• 🎯 Main theme: Implementing the feature to read OVF meshunit and use it in region.units

• 📝 PR summary: This PR introduces the ability to read the OVF meshunit and use it in region.units. It modifies the _from_ovf function in ovf.py and the test_write_read_ovf function in test_field.py to accommodate this feature.

• 📌 Type of PR: Enhancement

• 🧪 Relevant tests added: Yes

• ⏱️ Estimated effort to review [1-5]: 2 The PR is relatively small and straightforward, with clear changes in the code. However, it requires some knowledge about the project and the OVF file format to review.

• 🔒 Security concerns: No security concerns found

  PR Feedback

• 💡 General suggestions: The PR is well-structured and the changes are clear. It would be helpful to add some comments in the code to explain the new changes, especially for those who are not familiar with the OVF file format.

• 🤖 Code feedback:

  • relevant file: discretisedfield/io/ovf.py suggestion: Consider handling the case where the "meshunit" key is not present in the header. This could be done by using the get method with a default value. [important] relevant line: units = [header["meshunit"]] * 3

  • relevant file: discretisedfield/tests/test_field.py suggestion: It would be good to add a separate test case for the new feature, instead of modifying the existing one. This way, it would be easier to isolate issues if the test fails. [medium] relevant line: assert f_read.mesh.region.units == units

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.

[codecov-commenter]

Codecov Report

Patch coverage: 100.00% and no project coverage change.

Comparison is base (12b26c7) 93.38% compared to head (33b0514) 93.39%. Report is 2 commits behind head on master.

:exclamation: Your organization needs to install the Codecov GitHub app to enable full functionality.

Additional details and impacted files

```diff @@ Coverage Diff @@ ## master #485 +/- ## ======================================= Coverage 93.38% 93.39% ======================================= Files 28 28 Lines 3040 3041 +1 ======================================= + Hits 2839 2840 +1 Misses 201 201 ``` | [Files Changed](https://app.codecov.io/gh/ubermag/discretisedfield/pull/485?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=ubermag) | Coverage Δ | | |---|---|---| | [discretisedfield/io/ovf.py](https://app.codecov.io/gh/ubermag/discretisedfield/pull/485?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=ubermag#diff-ZGlzY3JldGlzZWRmaWVsZC9pby9vdmYucHk=) | `98.26% <100.00%> (+0.01%)` | :arrow_up: |

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