Skip to content

v0.3.1

Pre-release
Pre-release
Compare
Choose a tag to compare
@emiliom emiliom released this 28 Sep 20:03
v0.3.1
7d82a42
This commit was created on GitHub.com and signed with GitHub’s verified signature. The key has expired.
GPG key ID: 4AEE18F83AFDEB23
Expired
Learn about vigilant mode.

Overview

The major new feature in this release is the generation of "report" Excel files, the primary quantitative export from EchoPro. A new notebook was added to illustrate the report generation workflow. In addition, the transect subset selection scheme was upgraded to reflect the Matlab implementation (but see #95); the test infrastructure was improved, including new tests; and the documentation was enhanced with the addition of auto-generated API documentation in the Jupyter Book and an update to the repository README file.

The Python EchoPro GitHub repository was made public in April. It was previously private while initial development was taking place.

New computations and functionality

  • Python EchoPro can now generate the Excel file "reports" found in Matlab EchoPro (#18, PR #84). 15 reports are generated. This development entailed significant new computations to generate binned results before exporting to files, plus other computations.
  • The transect subset selection scheme was updated from the previous interim scheme, to reflect the one found in Matlab EchoPro (#33, PR #89). But see #95 for a remaining issue.

Tests, packaging and documentation

  • New test modules, for report generation and transect subset selection (PR's #84, #89, #99).
  • Generalized and simplified most of the test path generation functionality in conftest.py and the test modules, with better handling of base paths, including a new HERE path accessible from _testing.py. One hard-wired path still remains, to be addresses in the next release (PR's #94, #84).
  • Updated installation requirements, and conda environment file after testing with the latest dependencies. Included a couple of new version pinnings that will be addressed in a future release (PR #98).
  • Updated installation instructions and other information in README.md (PR #98).
  • New reports_workflow.ipynb Jupyter notebook (PR's #84).
  • Sanitized input file names (in Google Drive and in survey_year_2019_config.yml), replacing & with _ to avoid issue of Google Drive downloads automatically renaming file names during zip-and-download of input files (#96, PR #97).
  • Added auto-generated API documentation in the Jupyter Book (PR #90).
Assets 2
Loading