ParaMonte MATLAB 3.0.0
Parallel Monte Carlo and Machine Learning Library
See the latest version documentation.
weblinks.m
Go to the documentation of this file.
1%> \brief
2%> Return a structure containing tree of weblinks for the
3%> ParaMonte MATLAB library source file and documentation website.
4%>
5%> \return
6%> ``tree`` : The output MATLAB ``struct`` containing the ParaMonte website information.
7%>
8%> \interface{weblinks}
9%> \code{.m}
10%>
11%> tree = pm.lib.weblinks();
12%>
13%> \endcode
14%>
15%> \example{weblinks}
16%> \include{lineno} example/lib/weblinks/main.m
17%> \output{weblinks}
18%> \include{lineno} example/lib/weblinks/main.out.m
19%>
20%> \final{weblinks}
21%>
22%> \author
23%> \JoshuaOsborne, May 21 2024, 7:58 PM, University of Texas at Arlington<br>
24%> \FatemehBagheri, May 20 2024, 1:25 PM, NASA Goddard Space Flight Center (GSFC), Washington, D.C.<br>
25%> \AmirShahmoradi, May 16 2016, 9:03 AM, Oden Institute for Computational Engineering and Sciences (ICES), UT Austin<br>
26function tree = weblinks()
27
28 persistent stree;
29
30 if ~isempty(stree)
31 tree = stree;
32 return
33 end
34
35 stree = struct();
36 stree.home = struct();
37 stree.home.url = "https://www.cdslab.org/paramonte";
38 stree.home.install = struct();
39 stree_home_install_url = stree.home.url + "/notes/installation";
40
41 %%%% installation Linux
42
43 stree.home.overview = struct();
44 stree_home_overview_url = stree.home.url + "/notes/overview";
45 stree.home.overview.preface = struct();
46 stree.home.overview.changes = struct();
47 stree.home.overview.preface.url = stree_home_overview_url + "/preface";
48 stree.home.overview.changes.fortran = struct();
49 stree.home.overview.changes.python = struct();
50 stree.home.overview.changes.matlab = struct();
51 stree.home.overview.changes.fortran.url = stree_home_overview_url + "/paramonte-kernel-release-notes";
52 stree.home.overview.changes.python.url = stree_home_overview_url + "/paramonte-python-release-notes";
53 stree.home.overview.changes.matlab.url = stree_home_overview_url + "/paramonte-matlab-release-notes";
54
55 %%%% installation Linux
56
57 stree.home.install.linux = struct();
58 stree.home.install.linux.url = stree_home_install_url + "/linux";
59
60 %%%% installation Windows
61
62 stree.home.install.windows = struct();
63 stree.home.install.windows.url = stree_home_install_url + "/windows";
64
65 %%%% installation MATLAB
66
67 stree.home.install.matlab = struct();
68 stree.home.install.matlab.url = stree_home_install_url + "/matlab";
69
70 %%%% installation Python
71
72 stree.home.install.python = struct();
73 stree.home.install.python.url = stree_home_install_url + "/python";
74
75 %%%% installation macOS
76
77 stree.home.install.macos = struct();
78 stree.home.install.macos.url = stree_home_install_url + "/macos";
79 stree.home.install.macos.prereqs = struct();
80 stree.home.install.macos.prereqs.url = stree.home.install.macos.url + "/#the-compile-time-and-runtime-prerequisites";
81 stree.home.install.macos.prereqs.cmd = struct();
82 stree.home.install.macos.prereqs.cmd.url = stree.home.install.macos.url + "/#prereqs-install";
83
84 %%%% MATLAB examples
85
86 stree.home.examples = struct();
87 stree_home_examples_url = stree.home.url + "/notes/examples";
88 stree.home.examples.matlab = struct();
89 stree.home.examples.matlab.jupyter = struct();
90 stree.home.examples.matlab.postprocess = struct();
91 stree.home.examples.matlab.jupyter.url = stree_home_examples_url + "/matlab/jupyter";
92 stree.home.examples.matlab.postprocess.url = stree_home_examples_url + "/matlab/postprocess";
93
94 %%%% Python examples
95
96 stree.home.examples = struct();
97 stree_home_examples_url = stree.home.url + "/notes/examples";
98 stree.home.examples.python = struct();
99 stree.home.examples.python.jupyter = struct();
100 stree.home.examples.python.postprocess = struct();
101 stree.home.examples.python.jupyter.url = stree_home_examples_url + "/python/jupyter";
102 stree.home.examples.python.postprocess.url = stree_home_examples_url + "/python/postprocess";
103
104 %%%% Python API
105
106 stree.home.api = struct();
107 stree_home_api_url = stree.home.url + "/notes/api";
108 stree.home.api.python = struct();
109 stree.home.api.python.url = stree_home_api_url + "/python/autoapi/paramonte";
110
111 %%%% ParaDRAM
112
113 stree.home.usage = struct();
114 stree_home_usage_url = stree.home.url + "/notes/usage";
115 stree.home.usage.paradram = struct();
116 stree_home_usage_paradram_url = stree_home_usage_url + "/paradram";
117 stree.home.usage.paradram.quickstart = struct();
118 stree.home.usage.paradram.quickstart.url = stree_home_usage_paradram_url + "/interface";
119 stree.home.usage.paradram.input = struct();
120 stree.home.usage.paradram.input.url = stree_home_usage_paradram_url + "/input";
121 stree.home.usage.paradram.specifications = struct();
122 stree.home.usage.paradram.specifications.url = stree_home_usage_paradram_url + "/specifications";
123 stree.home.usage.paradram.restart = struct();
124 stree.home.usage.paradram.restart.url = stree_home_usage_paradram_url + "/restart";
125 stree.home.usage.paradram.output = struct();
126 stree.home.usage.paradram.output.url = stree_home_usage_paradram_url + "/output";
127
128 %%%% GitHub issues
129
130 stree.github = struct();
131 stree.github.url = "https://github.com/cdslaborg/paramonte";
132 stree.github.issues = struct();
133 stree.github.issues.url = "https://github.com/cdslaborg/paramonte/issues";
134 stree.github.release = struct();
135 stree.github.release.url = stree.github.url + "/releases";
136 stree.github.release.latest = struct();
137 stree.github.release.latest.url = stree.github.release.url + "/latest";
138 stree.github.archive = struct();
139 stree_github_archive_url = stree.github.url + "/archive";
140 stree.github.archive.main = struct();
141 stree.github.archive.main.zip = struct();
142 stree.github.archive.main.tar = struct();
143 stree.github.archive.main.zip.url = stree_github_archive_url + "/main.zip";
144 stree.github.archive.main.tar.url = stree_github_archive_url + "/main.tar.gz";
145
146 %%%% GitHub examples
147
148 stree.github.examples = struct();
149 stree.github.examples.url = "https://github.com/cdslaborg/paramontex";
150
151 %%%% Intel MPI
152
153 stree.intel = struct();
154 stree.intel.mpi = struct();
155 stree.intel.mpi.home = struct();
156 stree.intel.mpi.home.url = "https://software.intel.com/en-us/mpi-library";
157
158 %%%% Intel MPI Windows
159
160 stree.intel.mpi.windows = struct();
161 stree.intel.mpi.windows.url = "https://software.intel.com/en-us/get-started-with-mpi-for-windows";
162
163 %%%% OpenMPI
164
165 stree.openmpi = struct();
166 stree.openmpi.home = struct();
167 stree.openmpi.home.url = "https://www.open-mpi.org/";
168
169 tree = stree;
170
171end
home
function home()
Return a MATLAB string containing the absolute path to the system home directory.
lib
function lib()
Return a scalar MATLAB string containing the path to the lib directory of the ParaMonte library packa...
release
function release(in type)
Return a scalar MATLAB string containing the MATLAB release version, year, or season as requested.