feat(get/set data record): Updated get_data/set_data functionality and new get_record/set_record methods #1568
Conversation
…ts have get_record and set_record method that allow the user to get a set data with all metadata. Behavior of set_data has also been changed to set data without changing the metadata. When set_data is passed metadata it gives a deprecation warning and sets the data and metadata.
Codecov Report
@@ Coverage Diff @@
## develop #1568 +/- ##
========================================
Coverage 72.4% 72.5%
========================================
Files 251 251
Lines 54216 54454 +238
========================================
+ Hits 39300 39517 +217
- Misses 14916 14937 +21
|
|
@spaulins-usgs, we probably need to do quite a bit of documenting for this new capability. Are there plans to add that to this PR? |
There was a problem hiding this comment.
A few issues with this PR:
- The PR message does not really convey the changes. I find use of "metadata" confusing.
- It would be nice if the testing of the
get_dataset_datacapabilities were not imbedded within an already too long test. I would suggest having a specific test that works with a small test model and probably in a separate test file for mf6 core functionality. - I wish you could get to values with a
.(likeblah.iprn) instead of with a[key] - I do not think the PR should be accepted without documentation on how to do to get a set values. Maybe a brief tutorial based on the autotest.
|
@langevin-usgs, @jdhughes-usgs, I will then update the existing tutorials, "Working with MODFLOW List Data" and "Working with MODFLOW Grid Array Data" to reflect these changes. @jdhughes-usgs, I changed the PR message. Hopefully it is less confusing now. I am now working on moving the testing to a new test. Regarding getting values with "." (as attributes of an object), I am not convinced that is better than the way it works now. There is some precedent for getting values/settings/metadata in a dictionary, for example JSON. Most python developers are already familiar with data/metadata in this format. Also note that this dictionary format can already be used to construct new data with filename/binary/iprn/factor settings. |
|
@spaulins-usgs I might suggest a smaller specific tutorial rather than add it to an existing tutorial. @langevin-usgs not sure if you agree? |
|
@jdhughes-usgs Another option is to modify the "MODFLOW 6: Data Storage Information - How and Where to Store MODFLOW-6 Data" tutorial. This is a short tutorial that already focuses on setting the data records (filename, binary, factor, iprn) when building packages. I could add a few examples of getting and setting data records with get_record and set_record and this tutorial would still be one of our shortest tutorials. |
…moved get/set record testing to its own test case
|
@jdhughes-usgs @langevin-usgs I have made the requested changes (1, 2, and 4) and the PR is ready to go. I will merge the PR shortly unless I hear otherwise. |
…d new get_record/set_record methods (modflowpy#1568) * feat(get/set data record): New feature where MFArray and MFList objects have get_record and set_record method that allow the user to get a set data with all metadata. Behavior of set_data has also been changed to set data without changing the metadata. When set_data is passed metadata it gives a deprecation warning and sets the data and metadata. * feat(get/set record): Updated tutorial to include get/set record and moved get/set record testing to its own test case
…d new get_record/set_record methods (modflowpy#1568) * feat(get/set data record): New feature where MFArray and MFList objects have get_record and set_record method that allow the user to get a set data with all metadata. Behavior of set_data has also been changed to set data without changing the metadata. When set_data is passed metadata it gives a deprecation warning and sets the data and metadata. * feat(get/set record): Updated tutorial to include get/set record and moved get/set record testing to its own test case
…d new get_record/set_record methods (#1568) * feat(get/set data record): New feature where MFArray and MFList objects have get_record and set_record method that allow the user to get a set data with all metadata. Behavior of set_data has also been changed to set data without changing the metadata. When set_data is passed metadata it gives a deprecation warning and sets the data and metadata. * feat(get/set record): Updated tutorial to include get/set record and moved get/set record testing to its own test case
…d new get_record/set_record methods (modflowpy#1568) * feat(get/set data record): New feature where MFArray and MFList objects have get_record and set_record method that allow the user to get a set data with all metadata. Behavior of set_data has also been changed to set data without changing the metadata. When set_data is passed metadata it gives a deprecation warning and sets the data and metadata. * feat(get/set record): Updated tutorial to include get/set record and moved get/set record testing to its own test case
New feature for MFArray and MFList data objects. These objects now have get_record and set_record methods that allow the user to get a set data including the data's settings (filename, binary, factor, iprn). Behavior of set_data has been changed to set data without changing the data's settings, except when set_data is passed a dictionary containing filename, binary, factor, or iprn, in which case it gives a deprecation warning and sets the data and the data's settings.