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.<br>
4%>
5%> \return
6%> ``tree`` : The output MATLAB ``struct`` containing the ParaMonte website information.<br>
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
37 %%%% docs
38
39 stree.docs = struct();
40 stree.docs.url = "https://www.cdslab.org/paramonte";
41
42 %%%% docs generic
43
44 stree.docs.generic = struct();
45 stree.docs.generic.url = stree.docs.url + "/generic/" + pm.lib.version("generic", "major");
46
47 %%%% docs lang
48
49 for lang = ["matlab"]; %["c", "cpp", "fortran", "matlab", "python"];
50 stree.docs.(lang) = struct();
51 stree.docs.(lang).url = stree.docs.url + "/" + lang + "/" + pm.lib.version(lang, "major");
52 end
53
54 %%%% docs generic overview
55
56 stree.docs.generic.overview = struct();
57 stree.docs.generic.overview.url = stree.docs.generic.url + "/overview";
58
59 stree.docs.generic.overview.preface = struct();
60 stree.docs.generic.overview.preface.url = stree.docs.generic.overview.url + "/preface";
61
62 stree.docs.generic.overview.fortran = struct();
63 stree.docs.generic.overview.fortran.url = stree.docs.generic.overview.url + "/paramonte-kernel-release-notes";
64
65 stree.docs.generic.overview.matlab = struct();
66 stree.docs.generic.overview.matlab.url = stree.docs.generic.overview.url + "/paramonte-matlab-release-notes";
67
68 stree.docs.generic.overview.python = struct();
69 stree.docs.generic.overview.python.url = stree.docs.generic.overview.url + "/paramonte-python-release-notes";
70
71 %%%% docs generic installation
72
73 stree.docs.generic.installation = struct();
74 stree.docs.generic.installation.url = stree.docs.generic.url + "/installation";
75
76 %%%% docs generic installation Linux
77
78 stree.docs.generic.installation.linux = struct();
79 stree.docs.generic.installation.linux.url = stree.docs.generic.installation.url + "/linux";
80
81 %%%% docs generic installation Windows
82
83 stree.docs.generic.installation.windows = struct();
84 stree.docs.generic.installation.windows.url = stree.docs.generic.installation.url + "/windows";
85
86 %%%% docs generic installation MATLAB
87
88 stree.docs.generic.installation.matlab = struct();
89 stree.docs.generic.installation.matlab.url = stree.docs.generic.installation.url + "/matlab";
90
91 %%%% docs generic installation Python
92
93 stree.docs.generic.installation.python = struct();
94 stree.docs.generic.installation.python.url = stree.docs.generic.installation.url + "/python";
95
96 %%%% docs generic installation macOS
97
98 stree.docs.generic.installation.macos = struct();
99 stree.docs.generic.installation.macos.url = stree.docs.generic.installation.url + "/macos";
100 stree.docs.generic.installation.macos.prereqs = struct();
101 stree.docs.generic.installation.macos.prereqs.url = stree.docs.generic.installation.macos.url + "/#the-compile-time-and-runtime-prerequisites";
102 stree.docs.generic.installation.macos.prereqs.cmd = struct();
103 stree.docs.generic.installation.macos.prereqs.cmd.url = stree.docs.generic.installation.macos.url + "/#prereqs-install";
104
105 %%%% docs generic MATLAB examples
106
107 stree.docs.generic.examples = struct();
108 stree.docs.generic.examples.url = stree.docs.generic.url + "/examples";
109 stree.docs.generic.examples.matlab = struct();
110 stree.docs.generic.examples.matlab.jupyter = struct();
111 stree.docs.generic.examples.matlab.postprocess = struct();
112 stree.docs.generic.examples.matlab.jupyter.url = stree.docs.generic.examples.url + "/matlab/jupyter";
113 stree.docs.generic.examples.matlab.postprocess.url = stree.docs.generic.examples.url + "/matlab/postprocess";
114
115 %%%% docs generic Python examples
116
117 stree.docs.generic.examples = struct();
118 stree.docs.generic.examples.url = stree.docs.generic.url + "/examples";
119 stree.docs.generic.examples.python = struct();
120 stree.docs.generic.examples.python.jupyter = struct();
121 stree.docs.generic.examples.python.postprocess = struct();
122 stree.docs.generic.examples.python.jupyter.url = stree.docs.generic.examples.url + "/python/jupyter";
123 stree.docs.generic.examples.python.postprocess.url = stree.docs.generic.examples.url + "/python/postprocess";
124
125 %%%% docs generic Python API
126
127 stree.docs.generic.api = struct();
128 stree.docs.generic.api.url = stree.docs.generic.url + "/api";
129 stree.docs.generic.api.python = struct();
130 stree.docs.generic.api.python.url = stree.docs.generic.api.url + "/python/autoapi/paramonte";
131
132 %%%% docs generic usage
133
134 stree.docs.generic.usage = struct();
135 stree.docs.generic.usage.url = stree.docs.generic.url + "/usage";
136
137 %%%% docs generic usage ParaDRAM
138
139 stree.docs.generic.usage.paradram = struct();
140 stree.docs.generic.usage.paradram.url = stree.docs.generic.usage.url + "/paradram";
141 stree.docs.generic.usage.paradram.quickstart = struct();
142 stree.docs.generic.usage.paradram.quickstart.url = stree.docs.generic.usage.paradram.url + "/interface";
143 stree.docs.generic.usage.paradram.input = struct();
144 stree.docs.generic.usage.paradram.input.url = stree.docs.generic.usage.paradram.url + "/input";
145 stree.docs.generic.usage.paradram.specifications = struct();
146 stree.docs.generic.usage.paradram.specifications.url = stree.docs.generic.usage.paradram.url + "/specifications";
147 stree.docs.generic.usage.paradram.restart = struct();
148 stree.docs.generic.usage.paradram.restart.url = stree.docs.generic.usage.paradram.url + "/restart";
149 stree.docs.generic.usage.paradram.output = struct();
150 stree.docs.generic.usage.paradram.output.url = stree.docs.generic.usage.paradram.url + "/output";
151
152 %%%% GitHub issues
153
154 stree.github = struct();
155 stree.github.url = "https://github.com/cdslaborg/paramonte";
156
157 stree.github.issues = struct();
158 stree.github.issues.url = "https://github.com/cdslaborg/paramonte/issues";
159
160 %%%% GitHub releases
161
162 stree.github.releases = struct();
163 stree.github.releases.url = stree.github.url + "/releases";
164
165 stree.github.releases.latest = struct();
166 stree.github.releases.latest.url = stree.github.releases.url + "/latest";
167
168 stree.github.releases.tag = struct();
169 stree.github.releases.tag.url = stree.github.releases.url + "/tag";
170
171 stree.github.releases.tag.auxil = struct();
172 stree.github.releases.tag.auxil.url = stree.github.releases.tag.url + "/auxil";
173
174 stree.github.releases.download = struct();
175 stree.github.releases.download.url = stree.github.releases.url + "/download";
176
177 stree.github.releases.download.auxil = struct();
178 stree.github.releases.download.auxil.url = stree.github.releases.download.url + "/auxil";
179
180 %%%% GitHub archive
181
182 stree.github.archive = struct();
183 stree.github.archive.url = stree.github.url + "/archive";
184
185 stree.github.archive.main = struct();
186
187 stree.github.archive.main.zip = struct();
188 stree.github.archive.main.zip.url = stree.github.archive.url + "/main.zip";
189
190 stree.github.archive.main.tar = struct();
191 stree.github.archive.main.tar.url = stree.github.archive.url + "/main.tar.gz";
192
193 %%%% GitHub examples
194
195 stree.github.examples = struct();
196 stree.github.examples.url = "https://github.com/cdslaborg/paramontex";
197
198 %%%% external
199
200 stree.external = struct();
201
202 %%%% external Intel
203
204 stree.external.intel = struct();
205 stree.external.intel.url = "https://software.intel.com/en-us";
206
207 stree.external.intel.mpi = struct();
208 stree.external.intel.mpi.url = stree.external.intel.url + "/mpi-library";
209
210 %%%% external OpenMPI
211
212 stree.external.openmpi = struct();
213 stree.external.openmpi.url = "https://www.open-mpi.org/";
214
215 %%%%
216 %%%% Copy the tree.
217 %%%%
218
219 tree = stree;
220
221end
version
function version(in silent)
Return a scalar MATLAB string containing the latest available ParaMonte MATLAB version newer than the...
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.