C~Scape Result Interface

[DanTanAtAims]

It would probably be best to go over this pull request in a meeting due to its size.

Loading C~scape Results

Results from C~scape can be loaded with the load_results function.

# Assumes NetCDFs are contained in result subdirectory (see example directory tree below)
rs = ADRIA.load_results(CScapeResultSet, "<path to data dir>")

# Retrieves NetCDFs from separate directory
rs = ADRIA.load_results(CScapeResultSet, "<path to data dir>", "<path to result directory>")

# Manually pass in a list of files to load as results
rs = ADRIA.load_results(CScapeResultSet, "<path to data dir>", ["netcdf_fn1", "netcdf_fn2", ...])

Functionality

result_interface.pdf

Available Metrics

• Total Internal Larvae - ADRIA.metrics.total_internal_larvae(rs)
• Location Internal Larvae - ADRIA.metrics.loc_internal_larvae(rs)
• Total External Larvae - ADRIA.metrics.total_external_larvae(rs)
• Location External Larvae - ADRIA.metrics.loc_external_larvae(rs)
• Total Eggs Produced - ADRIA.metrics.total_eggs_produced(rs)
• Location Eggs Produced - ADRIA.metrics.loc_eggs_produced(rs)
• Total Settlers - ADRIA.metrics.total_settlers(rs)
• Location Settlers - ADRIA.metrics.loc_settlers(rs)
• Relative Location Taxa Cover - ADRIA.metrics.relative_loc_taxa_cover(rs)
• Relative Taxa Cover - ADRIA.metrics.relative_taxa_cover(rs)
• Relative Cover - ADRIA.metrics.relative_cover(rs)

Any metric that depends on the above also works.

[ConnectedSystems]

Best to get this in soon @Zapiano - I suggest handling this before #935

[Zapiano]

@DanTanAtAims it looks like there are some conflicts to solve here.