Skip to content

Commit

Permalink
Update Doxygen docs.
Browse files Browse the repository at this point in the history
  • Loading branch information
@cianciosa
cianciosa committed Dec 30, 2024
1 parent 1804272 commit 005bf7c
Show file tree
Hide file tree
Showing 47 changed files with 5,534 additions and 5,527 deletions.
6 changes: 5 additions & 1 deletion docs/md_BMW_README.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -86,7 +86,11 @@
<div class="title">BMW </div> </div>
</div><!--header-->
<div class="contents">
<div class="textblock"></div></div><!-- contents -->
<div class="textblock"><p>Biot-Savart Magnetic Vmec Vector potential.</p>
<h1><a class="anchor" id="autotoc_md1"></a>
Building</h1>
<p>This is a subproject of the <a href="https://github.com/ORNL-Fusion/Stellarator-Tools">Stellarator-Tools</a> suite of codes. To build the code follow the instructions in the <a href="https://github.com/ORNL-Fusion/Stellarator-Tools">Stellarator-Tools</a> repository. </p>
</div></div><!-- contents -->
</div><!-- PageDoc -->
</div><!-- doc-content -->
<!-- start footer part -->
Expand Down
8 changes: 4 additions & 4 deletions docs/md_README.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -100,16 +100,16 @@
<li><a href="https://github.com/cianciosa/V3FIT">V3FIT</a> 3D Equilibrium Reconstruction</li>
<li><a href="https://github.com/ORNL-Fusion/BOOZ_XFORM.git">BOOZ_XFORM</a> Convert VMEC coordinates to Boozer coordinates.</li>
</ul>
<h1><a class="anchor" id="autotoc_md7"></a>
<h1><a class="anchor" id="autotoc_md8"></a>
Documentation</h1>
<ul>
<li><a href="https://ornl-fusion.github.io/Stellarator-Tools-Docs/">Stellarator-Tools-Docs</a> Documentation for the Stellarator Tools suite of codes.</li>
<li><a href="https://github.com/jonathanschilling/vmec-internals">VMEC-internals</a> Some VMEC-internal documentation</li>
</ul>
<h1><a class="anchor" id="autotoc_md8"></a>
<h1><a class="anchor" id="autotoc_md9"></a>
Testing</h1>
<p><a href="https://github.com/ORNL-Fusion/Stellarator-Tools/actions/workflows/ci_test.yaml"><img src="https://github.com/ORNL-Fusion/Stellarator-Tools/actions/workflows/ci_test.yaml/badge.svg" alt="Continuous Integration Test" style="pointer-events: none;" class="inline"/></a></p>
<h1><a class="anchor" id="autotoc_md9"></a>
<h1><a class="anchor" id="autotoc_md10"></a>
Compiling</h1>
<p>To compile the code, first clone this repository.</p>
<div class="fragment"><div class="line">git clone https://github.com/ORNL-Fusion/Stellarator-Tools.git</div>
Expand All @@ -126,7 +126,7 @@ <h1><a class="anchor" id="autotoc_md9"></a>
<p>After changing settings, keep pressing <code>c</code> until the <code>g</code> option appears.</p>
<p><img src="cmake3.png" alt="" class="inline" title="Inital Screen"/></p>
<p>After hitting <code>g</code> option <code>ccmake</code> will exit and a <code>Makefile</code> will be generated. The codes can be built using the <code>make</code> command.</p>
<h2><a class="anchor" id="autotoc_md10"></a>
<h2><a class="anchor" id="autotoc_md11"></a>
Touble Shooting</h2>
<p>If <code>cmake</code> fails to find the correct libraries, you may need to set the <code>CMAKE_PREFIX_PATH</code> variable to help locate them. </p>
</div></div><!-- contents -->
Expand Down
100 changes: 51 additions & 49 deletions docs/navtreedata.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,9 @@ var NAVTREE =
] ]
] ],
[ "Programmer Manuals", "index.html#programmer", null ],
[ "BMW", "md_BMW_README.html", null ],
[ "BMW", "md_BMW_README.html", [
[ "Building", "md_BMW_README.html#autotoc_md1", null ]
] ],
[ "Command Line Arguments", "bmw_cl_parsing_sec.html", [
[ "Introduction", "bmw_cl_parsing_sec.html#bmw_cl_parsing_intro", null ],
[ "Command Line Arguments", "bmw_cl_parsing_sec.html#bmw_cl_parsing_arg_sec", null ],
Expand Down Expand Up @@ -172,10 +174,10 @@ var NAVTREE =
[ "Programmers Reference", "wout_diff_cl_parsing_sec.html#wout_diff_cl_pasring_prog_ref_sec", null ]
] ],
[ "Stellarator-Tools", "md_README.html", [
[ "Documentation", "md_README.html#autotoc_md7", null ],
[ "Testing", "md_README.html#autotoc_md8", null ],
[ "Compiling", "md_README.html#autotoc_md9", [
[ "Touble Shooting", "md_README.html#autotoc_md10", null ]
[ "Documentation", "md_README.html#autotoc_md8", null ],
[ "Testing", "md_README.html#autotoc_md9", null ],
[ "Compiling", "md_README.html#autotoc_md10", [
[ "Touble Shooting", "md_README.html#autotoc_md11", null ]
] ]
] ],
[ "SIESTA", "md_SIESTA_README.html", null ],
Expand Down Expand Up @@ -465,50 +467,50 @@ var NAVTREE =

var NAVTREEINDEX =
[
"",
"bcoils__mod_8f.html#a12c071e47df3517b12dfea3723a78db6",
"bootsj__input_8f.html#ab8113c47ac102c0784fa9862ac39c261",
"check__param__value_8py.html#ab6c2627e99169dd2597c0a0567de341a",
"combination_8f.html#a9a42fcb38d3b9c358d60e9778d399d4a",
"doxygen.html#doxygen_markup_v3fit_aliases",
"fbal_8f.html#a070e7c18aa156afb4135415ecf8802b7",
"gmres__mod_8f.html#a5d1ec5bdbfad28dcd82a497b29c5c564",
"interfaceezcdf__genput_1_1cdfputvar.html#a667345eb31798b4e19c23bf5801810d7",
"interfacemddc__cdf_1_1mddc__cdf__define.html#af3f253ec74ff5bca4857c856a6a50dad",
"interfacepspline__calls_1_1mkspl2z.html#a134076184356a1b870a346b757e3b8f0",
"interfacepspline__calls_1_1r8tcspgrid.html#a4fdc8eb4c72af631d97ab9108c9ce98b",
"island__params_8f90.html#af4424f408e273b36d2110bfb3c76f6e7",
"mddc__cdf_8f.html#aee580ef14b30bf59ff5a1238b1730ec1",
"modular__coils_8f.html#a0be0b69fe9ffde08689dbc3c8d254394",
"namespaceblocktridiagonalsolver.html#acf20e8973c04f1deda1e133503dbae75",
"namespacecombination.html#a56bfb4b52d189e53d00793eef8b9c564",
"namespacegradient__descent.html#acb441a7526ab3eac5024ce6a378bb412",
"namespacemetrics.html#a059896dcb23befc67ecee6718c0b92a6",
"namespacepchelms.html#a8825694461e58626f06df565e3105a7a",
"namespaceshared__data.html#a8c71aa69c189259760cc60182519e4b3",
"namespacesxrem.html#a2d6df79edd9ff1537a1e94f4e4b0d442",
"namespacev3fit__params.html#a2270758b69ee03d9d5bf0c1d9db1814e",
"namespacevmec__equilibrium.html#ae58f672179f6d1d52da04725f3d21c4d",
"nscalingtools_8f90.html#a366852a8bf54833f987a4bf8dd985eaa",
"optim__params_8f.html#afaad51ff6aaee3b074e53f7a522a9d7b",
"parallel__vmec__module_8f90.html#af0d35b12b704d19fd70811757e871852",
"read__response__nompi_8f.html#a1c32d72b00b60fda83d5c41f6c115d9b",
"restart__mod_8f90.html#abfed0dd744369ecdbd34b04b4f05244f",
"siesta__equilibrium_8f.html#a0e5961578d443ce3e3e13ae34f41ae56",
"structblocktridiagonalsolver_1_1mastertoslavemapping.html#a4f91e35f2a153b3e7961bd19dfc9ec29",
"structequilibrium_1_1equilibrium__class.html#a0703586a443672401de804f74ae0b686",
"structezspline__type_1_1ezspline3__r8.html#acd4c00ce1c77a2a16c32a24abd1b5a42",
"structmddc__t_1_1mddc__desc.html#a61074ce17d2d61d4912aec24770729fe",
"structreconstruction_1_1reconstruction__class.html#a497d649594d1e956ca874d131abcf3dd",
"structsxrem_1_1sxrem__gp__context__x.html#a0385aa999491d6bb71c66941dcbc5182",
"structvmec__equilibrium_1_1vmec__class.html#a881f4b36c9c00bf341603fd37554f9b6",
"timer__mod_8f90.html#a2304292595a56e2e558163c3a170dc43",
"v3fit__input_8f.html#a17cb61871ebe20fe6f97bb2410aa179c",
"v3post__rfun_8f.html#a9e2549df72af4d76591076272a592b0a",
"vacmod_8f.html#a98a42b167c483260928b42669c98b448",
"vmec__equilibrium_8f.html#a65aae6ba7b821665a846416e2357bbde",
"vmec__io_8f.html#a4dffa740de8b7c4446ad19bd0d79164f",
"vmec_equilibrium_sec.html#vmec_equilibrium_derive_param_sec"
"SURFACE_2Sources_2surface_8f.html",
"blocktridiagonalsolver__bst_8f90.html#aaa629b828eb36e9edd1cc2a193c3dc45",
"bsc__T_8f.html#adcb363428651d3b1f45bd7ea31b46ba8",
"classsiesta__quantities.html#a72b431d872c372f0b29d1d19cf3068e3",
"descriptor__mod_8f90.html#a3f6f65effd374a75b888ee08874702e8",
"ezcdf__GenGet_8f90.html#a0c5137bbed1a99f6e3e122eefbb71b1d",
"functions_vars_d.html",
"interfacebsc__t_1_1bsc__a.html#a28c118953bfe8c2a21ced6661866401d",
"interfaceezspline_1_1ezspline__isindomain.html#a1a18b9ce8af5e9dded44b04c27b20c65",
"interfacepspline__calls_1_1bcspevxy.html#ab0e667e8200ad298c2151be975c67dce",
"interfacepspline__calls_1_1r8gridintrp3d.html#a58f0b7dbef591b49fccdb9f3ae2d641d",
"interfacesignal_1_1signal__construct.html#a273530affe49200dfa2ea120360189ee",
"main_8cpp.html#a421ab65ef9b71171d848eed5609f16d4",
"mgrid__mod_8f.html#ab5a7d8b67c10d5e23479c0194a1b3db4",
"namelist_sec.html#size_sec",
"namespaceblocktridiagonalsolver__s.html#a8b9082da27c6b43b9ffd413f34755f7a",
"namespaceequilibrium.html#a58181cf1609d1dafa8e377746b4aafe3",
"namespacemagnetic.html#a7e2ec298bb1b6eed9875fc7cb944b429",
"namespacemodel__state.html#a66e419547cb10eb150f794fb27d6d231",
"namespacerestart__mod.html#a2091c7af7c4ef368c4294861381a2697",
"namespacesiesta__force.html#aba2bd1ea1649cf0a2c203ae7d33a5dc2",
"namespacev3fit__input.html#a38c02cb03f69ba62fffd17714561bee0",
"namespacevmec__equilibrium.html#a13885bbe9a9ada9d7cb6273e37f45b16",
"namespacevmec__input.html#acdf327762893b41f2bbe147f5825e396",
"optim__params_8f.html#a3bc7e2c4a8ef9c558bf67c3ed2801b19",
"parallel__include__module_8f90.html#af8daa2cad34579b1b6f69e3a15a6d373",
"precon2d_8f.html#aba1d71cfe8a45451d28736e599f2cc0c",
"realspace_8f.html#a8b718564a9c4d0f6f74d8608f2a1f3fe",
"saddle__surface_8f.html#a10d1521a33b15dbd376ce9c1cef3205f",
"siesta_namelist_sec.html#siesta_grid_size_sec",
"structbmw__parallel__context_1_1bmw__parallel__context__class.html#a33d121a4d564a8a8180653bf0ff2cb97",
"structezspline__type_1_1ezspline1__r8.html#ac143aa815360d901827db39d7e2e6a30",
"structintpol_1_1intpol__class.html#ac4117798ed44385c1725e6581e668542",
"structmodel_1_1model__class.html#af2d66372bd620befdca63463231557ce",
"structsiesta__equilibrium_1_1siesta__class.html#aeab8e2817b33bf9cb261f1f556ffdda8",
"structv3rfun__context_1_1v3rfun__context__class.html#a1f1edc2b2d80b6500dd84d609fb99b98",
"sxrch__dot_8f.html#a71b4b250f369c685b3d3aaf2bd5c5ba6",
"timer__sub_8f.html#a9fb569407d0313867f3ad406bff7161f",
"v3fit__input_8f.html#ad699c5f4f2865dc9f6be9660bebbbf1c",
"vacfield__mod_8f.html#a2d8d5393781e097d7b68f53e333bc88a",
"vforces_8f.html#a30249f2f9996b7a9690d6b814d76132a",
"vmec__input_8f.html#a02b29863a947531e6c4e8d7c66c5a5e0",
"vmec__main_8f.html#ab3a922d20e89fc3981794e22899067fa",
"vsvd0_8f.html#a6219c811c2d60a3e8e2de26bc69dcb1e"
];

var SYNCONMSG = 'click to disable panel synchronisation';
Expand Down
Loading

0 comments on commit 005bf7c

Please sign in to comment.