Skip to content

Latest commit

 

History

History
155 lines (103 loc) · 6.87 KB

README.md

File metadata and controls

155 lines (103 loc) · 6.87 KB
Raw

MHKiT-MATLAB

Linux and macOS Unit Tests Windows Unit Tests DOI

MHKiT-MATLAB is a MATLAB package designed for marine renewable energy applications to assist in data processing and visualization. The software package include functionality for:

  • Data processing
  • Data visualization
  • Data quality control
  • Resource assessment
  • Device performance
  • Device loads

See the documentation for more information about MHKiT.

Installation

NOTE: MHKiT-MATLAB now requires the user to install a specific version of MHKiT-Python, currently version 0.7.0. You can achieve this by executing the following commands in the Anaconda environment where MHKiT-Python is installed:

  1. Uninstall the current version of MHKiT-Python:
pip uninstall mhkit
  1. Install MHKiT-Python version 0.7.0:
pip install mhkit==0.7.0
  1. Verify the MHKiT-Python version:
python -c "import mhkit; print(mhkit.__version__)"

Software Requirements

MHKiT-MATLAB utilizes Python functions from MHKiT-Python and requires the user to have compatible versions of Python and MHKiT-Python installed.

MHKiT-MATLAB supports the following combinations of MATLAB and Python versions.1

R2021b R2022a R2022b R2023a R2023b R2024a
3.12 - - - - - -
3.11 - - - - ✓ ✓
3.10 - - ✓ ✓ ✓ ✓
3.9 ✓ ✓ ✓ ✓ ✓ ✓
3.8 ✓ ✓ ✓ ✓ - -
  • ✓: MATLAB/Python versions compatible
  • -: MATLAB/Python versions not compatible

Before installing MHKiT-MATLAB, please ensure your system has compatible versions of Python and MATLAB installed per the table above.

Installation Guide

For complete installation instructions, please visit the installation guide.

Unit Tests

To ensure software reliability and stability. MHKiT-MATLAB software runs a suite of unit tests using the above MATLAB/Python compatibility matrix on Linux (ubuntu-latest), MacOS (macos-latest) and Windows (windows-latest). These tests simulate a user's machine, but they are not perfect. Unit test failures on GitHub Actions may not necessarily indicate actual issues but could be artifacts of the build environment. Users should consider using a tested version if issues arise.

Test Matrices

The test matrices below detail the current state of unit testing. An "X" indicates a OS/MATLAB/Python version with a failing MHKiT-MATLAB unit test on GitHub Action that is due to Actions environment.

Linux (ubuntu-latest)

R2021b R2022a R2022b R2023a R2023b R2024a
3.12 - - - - - -
3.11 - - - - ✓ ✓
3.10 - - ✓ ✓ ✓ ✓
3.9 ✓ ✓ ✓ ✓ ✓ ✓
3.8 ✓ ✓ ✓ ✓ - -

macOS (macos-latest)

R2021b R2022a R2022b R2023a R2023b R2024a
3.12 - - - - - -
3.11 - - - - ✓ ✓
3.10 - - ✓ ✓ ✓ ✓
3.9 ✓ ✓ ✓ ✓ ✓ ✓
3.8 ✓ ✓ ✓ ✓ - -

Windows (windows-latest)

R2021b R2022a R2022b R2023a R2023b R2024a
3.12 - - - - - -
3.11 - - - - ✓ ✓
3.10 - - ✓ ✓ ✓ ✓
3.9 ✓ ✓ ✓ ✓ ✓ ✓
3.8 ✓ ✓ ✓ ✓ - -

Legend

  • ✓: GitHub Actions unit test passed.
  • X: GitHub Actions unit test failed; consider using a tested version if issues arise.
  • -: MATLAB/Python version not compatible.

Development Notes

Contributions

We encourage contributions through pull requests. Please submit your contributions via pull requests on this repository.

Local Development

Setup

  1. Uninstall the MHKiT toolbox if already installed:

    • Navigate to Home > Add-Ons > Manage Add-Ons > right-click on "mhkit" > "Uninstall"

  2. Clone or download the MHKiT-MATLAB source code. If contributing code, fork the repository and submit a pull request. GitHub provides details on the forking and pull request process here.

  3. Install the latest Python versions of mhkit and mhkit_python_utils.

    • Navigate to the MHKiT-MATLAB directory:
      • Install mhkit-python:
        • pip install mhkit
      • Install mhkit-python-utils:
        • pip install -e .

  4. Add the MHKiT-MATLAB/mhkit folder and its subfolders to your MATLAB path.

Local Unit Testing

Ensure code integrity by running unit tests locally before pushing changes to GitHub.

To execute all unit tests, run mhkit/tests/runTests.m. Unit test results will display in the command window.

Code Coverage

Code coverage reports are automatically generated during unit testing (refer to Local Unit Testing for execution instructions). mhkit/tests/coverage_report contains results from the most recent code coverage report.

Copyright and License

MHKiT is copyright through the National Renewable Energy Laboratory, Pacific Northwest National Laboratory, and Sandia National Laboratories. The software is distributed under the Revised BSD License.

See copyright and license for more information.

Footnotes

  1. For a comprehensive list of compatible MATLAB/Python versions, refer to the MathWorks Python Compatibility Documentation. ↩