Refactor section inputs #80
Conversation
Codecov Report
@@ Coverage Diff @@
## develop #80 +/- ##
===========================================
+ Coverage 86.85% 87.46% +0.60%
===========================================
Files 9 9
Lines 2762 2912 +150
===========================================
+ Hits 2399 2547 +148
- Misses 363 365 +2
Continue to review full report at Codecov.
|
…aining backwards comapatability. The new options are 'distance', 'idx', and 'length', where distance is the distance from the dim1 wall in coordinates to draw the section, idx is the distance from the dim1 wall in cell indices to draw the section, and length is a two-element tuple specifying the bounding dim2 coordinates for the section in the same convention as either idx or distance (both idx and distance cannot be specified).
… the section documentation
…the 'CircularSection' to incorporate the new dimensional parameters 'radius' and 'origin', and their counterparts in indices 'radius_idx' and 'origin_idx'.
amoodie
force-pushed
the
refactor_section_inputs
branch
from
0a8484f to
87dbe49
Compare
…g DipSection to use the new arguments.
|
@elbeejay can you build the docs and read through the changes to the |
Just read through the docs and they look really good. The names and everything feel very consistent and are intuitive I think. |
|
@elbeejay sweet, thank you. The documentation is so fragile to formatting 😩 reminder, this will be a breaking change if you pull after merge! |
Refactored the inputs to sections (closes #34)
Each section can take inputs as either dimensional coordinates or as indices. Each argument has a paired argument
xxxx_idxthat is the input variables. Documentation and tests updated,**warning: this is a breaking change. The behavior of some input arguments has been maintained with a deprecation warning (e.g.,
yas input for a strike section), but others could not maintain backwards compatability (e.g.,radiusfor a circular section now specified coordinates instead of indices and will likely result in an error without updating your own code).Note: this PR also fixed a few issues with sections. Namely,
PathandRadialsections would occasionally be drawn the wrong direction or have incorrect ordering.Will also complete and closes #33