commit 060ed745ea470bbfb6ff66f9f73827b929d04255
parent 33df7c1b85103dd6b02ccedb8c388fd5f28259d3
Author: Christophe Coustet <christophe.coustet@meso-star.com>
Date: Wed, 6 Dec 2017 17:10:19 +0100
A pass on English.
Diffstat:
| M | star-engine.html.in | | | 112 | +++++++++++++++++++++++++++++++++++++++---------------------------------------- |
1 file changed, 55 insertions(+), 57 deletions(-)
diff --git a/star-engine.html.in b/star-engine.html.in
@@ -19,38 +19,36 @@
</ul>
</div>
-<p>The purpose of the Star-Engine is to provide a <b>development
-environment</b> for engineers and researchers that wish to use the
-<b>Monte-Carlo</b> method in order to perform numerical simulations. The
-Monte-Carlo method is indeed the only numerical method suitable for solving
-<b>high-dimensionality</b> integrals even when a <b>detailed 3D scene</b> has
-to be taken into account or if additional <b>coupled phenomena</b> have to be
+<p>The purpose of Star-Engine is to provide a <b>development environment</b>
+for engineers and researchers who wish to use the <b>Monte-Carlo</b> method in
+order to perform numerical simulations. The Monte-Carlo method is indeed the
+only numerical method suitable to solve <b>high-dimensional</b> integrals even
+if an <b>higly complex 3D scene</b> or many <b>coupled phenomena</b> have to be
considered.
-<p>Such complex situations are easily handled on the paper: physicists will
-essentially translate the <b>physical integral</b> they need to solve into a
-mathematical form that can be interpreted in terms of a Monte-Carlo algorithm.
-But then, developing the associated simulation code might be very difficult, if
-even possible, because mathematical expressions care little about data
-management, or what is even possible within the development environment. One
-good example would be a common integral over a surface: it is quite easy to
-write that you need to perform such an integral, but translating this need into
-a fast and accurate function that can be used for any given surface is no small
-feat.</p>
-
-<p>The Star-Engine provides such practical solutions: it can be seen as the
-bridge between a Monte-Carlo algorithm that exist only as mathematical
-expression and the actual numeric simulation code that uses this algorithm in
-order to evaluate the solution.</p>
-
-<h2>Parts of the Star-Engine</h2>
-
-<p>The Star-Engine is a collection of <b>C libraries</b> available for x86-64
-architectures on GNU/Linux as well as Microsoft Windows 7 and later. They are
+<p>On paper, such complex situations are easily handled: physicists will
+essentially translate the <b>integral</b> they need to solve into a
+mathematical form that can be read as a Monte-Carlo algorithm. But then,
+developing the associated simulation code might be very difficult, if even
+possible, because mathematical expressions do not provide any clue on data
+management concerns, or on how to address the development environment
+constraints. One good example would be a common integral over a surface: while
+it could be quite easy to write this integral, coding a fast and accurate
+function that can be used for any given surface is no small feat.</p>
+
+<p>Star-Engine provides such practical solutions: it can be seen as a bridge
+between a Monte-Carlo algorithm that exists only as a mathematical expression
+and the actual numerical simulation code that uses this algorithm in order to
+evaluate the solution.</p>
+
+<h2>Star-Engine components</h2>
+
+<p>Star-Engine is a collection of <b>C libraries</b> available for the x86-64
+architecture on GNU/Linux as well as Microsoft Windows 7 and later. It is
<b>free software</b> released under <a
-href=https://en.wikipedia.org/wiki/Copyleft>copyleft</a> licences. You are
+href=https://en.wikipedia.org/wiki/Copyleft>copyleft</a> licenses. You are
welcome to redistribute them under certain conditions. Refer to their
-associated licence for details.</p>
+associated license for details.</p>
<p>The core components of the Star-Engine framework and their functionalities
are briefly described below:</p>
@@ -91,8 +89,8 @@ are briefly described below:</p>
<h2>Related projects</h2>
-<p>The following software make use of the Star-Engine framework to implement
-Monte-Carlo solvers for a wide range of purposes. Refer to the their associated
+<p>The following softwares make use of Star-Engine to implement Monte-Carlo
+solvers for a wide range of purposes. Refer to the their associated
documentation for more informations.</p>
<ul>
@@ -110,22 +108,22 @@ documentation for more informations.</p>
<h2>Quick start</h2>
-<p>Get the desired archive of Solstice and verify its integrity against its <a
-href=pgp_signatures.html>PGP signature</a>. Then extract it. You can
-alternatively install the Star-Engine directly from the sources of its
-libraries. Refer the Star-Engine <a
+<p>Download the desired Solstice binary archive and check its integrity
+against its <a href=pgp_signatures.html>PGP signature</a>. Then extract it.
+You can alternatively install Star-Engine directly from source. Visit the
+Star-Engine <a
href="https://gitlab.com/meso-star/star-engine">git repository</a> for a
complete description of the procedure.</p>
-<p>Once installed, the directory of the Star-Engine looks like a regular Unix
+<p>Once installed, the directory of Star-Engine looks like a regular Unix
filesystem hierarchy:</p>
<ul>
<li>The <code>bin</code> directory stands for binary and contains the
- programs deployed with the Star-Engine.</li>
- <li><code>etc</code> stores configuration files. Its name stands for
+ programs deployed with Star-Engine.</li>
+ <li><code>etc</code> stores the configuration files. Its name stands for
<i>etcetera</i>. For instance, on GNU/Linux it contains the
- <code>star-engine.profile</code> bash script that, once "sourced", setup the
+ <code>star-engine.profile</code> bash script that when "sourced" setups the
environment of the current shell for the development of Star-Engine based
applications.</li>
<li>The <code>include</code> directory contains the header files of the
@@ -138,17 +136,17 @@ filesystem hierarchy:</p>
<h3>Raw compilation</h3>
-<p>Let a GNU/Linux environment and a project with a single source file named
-<code>main.c</code> that uses Star-SamPling to generate random numbers. To
-build the project executable, one has to first register the Star-Engine
+<p>Consider a GNU/Linux environment and a project with a single source file
+named <code>main.c</code> that uses Star-SamPling to generate random numbers.
+To build the project executable, one has first to register the Star-Engine
installation in the current shell by sourcing its "profile".</p>
<pre class="code">
$ source <STAR_ENGINE_DIR>/etc/star-engine.profile
</pre>
-<p>with <code><STAR_ENGINE_DIR></code> the install directory of the
-Star-Engine. Once done, assuming that <b>G</b>NU <b>C</b>ompiler
+<p>where <code><STAR_ENGINE_DIR></code> is the Star-Engine install
+directory. Once done, assuming that <b>G</b>NU <b>C</b>ompiler
<b>C</b>ollection is installed on the system, one can compile the program with
a regular <code>gcc</code> invocation.</p>
@@ -156,24 +154,24 @@ a regular <code>gcc</code> invocation.</p>
$ gcc main.c -lssp
</pre>
-<p>with <code>ssp</code> the name the <b>S</b>tar-<b>S</b>am<b>P</b>ling
+<p>where <code>ssp</code> is the name of the <b>S</b>tar-<b>S</b>am<b>P</b>ling
library in the <code><STAR_ENGINE_DIR>/lib</code> directory.</p>
-<p>Note that this procedure is practical for simple applications only. For more
+<p>Note that this procedure is only practical for simple projects. For more
advanced software one should rely on a build system like <a
href="https://www.gnu.org/software/make/">GNU Make</a> or <a
href="https://cmake.org/">CMake</a>.</p>
<h3>CMake build system</h3>
-<p>Star-Engine provides CMake packages that help programmers to use its
-libraries in their software relying on the CMake build system. To use these
-packages, at the CMake configuration step, add the Star-Engine install
-directory to the CMake search paths. Then use the CMake package mechanism to
-use the required Star-Engine libraries.</p>
+<p>Star-Engine comes with CMake packages that provide programmers using the
+CMake build system with a seamless integration of the Star-Engine libraries in
+their softwares. In order to use these packages, add the Star-Engine install
+directory to the CMake search paths at the CMake configuration step. Then use
+the CMake package mechanism to use the required Star-Engine libraries.</p>
-<p>For instance, let a project relying on the Star-3D and the Star-SamPling
-libraries, with a single source file <code>main.c</code> and a
+<p>For instance, consider a project relying on the Star-3D and the
+Star-SamPling libraries, with a single source file <code>main.c</code> and a
<code>CMakeLists.txt</code> file defined as follow:</p>
<pre class="code">
@@ -197,9 +195,9 @@ target_link_libraries(my_program StarSP Star3D)
cmake -G<CMAKE_GENERATOR> -DCMAKE_PREFIX_PATH=<STAR_ENGINE_DIR> <MY_PROJECT_DIR>
</pre>
-<p>with <code><CMAKE_GENERATOR></code> the host build system to use as
-for instance <code>"Unix Makefiles"</code>,
-<code><STAR_ENGINE_DIR></code> the install location of the Star-Engine
-and <code><MY_PROJECT_DIR></code> the directory where the aforementioned
-<code>CMakeLists.txt</code> file is stored.</p>
+<p>where <code><CMAKE_GENERATOR></code> is the build system to use (for
+instance <code>"Unix Makefiles"</code>), <code><STAR_ENGINE_DIR></code>
+is the Star-Engine install location and <code><MY_PROJECT_DIR></code> is
+the directory where the aforementioned <code>CMakeLists.txt</code> file is
+stored.</p>
