Open blsqr opened 2 weeks ago
Hi @kkappler could you please have a look?
WORK IN PROGRESS Below are pasted blsqr's review bullets. I will tag blsqr when all items are addressed and a PR is ready. I will put my responses one level of indentation below the original comments. Comments marked with TODO have not been addressed yet.
aurora
was not derived directly from FORTRAN, but rather, Gary Egbert, the author of the EMTF FORTRAN code, translated it to matlab, and that matlab version was used as the starting point for aurora. I think this is an important fact to point out, and added a sentence We note that Aurora is two degrees separated from the FORTRAN EMTF, as we used a Matlab implementation of EMTF from Prof. Gary Egbert as an initial framework.
to clarify this. [TODO Add Line number]Typos and errors that should be corrected:
Other (editorial) remarks, questions, suggestions:
As a python representation of Egbert's EMTF Remote Reference processing software, Aurora provides a continuity in the MT code space as the languages evolve. We note that Aurora is two degrees separated from the FORTRAN EMTF, as we used a Matlab implementation of EMTF from Prof. Gary Egbert as an initial framework.
Upper panel represents the TF Kernel with two inlay boxes representing the dataset (pandas DataFrame) and processing config (JSON). Lower panel illustrates example instances of these structures.
These images are conceptual -- in reality the time series can have data from more than one station, and the spectrograms are also multivariate (not single channel as shown). The regression is also multivariate, and applied on complex-valued data from the spectrograms, this illustration however conveys the key idea of regression in the presence of outliers and mixed clusters.
This section refers to a Jupyter notebook companion to this paper (archived on GitHub: [process_cas04_mulitple_station](https://github.com/simpeg/aurora/blob/joss/docs/examples/process_cas04_mulitple_station.ipynb)). The companion notebook builds an MTH5 dataset from the EMscope dataset (@schultz2010emscope) and executes data processing -- a condensed version of which is shown in Figure 3. Apparent resistivities are plotted in Figure \ref{compareTFs} along with the EMTF-generated results hosted at EarthScope.
monotype
for code snippets like RunSummary()
. Also, was this intended to be a list? The — seem to suggest so … but I'm not sure. Would propose to delete those.
RunSummary()
The aurora results are from executing the example code snippet. The plotting details are in the Jupyter notebook
To run the example you must install aurora, which can be done via conda or pip. Detailed instructions and further documentation can be found on the SimPEG (@cockett2015simpeg) [documentation website](http://simpeg.xyz/aurora/).
## References
header should be added before the list of references starts.
# References
for consistencyAnd some more subjective suggestions (not affecting approval of the manuscript):
internal
KernelDataset
, Processing
, TransferFunctionKernel
) to make clear that you are referring to parts of the aurora code. This should be done consistently throughout the text.
TFK
and TFKernel
abbreviations, replacing with TransferFunctionKernel
(This issue is part of the review process for a submission to JOSS.)
Overall, the software paper (in the version linked here) is well-written and structured and provides a good starting point for assessing the scope of aurora and how to use it. However, there are a number of typos, ambiguities and inconsistencies that I feel hinder readability and understanding.
First, regarding the content:
Typos and errors that should be corrected:
Other (editorial) remarks, questions, suggestions:
monotype
for code snippets likeRunSummary()
. Also, was this intended to be a list? The — seem to suggest so … but I'm not sure. Would propose to delete those.## References
header should be added before the list of references starts.And some more subjective suggestions (not affecting approval of the manuscript):
KernelDataset
,Processing
,TransferFunctionKernel
) to make clear that you are referring to parts of the aurora code. This should be done consistently throughout the text.