boutproject / xBOUT

Collects BOUT++ data from parallelized simulations into xarray.
https://xbout.readthedocs.io/en/latest/
Apache License 2.0
21 stars 8 forks source link

Add topology to metadata #283

Closed mikekryjak closed 1 year ago

mikekryjak commented 1 year ago

It would be useful for xHermes to know the type of topology (e.g. connected double null). I was going to write something for this but @johnomotani pointed out that this functionality already exists in xBOUT here. If it's already in xBOUT then this should be the only place where the topology is worked out. This simple PR adds it to the dataset metadata.

~Will leave it as a draft for now in case I think of any other useful related metadata to expose.~ Need it for the polygon plotter PR, so would be good to merge it as is.

codecov-commenter commented 1 year ago

Codecov Report

Merging #283 (420415c) into master (212b407) will increase coverage by 0.00%. The diff coverage is 100.00%.

:exclamation: Current head 420415c differs from pull request most recent head e670f18. Consider uploading reports for the commit e670f18 to get more accurate results

:mega: This organization is not using Codecov’s GitHub App Integration. We recommend you install it so Codecov can continue to function properly for your repositories. Learn more

@@           Coverage Diff           @@
##           master     #283   +/-   ##
=======================================
  Coverage   68.94%   68.95%           
=======================================
  Files          15       15           
  Lines        3214     3215    +1     
  Branches      792      792           
=======================================
+ Hits         2216     2217    +1     
  Misses        734      734           
  Partials      264      264           
Impacted Files Coverage Δ
xbout/region.py 83.59% <100.00%> (+0.03%) :arrow_up:

:mega: We’re building smart automated test selection to slash your CI/CD build times. Learn more