Skip to content

Commit f0b2742

Browse files
committed
Install: Add docstring to install function
1 parent 9e069d9 commit f0b2742

1 file changed

Lines changed: 19 additions & 10 deletions

File tree

mhkit/package/+mhkit/install.m

Lines changed: 19 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,23 @@
11
function install()
2-
% INSTALL Install MHKiT and its dependencies
3-
% mhkit.install() installs MHKiT with default settings
4-
% mhkit.install('Name', Value) installs with custom settings
5-
%
6-
% Optional Parameters:
7-
% 'Python' - Python version to use (default: '3.11')
8-
% 'Environment' - Conda environment name (default: 'mhkit-matlab-env')
9-
%
10-
% Example:
11-
% mhkit.install('Version', '0.9.0', 'Python', '3.11')
2+
3+
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
4+
% Install MHKiT Python dependencies and configure MATLAB integration
5+
%
6+
% Parameters
7+
% ------------
8+
% No parameters required
9+
%
10+
% Returns
11+
% ---------
12+
% No return values
13+
% Installs Conda, creates Python environment, installs MHKiT-Python
14+
% package and utilities, and configures MATLAB-Python integration
15+
%
16+
% Example
17+
% -------
18+
% mhkit.install()
19+
%
20+
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
1221

1322
% Initialize logger
1423
logger = mhkit.utils.get_logger();

0 commit comments

Comments
 (0)