Skip to content

Commit

Permalink
Significant update to v1.1.0
Browse files Browse the repository at this point in the history
  • Loading branch information
eszmw committed Feb 15, 2024
1 parent 2634a59 commit 656a0d3
Show file tree
Hide file tree
Showing 313 changed files with 1,190 additions and 1,325 deletions.
6 changes: 4 additions & 2 deletions .gitattributes
Original file line number Diff line number Diff line change
Expand Up @@ -5,10 +5,10 @@
*.mexa64 binary
*.mexw64 binary
*.mexmaci64 binary
*.mlapp binary linguist-language=MATLAB
*.mlapp binary
*.mldatx binary
*.mlproj binary
*.mlx binary merge=mlAutoMerge linguist-language=MATLAB
*.mlx binary
*.p binary
*.sfx binary
*.sldd binary
Expand All @@ -17,8 +17,10 @@
*.sltx binary
*.slxc binary
*.slx binary merge=mlAutoMerge
*.mlx binary merge=mlAutoMerge
*.slxp binary


## Other common binary file types
*.docx binary
*.exe binary
Expand Down
43 changes: 3 additions & 40 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ jobs:
strategy:
fail-fast: false
matrix:
MATLABVersion: [R2021b, R2022a, R2022b, R2023a]
MATLABVersion: [R2022b, R2023a]
# This workflow contains a single job called "build" build:
# The type of runner that the job will run on
runs-on: ubuntu-latest
Expand All @@ -28,31 +28,17 @@ jobs:
# Checks-out your repository under $GITHUB_WORKSPACE, so your job can access it
- uses: actions/checkout@v3

# Set up a display server
- name: Start display server
run: |
sudo apt-get install xvfb
Xvfb :99 &
echo "DISPLAY=:99" >> $GITHUB_ENV
# Sets up MATLAB on the GitHub Actions runner
- name: Setup MATLAB
uses: matlab-actions/setup-matlab@v1
with:
release: ${{ matrix.MATLABVersion }}

- name: Run MATLAB command
uses: matlab-actions/run-command@v1
with:
command: |
connector.internal.startConnectionProfile("loopbackHttps");
com.mathworks.matlabserver.connector.api.Connector.ensureServiceOn();

# Runs a set of commands using the runners shell
- name: Run all tests
uses: matlab-actions/run-command@v1
with:
command: addpath("buildutil"); testModule("ModuleName","Integrals.prj","ReportSubdirectory","${{ matrix.MATLABVersion }}");
command: addpath("buildutil"); testModule("ModuleName","PROJECTNAME.prj","ReportSubdirectory","${{ matrix.MATLABVersion }}");

# Save the contents of the report directory from each release into a single artifact. Since each release makes their own directory, they all update the same artifact.
- name: Save Report Directory
Expand All @@ -62,28 +48,6 @@ jobs:
name: report
path: report

# Report on what releases tested successfully.
# Generate a draft release based on the tag
# Recreate the tag with the final version of JSON files and the ToolboxPackaging.prj
release:
needs: test
if: always()
runs-on: ubuntu-latest

steps:
- uses: actions/checkout@v3
with:
ref: refs/heads/release

- name: Set up MATLAB
uses: matlab-actions/setup-matlab@v1

# Copy all the reports down into the container
- uses: actions/download-artifact@v3
with:
name: report
path: report

# Generate the JSON for the releases tested badge
- name: Generate tested with badge
uses: matlab-actions/run-command@v1
Expand All @@ -97,7 +61,7 @@ jobs:
with:
junit_files: "report/*/test-results.xml"

# Commit the JSON for the MATLAB releases badge and ToolboxPackaging.prj
# Commit the JSON for the MATLAB releases badge
- name: commit changed files
continue-on-error: true
run: |
Expand All @@ -106,4 +70,3 @@ jobs:
git commit report/badge/tested_with.json -m "Final checkins for release ${{ github.ref_name }}"
git fetch
git push
53 changes: 53 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1 +1,54 @@
# List of untracked files to ignore

# Autosave files
*.asv
*.m~
*.autosave
*.slx.r*
*.mdl.r*

# MATLAB Drive
*.MATLABDriveTag

# Compiled files
*.mex*
*.p

# Compressed files
*.zip

# Packaged app and toolbox files
*.mlappinstall
*.mltbx

# Deployable archives
*.ctf

# Generated helpsearch folders
helpsearch*/

# Defined Simulink cache folder
Utilities/SimulinkCache/*

# Standard code generation folders
slprj/
sccprj/
codegen/

# Code generation file
*.eep
*.elf
*.hex
*.bin

# Cache files
*.slxc

# Project settings
Utilities/ProjectSettings.mat

# Test results
SoftwareTests/TestResults_*

# GitLab page fodler
public/
9 changes: 9 additions & 0 deletions .gitlab-ci.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
stages:
- test

matlab-test-job:
tags:
- matlab
stage: test
script:
- matlab -batch "openProject('Integrals.prj'); results = runtests('IncludeSubfolders', true); disp(table(results)); assertSuccess(results);"
Empty file added Apps/.gitkeep
Empty file.
Binary file added Apps/CalculusFlashcards.mlapp
Binary file not shown.
27 changes: 27 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
# Contributing

>_If you believe you have discovered a security vulnerability, please **do not** open an issue or make a pull request. Follow the instructions in the [SECURITY.md](SECURITY.md) file in this repository._
Thank you for your interest in contributing to a MathWorks repository! We encourage contributions large and small to this repository.

**Contributions do not have to be code!** If you see a way to explain things more clearly or a great example of how to use something, please contribute it (or a link to your content). We welcome issues even if you don't code the solution. We also welcome pull requests to resolve issues that we haven't gotten to yet!

## How to give feedback
* **Send us an email:** Contact the [MathWorks teaching resources team.](mailto:[email protected])
* **Open an issue:** Start by [creating an issue](https://docs.github.com/en/issues/tracking-your-work-with-issues/creating-an-issue) in the repository that you're interested in. That will start a conversation with the maintainer. When you are creating a bug report, please include as many details as possible. Please remember that other people do not have your background or understanding of the issue; make sure you are clear and complete in your description.

## How to contribute to the repository
* **Work in your own public fork:** If you choose to make a contribution, you should [fork the repository](https://docs.github.com/en/get-started/quickstart/fork-a-repo). This creates an editable copy on GitHub where you can write, test, and refine your changes. We suggest that you keep your changes small and focused on the issue you submitted.
* **Sign a Contributor License Agreement (CLA):** We require that all outside contributors sign a [CLA](https://en.wikipedia.org/wiki/Contributor_License_Agreement) before we can accept your contribution. When you create a pull request (see below), we'll reach out to you if you do not already have one on file. Essentially, the CLA gives us permission to publish your contribution as part of the repository.
* **Make a pull request:** "[Pull Request](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)" is a confusing term, but it means exactly what it says: You're requesting that the maintainers of the repository pull your changes in. If you don't have a CLA on file, we'll reach out to you. Your contribution will be reviewed, and we may ask you to revise your pull request based on our feedback. Once everyone is satisfied, we'll merge your pull request into the repository.

## Guidelines

We don't have best practices for writing MATLAB® code, but we do have some recommendations:

* You should not have any warnings or errors in the [code analyzer report](http://www.mathworks.com/help/matlab/matlab_prog/matlab-code-analyzer-report.html)
* [Loren Shure's blog](https://blogs.mathworks.com/loren) has [great advice on improving your MATLAB code](https://blogs.mathworks.com/loren/category/best-practice/)
* Examples should be written as [live scripts](https://www.mathworks.com/help/matlab/matlab_prog/what-is-a-live-script-or-function.html) or [Simulink® models](https://www.mathworks.com/help/simulink/index.html).
* We adhere to the [CommonMark](https://commonmark.org/) specification where it does not conflict with GitHub rendering. If you edit your Markdown in Visual Studio Code or a similar editor, it uses [markdownlint](https://github.com/DavidAnson/markdownlint) to highlight issues in your Markdown.

**Again, thanks for contributing, and we look forward to your issues and pull requests!**
Empty file added Data/.gitkeep
Empty file.
File renamed without changes.
Binary file removed FullScripts/integralSubstitution.mlx
Binary file not shown.
Binary file added Images/AddOnsIcon.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added Images/AreaLake.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added Images/CalcDer.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added Images/EndIcon.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added Images/OpenInFX.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added Images/OpenInMO.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions Images/TestedWith.json
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
{"schemaVersion":1,"label":"tested with","message":"R2024a","color":"success"}
29 changes: 23 additions & 6 deletions LICENSE.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,27 @@
Copyright (c) 2022, The MathWorks, Inc.
Copyright (c) 2023, The MathWorks, Inc.
All rights reserved.

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are
met:

1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
3. In all cases, the software is, and all modifications and derivatives of the software shall be, licensed to you solely for use in conjunction with MathWorks products and service offerings.
* Redistributions of source code must retain the above copyright
notice, this list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright
notice, this list of conditions and the following disclaimer in
the documentation and/or other materials provided with the distribution
* Neither the name of the The MathWorks, Inc. nor the names
of its contributors may be used to endorse or promote products derived
from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
POSSIBILITY OF SUCH DAMAGE.
Binary file renamed Navigation/Navigation.mlx → MainMenu.mlx
Binary file not shown.
17 changes: 0 additions & 17 deletions Navigation/OpenOverview.m

This file was deleted.

Loading

0 comments on commit 656a0d3

Please sign in to comment.