-
Notifications
You must be signed in to change notification settings - Fork 0
/
README_8md_source.html
107 lines (105 loc) · 19 KB
/
README_8md_source.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.11"/>
<title>BubbleProfiler: /home/michael/bubbleprofiler_release/README.md Source File</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>
<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>
<script type="text/javascript">
$(document).ready(function() { init_search(); });
</script>
<script type="text/x-mathjax-config">
MathJax.Hub.Config({
extensions: ["tex2jax.js"],
jax: ["input/TeX","output/HTML-CSS"],
});
</script><script type="text/javascript" src="http://cdn.mathjax.org/mathjax/latest/MathJax.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="style.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 style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">BubbleProfiler
 <span id="projectnumber">0.3.0</span>
</div>
<div id="projectbrief">by Peter Athron, Csaba Balazs, Michael Bardsley, Andrew Fowlie, Dylan Harries & Graham White</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.11 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li><a href="annotated.html"><span>Classes</span></a></li>
<li class="current"><a href="files.html"><span>Files</span></a></li>
<li><a href="examples.html"><span>Examples</span></a></li>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</span>
</div>
</li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="files.html"><span>File List</span></a></li>
<li><a href="globals.html"><span>File Members</span></a></li>
</ul>
</div>
</div><!-- top -->
<!-- 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">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div class="header">
<div class="headertitle">
<div class="title">/home/michael/bubbleprofiler_release/README.md</div> </div>
</div><!--header-->
<div class="contents">
<a href="README_8md.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> BubbleProfiler</div><div class="line"><a name="l00002"></a><span class="lineno"> 2</span> ==============</div><div class="line"><a name="l00003"></a><span class="lineno"> 3</span> </div><div class="line"><a name="l00004"></a><span class="lineno"> 4</span> BubbleProfiler is a C++ library for calculating the bounce solution</div><div class="line"><a name="l00005"></a><span class="lineno"> 5</span> and Euclidean action associated with a cosmological phase transition.</div><div class="line"><a name="l00006"></a><span class="lineno"> 6</span> </div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span> Quickstart</div><div class="line"><a name="l00008"></a><span class="lineno"> 8</span> ==========</div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span> </div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span> Requirements</div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span> ------------</div><div class="line"><a name="l00012"></a><span class="lineno"> 12</span> </div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span> The following dependencies are required to build BubbleProfiler:</div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span> </div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span>  * [CMake] (version 2.8.12 or higher)</div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span>  * C++11 compatible compiler (g++ >= 4.8.1 or clang++ >= 3.8 or icpc >= 15.0)</div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span>  * [Boost] (version 1.53.0 or higher), specifically the components</div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span>  - Boost.Program\_options</div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span>  - Boost.Filesystem</div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span>  - Boost.System</div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span>  * [Eigen 3] (version 3.1.0 or higher)</div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span>  * [GiNaC] (version 1.6.2 or higher)</div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span>  * [GNU scientific library] (version 1.15 or higher)</div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span>  * [NLopt] (version 2.4.1 or higher)</div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span> </div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span> The following dependencies are optional:</div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span> </div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span>  * [Doxygen], for building the documentation</div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span>  * Python 2.7.x or Python 3.x, for running some examples</div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span> </div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span> Building BubbleProfiler</div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span> -----------------------</div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span> </div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span> BubbleProfiler uses CMake to configure its build system. To build the</div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span> library and command line executable,</div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span> </div><div class="line"><a name="l00037"></a><span class="lineno"> 37</span> 1. Create a build directory in which to build the package:</div><div class="line"><a name="l00038"></a><span class="lineno"> 38</span> </div><div class="line"><a name="l00039"></a><span class="lineno"> 39</span>  mkdir build</div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span> </div><div class="line"><a name="l00041"></a><span class="lineno"> 41</span> 2. Run CMake from this directory to configure the build system:</div><div class="line"><a name="l00042"></a><span class="lineno"> 42</span> </div><div class="line"><a name="l00043"></a><span class="lineno"> 43</span>  cd build</div><div class="line"><a name="l00044"></a><span class="lineno"> 44</span>  cmake ..</div><div class="line"><a name="l00045"></a><span class="lineno"> 45</span> </div><div class="line"><a name="l00046"></a><span class="lineno"> 46</span> 3. Compile the core library and command line executable:</div><div class="line"><a name="l00047"></a><span class="lineno"> 47</span> </div><div class="line"><a name="l00048"></a><span class="lineno"> 48</span>  cmake --build .</div><div class="line"><a name="l00049"></a><span class="lineno"> 49</span> </div><div class="line"><a name="l00050"></a><span class="lineno"> 50</span> 4. Optionally, build and run the unit tests:</div><div class="line"><a name="l00051"></a><span class="lineno"> 51</span> </div><div class="line"><a name="l00052"></a><span class="lineno"> 52</span>  cmake --build . --target 'check'</div><div class="line"><a name="l00053"></a><span class="lineno"> 53</span> </div><div class="line"><a name="l00054"></a><span class="lineno"> 54</span> 5. Optionally, build the example programs:</div><div class="line"><a name="l00055"></a><span class="lineno"> 55</span> </div><div class="line"><a name="l00056"></a><span class="lineno"> 56</span>  cmake --build . --target 'examples'</div><div class="line"><a name="l00057"></a><span class="lineno"> 57</span> </div><div class="line"><a name="l00058"></a><span class="lineno"> 58</span> 6. Optionally, build the package documentation:</div><div class="line"><a name="l00059"></a><span class="lineno"> 59</span> </div><div class="line"><a name="l00060"></a><span class="lineno"> 60</span>  cmake --build . --target 'docs'</div><div class="line"><a name="l00061"></a><span class="lineno"> 61</span> </div><div class="line"><a name="l00062"></a><span class="lineno"> 62</span> 7. Optionally, install the library and executables:</div><div class="line"><a name="l00063"></a><span class="lineno"> 63</span> </div><div class="line"><a name="l00064"></a><span class="lineno"> 64</span>  cmake --build . --target 'install'</div><div class="line"><a name="l00065"></a><span class="lineno"> 65</span> </div><div class="line"><a name="l00066"></a><span class="lineno"> 66</span> After building the package, the build directory will contain the</div><div class="line"><a name="l00067"></a><span class="lineno"> 67</span> subdirectories</div><div class="line"><a name="l00068"></a><span class="lineno"> 68</span> </div><div class="line"><a name="l00069"></a><span class="lineno"> 69</span>  * `bin/`, containing the main command line executable and the</div><div class="line"><a name="l00070"></a><span class="lineno"> 70</span>  example programs, if compiled</div><div class="line"><a name="l00071"></a><span class="lineno"> 71</span>  * `docs/`, containing the package documentation, if generated</div><div class="line"><a name="l00072"></a><span class="lineno"> 72</span>  * `examples/`, containing example scripts, if generated</div><div class="line"><a name="l00073"></a><span class="lineno"> 73</span>  * `include/`, containing generated header files</div><div class="line"><a name="l00074"></a><span class="lineno"> 74</span>  * `lib/`, containing the BubbleProfiler library</div><div class="line"><a name="l00075"></a><span class="lineno"> 75</span>  * `test/`, containing test binaries and output, if compiled</div><div class="line"><a name="l00076"></a><span class="lineno"> 76</span> </div><div class="line"><a name="l00077"></a><span class="lineno"> 77</span> For more detailed instructions and help with the build and installation</div><div class="line"><a name="l00078"></a><span class="lineno"> 78</span> process, refer to the accompanying INSTALL.md file.</div><div class="line"><a name="l00079"></a><span class="lineno"> 79</span> </div><div class="line"><a name="l00080"></a><span class="lineno"> 80</span> Running BubbleProfiler</div><div class="line"><a name="l00081"></a><span class="lineno"> 81</span> ----------------------</div><div class="line"><a name="l00082"></a><span class="lineno"> 82</span> </div><div class="line"><a name="l00083"></a><span class="lineno"> 83</span> BubbleProfiler consists of two core components, a command line executable</div><div class="line"><a name="l00084"></a><span class="lineno"> 84</span> for standalone use and a library to be used in your own programs. The</div><div class="line"><a name="l00085"></a><span class="lineno"> 85</span> executable `run_cmd_line_potential` calculates the action and, optionally,</div><div class="line"><a name="l00086"></a><span class="lineno"> 86</span> the field profiles for the bounce solution, given a potential and set of</div><div class="line"><a name="l00087"></a><span class="lineno"> 87</span> fields. For example, the bounce action for a potential involving two scalar</div><div class="line"><a name="l00088"></a><span class="lineno"> 88</span> fields may be calculated using</div><div class="line"><a name="l00089"></a><span class="lineno"> 89</span> </div><div class="line"><a name="l00090"></a><span class="lineno"> 90</span>  ./bin/run_cmd_line_potential \</div><div class="line"><a name="l00091"></a><span class="lineno"> 91</span>  --potential "(x^2 + y^2)*(1.8*(x - 1)^2 + 0.2*(y-1)^2 - 0.4)" \</div><div class="line"><a name="l00092"></a><span class="lineno"> 92</span>  --field x --field y --local-minimum 0 0</div><div class="line"><a name="l00093"></a><span class="lineno"> 93</span> </div><div class="line"><a name="l00094"></a><span class="lineno"> 94</span> A summary of the possible options for the program may be printed using</div><div class="line"><a name="l00095"></a><span class="lineno"> 95</span> `./bin/run_cmd_line_potential --help`. Detailed information about</div><div class="line"><a name="l00096"></a><span class="lineno"> 96</span> the program and its options may be found in the accompanying manual.</div><div class="line"><a name="l00097"></a><span class="lineno"> 97</span> </div><div class="line"><a name="l00098"></a><span class="lineno"> 98</span> Package content</div><div class="line"><a name="l00099"></a><span class="lineno"> 99</span> ===============</div><div class="line"><a name="l00100"></a><span class="lineno"> 100</span> </div><div class="line"><a name="l00101"></a><span class="lineno"> 101</span> The following subdirectories are included within the BubbleProfiler</div><div class="line"><a name="l00102"></a><span class="lineno"> 102</span> source distribution:</div><div class="line"><a name="l00103"></a><span class="lineno"> 103</span> </div><div class="line"><a name="l00104"></a><span class="lineno"> 104</span>  * `cmake/` contains modules and scripts used by the CMake build system</div><div class="line"><a name="l00105"></a><span class="lineno"> 105</span>  * `docs/` contains source files required for building the documentation</div><div class="line"><a name="l00106"></a><span class="lineno"> 106</span>  * `examples/` contains examples demonstrating the use of BubbleProfiler</div><div class="line"><a name="l00107"></a><span class="lineno"> 107</span>  * `include/` contains the C++ header files provided by the package</div><div class="line"><a name="l00108"></a><span class="lineno"> 108</span>  * `src/` contains the C++ source files from which the package is built</div><div class="line"><a name="l00109"></a><span class="lineno"> 109</span>  * `test/` contains the package unit tests</div><div class="line"><a name="l00110"></a><span class="lineno"> 110</span>  * `utils/` contains helpful utility scripts, primarily for the package</div><div class="line"><a name="l00111"></a><span class="lineno"> 111</span>  developers</div><div class="line"><a name="l00112"></a><span class="lineno"> 112</span> </div><div class="line"><a name="l00113"></a><span class="lineno"> 113</span> Additional information regarding the purpose and content of</div><div class="line"><a name="l00114"></a><span class="lineno"> 114</span> individual files in the package may be found in the documentation.</div><div class="line"><a name="l00115"></a><span class="lineno"> 115</span> </div><div class="line"><a name="l00116"></a><span class="lineno"> 116</span> License</div><div class="line"><a name="l00117"></a><span class="lineno"> 117</span> =======</div><div class="line"><a name="l00118"></a><span class="lineno"> 118</span> </div><div class="line"><a name="l00119"></a><span class="lineno"> 119</span> BubbleProfiler is licensed under the BSD 3-Clause license. See the</div><div class="line"><a name="l00120"></a><span class="lineno"> 120</span> accompanying LICENSE file for details.</div><div class="line"><a name="l00121"></a><span class="lineno"> 121</span> </div><div class="line"><a name="l00122"></a><span class="lineno"> 122</span> </div><div class="line"><a name="l00123"></a><span class="lineno"> 123</span> [Boost]: http://www.boost.org</div><div class="line"><a name="l00124"></a><span class="lineno"> 124</span> [CMake]: https://cmake.org</div><div class="line"><a name="l00125"></a><span class="lineno"> 125</span> [Doxygen]: http://www.doxygen.nl</div><div class="line"><a name="l00126"></a><span class="lineno"> 126</span> [Eigen 3]: http://eigen.tuxfamily.org</div><div class="line"><a name="l00127"></a><span class="lineno"> 127</span> [GiNaC]: http://www.ginac.de</div><div class="line"><a name="l00128"></a><span class="lineno"> 128</span> [GNU scientific library]: http://www.gnu.org/software/gsl</div><div class="line"><a name="l00129"></a><span class="lineno"> 129</span> [NLopt]: https://nlopt.readthedocs.io</div></div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Wed Jan 2 2019 13:08:19 for BubbleProfiler by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.11
</small></address>
</body>
</html>