Skip to content

issue-39: Create updated toolbox package #40

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.

Sign up for GitHub

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

Merged
wiitt merged 3 commits into from
Apr 15, 2025
Merged

issue-39: Create updated toolbox package #40

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
2597736
issue-39: Create updated toolbox package
wiitt Mar 19, 2025
00fc68f
issue-39: Align lists of maintainers with each other
wiitt Mar 27, 2025
3146a69
issue-39: Change version and data of release
wiitt Apr 11, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Binary file removed dist/onc-2.1.3.mltbx
View file
Open in desktop
Binary file not shown.
Binary file added dist/onc-2.2.4.mltbx
View file
Open in desktop
Binary file not shown.
88 changes: 32 additions & 56 deletions onc.prj
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,27 +1,29 @@
<deployment-project plugin="plugin.toolbox" plugin-version="1.0">
<configuration build-checksum="1855703013" file="/home/zelalem/my_repos/mygithubrepos/api-matlab-client/onc.prj" location="/home/zelalem/my_repos/mygithubrepos/api-matlab-client" name="onc" target="target.toolbox" target-name="Package Toolbox">
<configuration build-checksum="920942746" file="C:\Repositories\api-matlab-client\onc.prj" location="C:\Repositories\api-matlab-client" name="onc" target="target.toolbox" target-name="Package Toolbox">
<param.appname>Ocean Networks Canada API Client</param.appname>
<param.authnamewatermark>Ocean Networks Canada</param.authnamewatermark>
<param.email>data@oceannetworks.ca</param.email>
<param.company>Ocean Networks Canada</param.company>
<param.summary>Open access to oceanographic data hosted by Ocean Networks Canada through the Oceans 2.0 API web services</param.summary>
<param.summary>Open access to oceanographic data hosted by Ocean Networks Canada through the Oceans 3.0 API web services</param.summary>
<param.description>Allows users to discover and retrieve Ocean Networks Canada's 12+ years of oceanographic data in raw, text, image, audio, video or any other format available.

This toolkit provides a class that wraps web service calls, complex workflows, and business logic so that users can download data with a single line of code.

MATLAB Requirements: R2022b (can work on versions 2018a and newer, but it is not guaranteed)

Full Documentation: https://wiki.oceannetworks.ca/display/CLIBS/API+Client+Libraries
Github repository: https://github.com/OceanNetworksCanada/api-matlab-client
GitHub Repository: https://github.com/OceanNetworksCanada/api-matlab-client

Current Maintainer: Zelalem Engida, Angela Schlesinger
Copy link
Copy Markdown
Contributor

@spencerwplovie spencerwplovie Mar 26, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The Current Maintainer(s) section here should probably be updated. Ze no longer works at ONC, so I'd move their name to the Past Contributors section. I'd keep Angela's name here, she overlooks API development in general.

I'm not sure who will be picking up maintaining the Matlab client library in the future though. Possibly the next intermediate/senior scientific programmer.

Copy link
Copy Markdown
Contributor

@spencerwplovie spencerwplovie Mar 26, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks like a list of maintainers is also mentioned in: https://github.com/OceanNetworksCanada/api-matlab-client/blob/main/README.md

Copy link
Copy Markdown
Contributor

@spencerwplovie spencerwplovie Mar 26, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In a separate ticket/changeset, it might also be worth updating the Contributing markdown file as well: https://github.com/OceanNetworksCanada/api-matlab-client/blob/main/CONTRIBUTING.md
The first paragraph under the header could be simplified to more closely match what we have in our Python client library: https://github.com/OceanNetworksCanada/api-python-client/blob/main/CONTRIBUTING.md

Also, we do now use GitHub Integration for this repository, so the Overview section should be updated as well. Hmm reading through the new toolkit version process at the bottom, the section about uploading to FileExchange is outdated as well. Should match the steps I added to the CL Release Procedure page in our internal docs. I think that last bit should just be deleted so we don't need to maintain this in two separate spaces - only internal users should have access to the ONC FileExchange account, anyways.

Past contributors: Allan Rempel, Ryan Ross, Dany Cabrera</param.description>
<param.screenshot>${PROJECT_ROOT}/logo.png</param.screenshot>
<param.version>2.1.3</param.version>
<param.output>${PROJECT_ROOT}/Ocean Networks Canada API Client.mltbx</param.output>
Past Contributors: Allan Rempel, Ryan Ross, Dany Cabrera</param.description>
<param.screenshot>${PROJECT_ROOT}\logo.png</param.screenshot>
<param.version>2.2.4</param.version>
<param.output>${PROJECT_ROOT}\Ocean Networks Canada API Client.mltbx</param.output>
<param.products.name />
<param.products.id />
<param.products.version />
<param.platforms />
<param.guid>57513b40-1188-4691-9010-dcce03abb132</param.guid>
<param.guid>9b6b9160-58e8-4b4d-a809-23e8db524709</param.guid>
<param.exclude.filters>% List files contained in your toolbox folder that you would like to exclude
% from packaging. Excludes should be listed relative to the toolbox folder.
% Some examples of how to specify excludes are provided below:
Expand Down Expand Up @@ -52,7 +54,7 @@ tests/TOKEN</param.exclude.filters>
<param.apps />
<param.registered.apps />
<param.docs />
<param.getting.started.guide />
<param.getting.started.guide>${PROJECT_ROOT}\onc\doc\GettingStarted.mlx</param.getting.started.guide>
<param.matlabpath.excludes>
<item>/tests</item>
<item>/tests/suites</item>
Expand All @@ -64,13 +66,13 @@ tests/TOKEN</param.exclude.filters>
<param.required.addons />
<param.matlab.project.id />
<param.matlab.project.name />
<param.release.start>R2017a</param.release.start>
<param.release.end>latest</param.release.end>
<param.release.current.only>false</param.release.current.only>
<param.release.start>R2022b</param.release.start>
<param.release.end>R2022b</param.release.end>
<param.release.current.only>true</param.release.current.only>
<param.compatiblity.windows>true</param.compatiblity.windows>
<param.compatiblity.macos>true</param.compatiblity.macos>
<param.compatiblity.macos>false</param.compatiblity.macos>
<param.compatiblity.linux>true</param.compatiblity.linux>
<param.compatiblity.matlabonline>true</param.compatiblity.matlabonline>
<param.compatiblity.matlabonline>false</param.compatiblity.matlabonline>
<param.installation.map />
<param.additional.sw.names />
<param.additional.sw.licenses />
Expand All @@ -89,17 +91,13 @@ tests/TOKEN</param.exclude.filters>
<param.apps />
<param.registered.apps />
<param.docs />
<param.getting.started.guide />
<param.javaclasspath.excludes />
<param.exported.on.package />
<param.required.addons />
<param.matlab.project.id />
<param.matlab.project.name />
<param.release.current.only />
<param.compatiblity.windows />
<param.compatiblity.macos />
<param.compatiblity.linux />
<param.compatiblity.matlabonline />
<param.installation.map />
<param.additional.sw.names />
<param.additional.sw.licenses />
Expand All @@ -108,63 +106,41 @@ tests/TOKEN</param.exclude.filters>
<param.additional.sw.linux.url />
</unset>
<fileset.rootdir>
<file>${PROJECT_ROOT}/onc</file>
<file>${PROJECT_ROOT}\onc</file>
</fileset.rootdir>
<fileset.rootfiles>
<file>${PROJECT_ROOT}/onc/+ext</file>
<file>${PROJECT_ROOT}/onc/+onc</file>
<file>${PROJECT_ROOT}/onc/+util</file>
<file>${PROJECT_ROOT}/onc/Onc.m</file>
<file>${PROJECT_ROOT}\onc\+ext</file>
<file>${PROJECT_ROOT}\onc\+onc</file>
<file>${PROJECT_ROOT}\onc\+util</file>
<file>${PROJECT_ROOT}\onc\Contents.m</file>
<file>${PROJECT_ROOT}\onc\doc</file>
<file>${PROJECT_ROOT}\onc\examples</file>
<file>${PROJECT_ROOT}\onc\Onc.m</file>
</fileset.rootfiles>
<fileset.depfun.included />
<fileset.depfun.excluded />
<fileset.package />
<build-deliverables>
<file location="${PROJECT_ROOT}" name="Ocean Networks Canada API Client.mltbx" optional="false">/home/zelalem/my_repos/mygithubrepos/api-matlab-client/Ocean Networks Canada API Client.mltbx</file>
<file location="${PROJECT_ROOT}" name="Ocean Networks Canada API Client.mltbx" optional="false">C:\Repositories\api-matlab-client\Ocean Networks Canada API Client.mltbx</file>
</build-deliverables>
<workflow />
<matlab>
<root>/usr/local/MATLAB/R2020a</root>
<toolboxes>
<toolbox name="matlabcoder" />
<toolbox name="embeddedcoder" />
<toolbox name="fixedpoint" />
<toolbox name="neuralnetwork" />
</toolboxes>
<toolbox>
<matlabcoder>
<enabled>true</enabled>
</matlabcoder>
</toolbox>
<toolbox>
<embeddedcoder>
<enabled>true</enabled>
</embeddedcoder>
</toolbox>
<toolbox>
<fixedpoint>
<enabled>true</enabled>
</fixedpoint>
</toolbox>
<toolbox>
<neuralnetwork>
<enabled>true</enabled>
</neuralnetwork>
</toolbox>
<root>C:\Program Files\MATLAB\R2022b</root>
<toolboxes />
</matlab>
<platform>
<unix>true</unix>
<unix>false</unix>
<mac>false</mac>
<windows>false</windows>
<windows>true</windows>
<win2k>false</win2k>
<winxp>false</winxp>
<vista>false</vista>
<linux>true</linux>
<linux>false</linux>
<solaris>false</solaris>
<osver>5.4.0-90-generic</osver>
<osver>10.0</osver>
<os32>false</os32>
<os64>true</os64>
<arch>glnxa64</arch>
<arch>win64</arch>
<matlab>true</matlab>
</platform>
</configuration>
Expand Down
0 doc/AddOn.png → onc/doc/AddOn.png
View file
Open in desktop
File renamed without changes
0 doc/ExampleLinks.html → onc/doc/ExampleLinks.html
View file
Open in desktop
File renamed without changes.
0 doc/GettingStarted.html → onc/doc/GettingStarted.html
View file
Open in desktop
File renamed without changes.
Binary file added onc/doc/GettingStarted.mlx
View file
Open in desktop
Binary file not shown.
0 doc/HowToUse.html → onc/doc/HowToUse.html
View file
Open in desktop
File renamed without changes.
0 doc/Info.html → onc/doc/Info.html
View file
Open in desktop
File renamed without changes.
0 doc/Onc.html → onc/doc/Onc.html
View file
Open in desktop
File renamed without changes.
0 doc/OncArchive.html → onc/doc/OncArchive.html
View file
Open in desktop
File renamed without changes.
0 doc/OncDelivery.html → onc/doc/OncDelivery.html
View file
Open in desktop
File renamed without changes.
0 doc/OncDiscovery.html → onc/doc/OncDiscovery.html
View file
Open in desktop
File renamed without changes.
0 doc/OncRealTime.html → onc/doc/OncRealTime.html
View file
Open in desktop
File renamed without changes.
0 doc/UpdateInstruction.html → onc/doc/UpdateInstruction.html
View file
Open in desktop
File renamed without changes.
0 doc/UserDirectory.png → onc/doc/UserDirectory.png
View file
Open in desktop
File renamed without changes
0 doc/helptoc.xml → onc/doc/helptoc.xml
View file
Open in desktop
File renamed without changes.
0 doc/update.png → onc/doc/update.png
View file
Open in desktop
File renamed without changes