Add to_xarray as field method #123
Conversation
to_xarray returns field values as xarray.DataArray
|
Please do ignore the failing |
Codecov Report
@@ Coverage Diff @@
## master #123 +/- ##
==========================================
+ Coverage 95.46% 95.58% +0.11%
==========================================
Files 20 20
Lines 1986 2038 +52
==========================================
+ Hits 1896 1948 +52
Misses 90 90
Continue to review full report at Codecov.
|
Check `field.components` is not `None` before assigning it as `comp` co-ordinate values. Assigning `None` as a dimention co-ordinate throws an error.
|
This looks good. Do we have tests for this method yet? If not, we need one. Martin or I can help to suggest some. |
No, I have not added the tests yet. Yes, it's a good idea to discuss them! |
It is possible to create mesh where attributes donot have `unit` key which ultimately breaks to_xarray function
for more information, see https://pre-commit.ci
… into field-to-xarray
There was a problem hiding this comment.
This looks good to me - great work! We can further simplify this code when @lang-m finishes implementing midpoints and vertices :)
- Remove cells showing raised exceptions from `to_xarray` and `from_xarray` for better readability. - Add `print()` to display `xarray.DataArray` as the html representation gives `pytest` errors with nbval.
To avoid problems with nbval all cells that contain xarray html output are tagged with nbval-ignore-output. That way we do not compare the actual html representation (which we don't need to) but we would still notice when the cell execution fails.
There was a problem hiding this comment.
The documentation looks good to me, it is very readable. I've removed the print for the xarray DataArrays to get the nicer-looking html representation and tagged the relevant cells to avoid failures of nbval.
I would suggest to keep this PR open until we can use the new mesh.midpoints.
Thank you, that sounds good. I will update the methods when you merge the changes. |
|
Very nice @swapneelap! |
|
An important improvement - thank you! |
|
Thank you all for your reviews and comments! It helped in making the methods concise, readable, and efficient. :) |
Adding
to_xarraymethod forFieldobject which returns field value as anxarray.DataArray.x,y,z, andcomp. The first three corresponds to geometry while the fourth dimension corresponds to the components of field.compdimension hasfield.componentsas co-ordinates.Fieldobject is a scalar field, thecompdimension is 'squeezed' and the DataArray has only three dimensions corresponding to the geometry.comp) the name of the field, the name is assigned to the DataArray itself. The default name is'field', but it can be changed withnameparameter.unitsparameter. Units of geometry dimensions are set tomesh.attributes['unit']if the attribute exists, otherwise set to'm'(meter).