Files
GridFire/docs/html/____init_____8py.html
2026-06-14 08:36:52 -04:00

184 lines
17 KiB
HTML

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.13.2"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>GridFire: src/python/gridfire/__init__.py File Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<script type="text/javascript" src="clipboard.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="cookie.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="doxygen-awesome.css" rel="stylesheet" type="text/css"/>
<link href="doxygen-awesome-sidebar-only.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr id="projectrow">
<td id="projectalign">
<div id="projectname">GridFire<span id="projectnumber">&#160;v1.0.2</span>
</div>
<div id="projectbrief">General Purpose Nuclear Network</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.13.2 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
/* @license-end */
</script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() { codefold.init(0); });
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
initMenu('',true,false,'search.php','Search',true);
$(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function(){initNavTree('____init_____8py.html',''); initResizable(true); });
/* @license-end */
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#namespaces">Namespaces</a> &#124;
<a href="#func-members">Functions</a> &#124;
<a href="#var-members">Variables</a> </div>
<div class="headertitle"><div class="title">__init__.py File Reference</div></div>
</div><!--header-->
<div class="contents">
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="namespaces" name="namespaces"></a>
Namespaces</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">namespace &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacegridfire.html">gridfire</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="func-members" name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:a0ee5ace587287cdba8f9755a0ef0b498" id="r_a0ee5ace587287cdba8f9755a0ef0b498"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacegridfire.html#a0ee5ace587287cdba8f9755a0ef0b498">gridfire.gf_metadata</a> ()</td></tr>
<tr class="separator:a0ee5ace587287cdba8f9755a0ef0b498"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a45c5e5933ef14301b6f7ec2fff6a0966" id="r_a45c5e5933ef14301b6f7ec2fff6a0966"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacegridfire.html#a45c5e5933ef14301b6f7ec2fff6a0966">gridfire.gf_version</a> ()</td></tr>
<tr class="separator:a45c5e5933ef14301b6f7ec2fff6a0966"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1de3db5e65a2e834c55f458307cab68e" id="r_a1de3db5e65a2e834c55f458307cab68e"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacegridfire.html#a1de3db5e65a2e834c55f458307cab68e">gridfire.gf_author</a> ()</td></tr>
<tr class="separator:a1de3db5e65a2e834c55f458307cab68e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a081c76fc9fbac9b5b380c8e4fa0e7be0" id="r_a081c76fc9fbac9b5b380c8e4fa0e7be0"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacegridfire.html#a081c76fc9fbac9b5b380c8e4fa0e7be0">gridfire.gf_license</a> ()</td></tr>
<tr class="separator:a081c76fc9fbac9b5b380c8e4fa0e7be0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae6f8e40e5233e5c98c9c4290f518b72d" id="r_ae6f8e40e5233e5c98c9c4290f518b72d"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacegridfire.html#ae6f8e40e5233e5c98c9c4290f518b72d">gridfire.gf_email</a> ()</td></tr>
<tr class="separator:ae6f8e40e5233e5c98c9c4290f518b72d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae5ade7b2d801af88a79382441ec68277" id="r_ae5ade7b2d801af88a79382441ec68277"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacegridfire.html#ae5ade7b2d801af88a79382441ec68277">gridfire.gf_url</a> ()</td></tr>
<tr class="separator:ae5ade7b2d801af88a79382441ec68277"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:afa60407432a1e563b9731ce298cf42bc" id="r_afa60407432a1e563b9731ce298cf42bc"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacegridfire.html#afa60407432a1e563b9731ce298cf42bc">gridfire.gf_description</a> ()</td></tr>
<tr class="separator:afa60407432a1e563b9731ce298cf42bc"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a454366ce631749963d3c6b387bcbc3e7" id="r_a454366ce631749963d3c6b387bcbc3e7"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacegridfire.html#a454366ce631749963d3c6b387bcbc3e7">gridfire.gf_collaboration</a> ()</td></tr>
<tr class="separator:a454366ce631749963d3c6b387bcbc3e7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a787f9de5930793c2976d22426ae971b5" id="r_a787f9de5930793c2976d22426ae971b5"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacegridfire.html#a787f9de5930793c2976d22426ae971b5">gridfire.gf_credits</a> ()</td></tr>
<tr class="separator:a787f9de5930793c2976d22426ae971b5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a40cbecad1b1a87c6711ee7e20517f092" id="r_a40cbecad1b1a87c6711ee7e20517f092"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacegridfire.html#a40cbecad1b1a87c6711ee7e20517f092">gridfire.gf_get_include_dirs</a> ()</td></tr>
<tr class="separator:a40cbecad1b1a87c6711ee7e20517f092"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:adf54b5015a40a40f65c1400e9e4355f1" id="r_adf54b5015a40a40f65c1400e9e4355f1"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacegridfire.html#adf54b5015a40a40f65c1400e9e4355f1">gridfire.gf_get_lib_dirs</a> ()</td></tr>
<tr class="separator:adf54b5015a40a40f65c1400e9e4355f1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a350115e7c1a0b4d331afb4e6dc5b09df" id="r_a350115e7c1a0b4d331afb4e6dc5b09df"><td class="memItemLeft" align="right" valign="top">List[str]&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacegridfire.html#a350115e7c1a0b4d331afb4e6dc5b09df">gridfire.gf_get_rpath_flags</a> ()</td></tr>
<tr class="separator:a350115e7c1a0b4d331afb4e6dc5b09df"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9bdc5344d515db787a2bdceaa19dccf0" id="r_a9bdc5344d515db787a2bdceaa19dccf0"><td class="memItemLeft" align="right" valign="top">List[str]&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacegridfire.html#a9bdc5344d515db787a2bdceaa19dccf0">gridfire.gf_get_lib_flags</a> ()</td></tr>
<tr class="separator:a9bdc5344d515db787a2bdceaa19dccf0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a94f04c082dd84602da5431004e1ac96a" id="r_a94f04c082dd84602da5431004e1ac96a"><td class="memItemLeft" align="right" valign="top">List[str]&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacegridfire.html#a94f04c082dd84602da5431004e1ac96a">gridfire.gf_get_include_flags</a> ()</td></tr>
<tr class="separator:a94f04c082dd84602da5431004e1ac96a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6cf0ab33165c3069a2b4c196a04e12a7" id="r_a6cf0ab33165c3069a2b4c196a04e12a7"><td class="memItemLeft" align="right" valign="top">List[str]&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacegridfire.html#a6cf0ab33165c3069a2b4c196a04e12a7">gridfire.gf_get_extra_flags</a> ()</td></tr>
<tr class="separator:a6cf0ab33165c3069a2b4c196a04e12a7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab6c262cb95aefce7b7217be05def6a2c" id="r_ab6c262cb95aefce7b7217be05def6a2c"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacegridfire.html#ab6c262cb95aefce7b7217be05def6a2c">gridfire.gf_compiler_flags</a> (just_gridfire=False)</td></tr>
<tr class="separator:ab6c262cb95aefce7b7217be05def6a2c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a286ece04602867606e20af9f4f4ad4e7" id="r_a286ece04602867606e20af9f4f4ad4e7"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacegridfire.html#a286ece04602867606e20af9f4f4ad4e7">gridfire.gf_get_compiler_flags_formatted</a> (just_gridfire=False)</td></tr>
<tr class="separator:a286ece04602867606e20af9f4f4ad4e7"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="var-members" name="var-members"></a>
Variables</h2></td></tr>
<tr class="memitem:a2adfc910bd5466746bd71490d2cbdf1d" id="r_a2adfc910bd5466746bd71490d2cbdf1d"><td class="memItemLeft" align="right" valign="top">list&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacegridfire.html#a2adfc910bd5466746bd71490d2cbdf1d">gridfire.__all__</a> = ['type', 'utils', 'engine', 'solver', 'exceptions', 'partition', 'reaction', 'screening', 'io', 'policy', 'config']</td></tr>
<tr class="separator:a2adfc910bd5466746bd71490d2cbdf1d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:acb6c9c1b2920f0d1744a8e7198d2cf5b" id="r_acb6c9c1b2920f0d1744a8e7198d2cf5b"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacegridfire.html#acb6c9c1b2920f0d1744a8e7198d2cf5b">gridfire._meta</a> = importlib.metadata.metadata('gridfire')</td></tr>
<tr class="separator:acb6c9c1b2920f0d1744a8e7198d2cf5b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a14116c4fbbb07c2fa95826dc543771a2" id="r_a14116c4fbbb07c2fa95826dc543771a2"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacegridfire.html#a14116c4fbbb07c2fa95826dc543771a2">gridfire.__version__</a> = <a class="el" href="namespacegridfire.html#acb6c9c1b2920f0d1744a8e7198d2cf5b">_meta</a>['Version']</td></tr>
<tr class="separator:a14116c4fbbb07c2fa95826dc543771a2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3535aedf8a24266670197a715d91229c" id="r_a3535aedf8a24266670197a715d91229c"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacegridfire.html#a3535aedf8a24266670197a715d91229c">gridfire.__author__</a> = <a class="el" href="namespacegridfire.html#acb6c9c1b2920f0d1744a8e7198d2cf5b">_meta</a>['Authors']</td></tr>
<tr class="separator:a3535aedf8a24266670197a715d91229c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a23f04b652e06ef7660bed6ce2f36def8" id="r_a23f04b652e06ef7660bed6ce2f36def8"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacegridfire.html#a23f04b652e06ef7660bed6ce2f36def8">gridfire.__license__</a> = <a class="el" href="namespacegridfire.html#acb6c9c1b2920f0d1744a8e7198d2cf5b">_meta</a>['License']</td></tr>
<tr class="separator:a23f04b652e06ef7660bed6ce2f36def8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2aa7da424bb571416c8cfa93147b27ed" id="r_a2aa7da424bb571416c8cfa93147b27ed"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacegridfire.html#a2aa7da424bb571416c8cfa93147b27ed">gridfire.__email__</a> = <a class="el" href="namespacegridfire.html#acb6c9c1b2920f0d1744a8e7198d2cf5b">_meta</a>['Author-email']</td></tr>
<tr class="separator:a2aa7da424bb571416c8cfa93147b27ed"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a75069cd30950ced7af0da9454e4cc921" id="r_a75069cd30950ced7af0da9454e4cc921"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacegridfire.html#a75069cd30950ced7af0da9454e4cc921">gridfire.__url__</a> = <a class="el" href="namespacegridfire.html#acb6c9c1b2920f0d1744a8e7198d2cf5b">_meta</a>['Home-page'] or _meta.get('Project-URL', '').split(',')[0].split(' ')[-1].strip()</td></tr>
<tr class="separator:a75069cd30950ced7af0da9454e4cc921"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a62cc4eb0aa62cc209ee4583b8cc0df52" id="r_a62cc4eb0aa62cc209ee4583b8cc0df52"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacegridfire.html#a62cc4eb0aa62cc209ee4583b8cc0df52">gridfire.__description__</a> = <a class="el" href="namespacegridfire.html#acb6c9c1b2920f0d1744a8e7198d2cf5b">_meta</a>['Summary']</td></tr>
<tr class="separator:a62cc4eb0aa62cc209ee4583b8cc0df52"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af1322f32e7c01a82e55767967a23420d" id="r_af1322f32e7c01a82e55767967a23420d"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacegridfire.html#af1322f32e7c01a82e55767967a23420d">gridfire._PACKAGE_DIR</a> = Path(__file__).resolve().parent</td></tr>
<tr class="separator:af1322f32e7c01a82e55767967a23420d"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li><li class="navelem"><a class="el" href="dir_5c0d64f70903e893b1efe571a4b8de29.html">python</a></li><li class="navelem"><a class="el" href="dir_ca2c361745bc4f459bed9a105a1955b0.html">gridfire</a></li><li class="navelem"><a class="el" href="____init_____8py.html">__init__.py</a></li>
<li class="footer">Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.13.2 </li>
</ul>
</div>
</body>
</html>