Skip to content

Commit

Permalink
Update copyright and license
Browse files Browse the repository at this point in the history
  • Loading branch information
alexschimel committed Mar 15, 2024
1 parent 875e083 commit 0c764f7
Show file tree
Hide file tree
Showing 108 changed files with 280 additions and 437 deletions.
21 changes: 11 additions & 10 deletions Espresso.m
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,8 @@ function Espresso(varargin)
% ESPRESSO() starts an Espresso session or activates the main window if a
% session is already running.

% Authors: Alex Schimel (NGU, alexandre.schimel@ngu.no) and Yoann Ladroit
% (NIWA, yoann.ladroit@niwa.co.nz)
% 2017-2024
% Copyright 2017-2024 Alexandre Schimel, Yoann Ladroit, NIWA
% Licensed under MIT. Details on https://github.com/alexschimel/Espresso/

% Debug
global DEBUG;
Expand Down Expand Up @@ -77,23 +76,25 @@ function Espresso(varargin)
EspressoUserdata.logfile = logfile; % save to app in order to close diary at the end

% Getting software info for start-up message
[espressoVer, coffeeVer] = espresso_version();
licenseFilename = 'LICENSE';
licenseLines = readlines(licenseFilename);
[espressoVer, coffeeVer, aknowledgments] = espresso_version();
licenseFile = espresso_license_file();
licenseLines = readlines(licenseFile);
espressoLicense = licenseLines(find(contains(licenseLines,"license",'IgnoreCase',true),1));
espressoCopyright = licenseLines(find(contains(licenseLines,"copyright",'IgnoreCase',true),1));
if isdeployed
licenseLocation = 'About section';
else
[~,licenseFilename] = fileparts(licenseFile);
licenseLocation = sprintf('%s file',licenseFilename);
end

% Start-up message
introText = {};
introText{1,1} = sprintf('ESPRESSO v%s (powered by CoFFee v%s)\n',espressoVer,coffeeVer);
introText{2,1} = sprintf('%s\n',espressoCopyright);
introText{3,1} = sprintf('Licensed under the %s. See %s for details.\n',espressoLicense,licenseLocation);
introText{4,1} = sprintf('If you use this software, please acknowledge all authors listed in copyright.\n');
introText{end+1,1} = sprintf('ESPRESSO v%s (powered by CoFFee v%s)\n',espressoVer,coffeeVer);
introText{end+1,1} = sprintf('%s\n',espressoCopyright);
introText{end+1,1} = sprintf('Licensed under the %s. See %s for details.\n',espressoLicense,licenseLocation);
introText{end+1,1} = sprintf('If you use this software, please acknowledge:\n');
introText{end+1,1} = sprintf('%s.\n',aknowledgments);
introLimsText = {char([61.*ones(1,max(cellfun(@length,introText))-1),10])};
introText = [introLimsText;introText;introLimsText];
cellfun(@fprintf,introText);
Expand Down
48 changes: 35 additions & 13 deletions Espresso.prj
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<deployment-project plugin="plugin.ezdeploy" plugin-version="1.0">
<configuration build-checksum="3557758591" file="C:\Users\Schimel_Alexandre\Code\MATLAB\ESPRESSO_MIGRATE_3\Espresso\Espresso.prj" location="C:\Users\Schimel_Alexandre\Code\MATLAB\ESPRESSO_MIGRATE_3\Espresso" name="Espresso" preferred-package-location="C:\Users\Schimel_Alexandre\Code\MATLAB\Espresso\bin\for_redistribution" preferred-package-type="package.type.exe" target="target.ezdeploy.standalone" target-name="Application Compiler">
<configuration build-checksum="3557758591" file="C:\Users\Schimel_Alexandre\Code\MATLAB\Espresso\Espresso.prj" location="C:\Users\Schimel_Alexandre\Code\MATLAB\Espresso" name="Espresso" preferred-package-location="C:\Users\Schimel_Alexandre\Code\MATLAB\Espresso\bin\for_redistribution" preferred-package-type="package.type.exe" target="target.ezdeploy.standalone" target-name="Application Compiler">
<param.appname>Espresso</param.appname>
<param.icon>${PROJECT_ROOT}\Espresso_resources\icon.ico</param.icon>
<param.icons>
Expand All @@ -8,15 +8,24 @@
<file>${PROJECT_ROOT}\Espresso_resources\icon_24.png</file>
<file>${PROJECT_ROOT}\Espresso_resources\icon_16.png</file>
</param.icons>
<param.version>0.21</param.version>
<param.authnamewatermark>Alexandre Schimel</param.authnamewatermark>
<param.version>1.0.0.1</param.version>
<param.authnamewatermark>Alexandre Schimel, Yoann Ladoit, NIWA</param.authnamewatermark>
<param.email>alexandre.schimel@ngu.no</param.email>
<param.company>NIWA</param.company>
<param.company />
<param.summary>Multibeam water-column data visualization/processing</param.summary>
<param.description />
<param.description>Espresso is a free and open-source app to visualize and process water-column data acquired by multibeam echosounders. The main feature of this tool is the possibility to vertically echo-integrate water-column data so as to visualize and examine anomalies.

Relevant features:
* Support Kongsberg .all/.wcd, Kongsberg .kmall/.kmwcd, and Reson-Teledyne .s7k formats.
* Mask unwanted data (seafloor echo and below, outer-beams, inner-range, outer-range).
* Filter the sidelobe artefact.
* Vertical echo-integration over the whole water-column, or in horizontal slices defined relative to the water-surface (i.e. in depth) or to the bottom (i.e. in height).
* Visualize data stacked in range or depth.
* Export echo-integration mosaics.
* Geopicking features as polygons or points, and export as shapefiles.</param.description>
<param.screenshot>${PROJECT_ROOT}\Espresso_resources\splash.png</param.screenshot>
<param.guid />
<param.installpath.string>\Espresso\v0.21</param.installpath.string>
<param.installpath.string>\Espresso\v1.0.0-alpha.1</param.installpath.string>
<param.installpath.combo>option.installpath.programfiles</param.installpath.combo>
<param.logo>${PROJECT_ROOT}\Espresso_resources\splash_half.png</param.logo>
<param.install.notes />
Expand All @@ -34,7 +43,7 @@
<param.web.mcr>true</param.web.mcr>
<param.package.mcr>false</param.package.mcr>
<param.no.mcr>false</param.no.mcr>
<param.web.mcr.name>espresso_v021_setup</param.web.mcr.name>
<param.web.mcr.name>espresso_v1a1_setup</param.web.mcr.name>
<param.package.mcr.name>MyAppInstaller_mcr</param.package.mcr.name>
<param.no.mcr.name>MyAppInstaller_app</param.no.mcr.name>
<param.windows.command.prompt>false</param.windows.command.prompt>
Expand All @@ -48,11 +57,20 @@
Espresso varargin
Input Arguments
-? print help on how to use the application
varargin input arguments</param.help.text>
varargin input arguments
Description
Espresso is a free and open-source app to visualize and process water-column data acquired by multibeam echosounders. The main feature of this tool is the possibility to vertically echo-integrate water-column data so as to visualize and examine anomalies.

Relevant features:
* Support Kongsberg .all/.wcd, Kongsberg .kmall/.kmwcd, and Reson-Teledyne .s7k formats.
* Mask unwanted data (seafloor echo and below, outer-beams, inner-range, outer-range).
* Filter the sidelobe artefact.
* Vertical echo-integration over the whole water-column, or in horizontal slices defined relative to the water-surface (i.e. in depth) or to the bottom (i.e. in height).
* Visualize data stacked in range or depth.
* Export echo-integration mosaics.
* Geopicking features as polygons or points, and export as shapefiles.</param.help.text>
<unset>
<param.authnamewatermark />
<param.email />
<param.description />
<param.guid />
<param.installpath.combo />
<param.install.notes />
Expand All @@ -79,6 +97,7 @@
</fileset.resources>
<fileset.package>
<file>${PROJECT_ROOT}\Espresso_resources\icon_24.png</file>
<file>${PROJECT_ROOT}\LICENSE</file>
</fileset.package>
<fileset.depfun>
<file>${MATLAB_ROOT}\toolbox\local\userpath.m</file>
Expand Down Expand Up @@ -224,6 +243,7 @@
<file>${PROJECT_ROOT}\display\map_panel\display_features.m</file>
<file>${PROJECT_ROOT}\display\map_panel\grab_ping_line_cback.m</file>
<file>${PROJECT_ROOT}\display\map_panel\update_map_tab.m</file>
<file>${PROJECT_ROOT}\display\menu\create_menu.m</file>
<file>${PROJECT_ROOT}\display\opt_panel\datafiles_tab\create_datafiles_tab.m</file>
<file>${PROJECT_ROOT}\display\opt_panel\datafiles_tab\update_datafiles_tab.m</file>
<file>${PROJECT_ROOT}\display\opt_panel\display_tab\create_display_tab.m</file>
Expand All @@ -245,6 +265,7 @@
<file>${PROJECT_ROOT}\display\wc_panel\stacked_wc_tab\update_stacked_wc_tab.m</file>
<file>${PROJECT_ROOT}\display\wc_panel\wc_tab\create_wc_tab.m</file>
<file>${PROJECT_ROOT}\display\wc_panel\wc_tab\update_wc_tab.m</file>
<file>${PROJECT_ROOT}\espresso_license_file.m</file>
<file>${PROJECT_ROOT}\espresso_version.m</file>
<file>${PROJECT_ROOT}\general\coffee_checks\get_coffee_version.m</file>
<file>${PROJECT_ROOT}\general\coffee_checks\is_coffee_folder.m</file>
Expand All @@ -253,6 +274,7 @@
<file>${PROJECT_ROOT}\general\config\get_config_field.m</file>
<file>${PROJECT_ROOT}\general\config\init_config_file.m</file>
<file>${PROJECT_ROOT}\general\config\set_config_field.m</file>
<file>${PROJECT_ROOT}\general\espresso_export_folder.m</file>
<file>${PROJECT_ROOT}\general\espresso_user_folder.m</file>
<file>${PROJECT_ROOT}\general\generate_Espresso_diary_filename.m</file>
<file>${PROJECT_ROOT}\io\generate_valid_filename.m</file>
Expand All @@ -267,9 +289,9 @@
<file>${PROJECT_ROOT}\whereisroot.m</file>
</fileset.depfun>
<build-deliverables>
<file location="${PROJECT_ROOT}\bin\for_testing" name="readme.txt" optional="true">C:\Users\Schimel_Alexandre\Code\MATLAB\ESPRESSO_MIGRATE_3\Espresso\bin\for_testing\readme.txt</file>
<file location="${PROJECT_ROOT}\bin\for_testing" name="Espresso.exe" optional="false">C:\Users\Schimel_Alexandre\Code\MATLAB\ESPRESSO_MIGRATE_3\Espresso\bin\for_testing\Espresso.exe</file>
<file location="${PROJECT_ROOT}\bin\for_testing" name="splash.png" optional="false">C:\Users\Schimel_Alexandre\Code\MATLAB\ESPRESSO_MIGRATE_3\Espresso\bin\for_testing\splash.png</file>
<file location="${PROJECT_ROOT}\bin\for_testing" name="Espresso.exe" optional="false">C:\Users\Schimel_Alexandre\Code\MATLAB\Espresso\bin\for_testing\Espresso.exe</file>
<file location="${PROJECT_ROOT}\bin\for_testing" name="readme.txt" optional="true">C:\Users\Schimel_Alexandre\Code\MATLAB\Espresso\bin\for_testing\readme.txt</file>
<file location="${PROJECT_ROOT}\bin\for_testing" name="splash.png" optional="false">C:\Users\Schimel_Alexandre\Code\MATLAB\Espresso\bin\for_testing\splash.png</file>
</build-deliverables>
<workflow />
<matlab>
Expand Down
16 changes: 0 additions & 16 deletions Espresso/PackagingLog.html

This file was deleted.

3 changes: 0 additions & 3 deletions Espresso/for_redistribution_files_only/icon_24.png

This file was deleted.

47 changes: 0 additions & 47 deletions Espresso/for_redistribution_files_only/readme.txt

This file was deleted.

3 changes: 0 additions & 3 deletions Espresso/for_redistribution_files_only/splash.png

This file was deleted.

2 changes: 0 additions & 2 deletions Espresso/for_testing/mccExcludedFiles.log

This file was deleted.

47 changes: 0 additions & 47 deletions Espresso/for_testing/readme.txt

This file was deleted.

1 change: 0 additions & 1 deletion Espresso/for_testing/requiredMCRProducts.txt

This file was deleted.

3 changes: 0 additions & 3 deletions Espresso/for_testing/splash.png

This file was deleted.

2 changes: 1 addition & 1 deletion LICENSE
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
MIT License

Copyright (c) 2017-2024 Alexandre Schimel, Yoann Ladroit, Sally Watson
Copyright (c) 2017-2024 Alexandre Schimel, Yoann Ladroit, NIWA

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
Expand Down
Loading

0 comments on commit 0c764f7

Please sign in to comment.