Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add documentation of export "report" files to Jupyter Book #112

Closed
emiliom opened this issue Oct 8, 2023 · 3 comments
Closed

Add documentation of export "report" files to Jupyter Book #112

emiliom opened this issue Oct 8, 2023 · 3 comments
Labels
documentation Improvements or additions to documentation

Comments

@emiliom
Copy link
Contributor

emiliom commented Oct 8, 2023

Add a page to the Jupyter Book documenting the input files in detail

  • Note: All Google links below have restricted access.
  • 15 files are exported as Excel "reports":
    • kriging_based_aged_output_all.xlsx
    • kriging_based_aged_output_non_zero.xlsx
    • kriging_based_core_output_all.xlsx
    • kriging_based_core_output_non_zero.xlsx
    • kriging_based_len_age_abundance.xlsx
    • kriging_based_len_age_biomass.xlsx
    • kriging_input.xlsx
    • specimen_length_counts_haul.xlsx
    • total_length_counts_haul.xlsx
    • transect_based_aged_output_all.xlsx
    • transect_based_aged_output_non_zero.xlsx
    • transect_based_core_output_all.xlsx
    • transect_based_core_output_non_zero.xlsx
    • transect_based_len_age_abundance.xlsx
    • transect_based_len_age_biomass.xlsx
  • The file names are currently hardwired in reports.py::create_and_write_reports
  • The Output file descriptions - UW Google doc is annotated version of a document originally from Chu (Output file descriptions) that describes each report file.
  • The EchoPro Output Report Files Google doc contains notes from a meeting in January 2023 where we went over all the output files.
  • The Google Drive folder EchoPro_matlab_output_brandon_age_22_end_bin contains the set of 2019 Excel report files generated by Matlab EchoPro.

Other relevant issues:

@emiliom emiliom added the documentation Improvements or additions to documentation label Oct 8, 2023
@emiliom emiliom added this to the Release 0.3.2 milestone Oct 8, 2023
@emiliom
Copy link
Contributor Author

emiliom commented Nov 4, 2023

File name match up between Python EchoPro and Matlab EchoPro (2019) report files:

Python EchoPro Matlab EchoPro
kriging_based_aged_output_all.xlsx EchoPro_kriged_aged_output-2019_0.xlsx
kriging_based_aged_output_non_zero.xlsx EchoPro_kriged_aged_output-2019_1.xlsx
kriging_based_core_output_all.xlsx EchoPro_kriged_output-26-Jan-2023_0.xlsx
kriging_based_core_output_non_zero.xlsx EchoPro_kriged_output-26-Jan-2023_1.xlsx
kriging_based_len_age_abundance.xlsx kriged_len_age_abundance_table.xlsx
kriging_based_len_age_biomass.xlsx kriged_len_age_biomass_table.xlsx
kriging_input.xlsx kriging_input.xlsx
specimen_length_counts_haul.xlsx aged_len_haul_counts_table.xlsx
total_length_counts_haul.xlsx total_len_haul_counts_table.xlsx
transect_based_aged_output_all.xlsx EchoPro_un-kriged_aged_output-2019_0.xlsx
transect_based_aged_output_non_zero.xlsx EchoPro_un-kriged_aged_output-2019_1.xlsx
transect_based_core_output_all.xlsx EchoPro_un-kriged_output-26-Jan-2023_0.xlsx
transect_based_core_output_non_zero.xlsx EchoPro_un-kriged_output-26-Jan-2023_1.xlsx
transect_based_len_age_abundance.xlsx un-kriged_len_age_abundance_table.xlsx
transect_based_len_age_biomass.xlsx un-kriged_len_age_biomass_table.xlsx

@emiliom
Copy link
Contributor Author

emiliom commented Dec 8, 2023

I'll create an initial, slim version of this page by Saturday.

@brandynlucca
Copy link
Collaborator

This has been encapsulated within #290 and can therefore be closed.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
Status: Done
Development

No branches or pull requests

3 participants