Support for Borealis v1 #77
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
* Refactored directory structure to src/ layout to facilitate editable installation while removing setup.py * Created v1_onwards.py with classes for reading and conversion of Borealis v1.0+ files * Added reading of Borealis v1.0+ files using xarray, for simpler data processing * Modified BorealisRead, BorealisWrite, and BorealisConvert classes to dynamically dispatch the correct functions based on Borealis version.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Scope
setup.pyfile and moved tosrc/-style package layout to alleviate issues surrounding automatic package detection and editable installation without asetup.pyfile.issue: N/A
Approval
Number of approvals: 2
Test
First, get your hands on some new Borealis v1.0 files. @ me for files to test with.
BorealisReadon pre-v1 files (site- and array-structured)BorealisWriteon pre-v1 files (site- and array-structured)BorealisConverton pre-v1 files (site- and array-structured)BorealisReadon v1 files (access data withreader.recordsandreader.arrays)BorealisWriteon v1 files (should raiseNotImplementedError)BorealisConverton v1 files (bfiq and rawacf)BorealisV1Read.records_as_xarray()BorealisV1Read.arrays_as_xarray()Note that to test the xarray features you must install pydarnio with the optional
xarraydependencies, likepip install pydarnio[xarray] @ git+https://github.com/SuperDARN/pyDARNioThe
BorealisRead,BorealisWrite, andBorealisConvertclasses should be able to seamlessly support all types of Borealis files, determining the version from the data file and dispatching to the appropriate class.