Skip to content

Commit 98ae7ac

Browse files
Improved documentation in basics.rst.
1 parent 68902bc commit 98ae7ac

1 file changed

Lines changed: 13 additions & 19 deletions

File tree

docs/basics.rst

Lines changed: 13 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -8,14 +8,11 @@ started, make sure that the development environment is set up to compile the
88
included set of test cases.
99

1010

11-
Compiling the test cases
12-
========================
11+
Quick start
12+
===========
1313

14-
Linux/MacOS
15-
-----------
16-
17-
On Linux you'll need the `Hydra`_, `Pybind11`_ and the **cmake**. Also, you will
18-
be requiring the **python-dev** or **python3-dev** package. You can clone
14+
On Linux you'll need the `Hydra`_ and `Pybind11`_ projects as well as **cmake** to build. The **python-dev** or **python3-dev** package is required too.
15+
You can clone
1916
and fetch the latest code for both of the mentioned libraries. Then you could
2017
create a directory structure similar to below one.
2118

@@ -38,16 +35,15 @@ After downloading the prerequisites, run
3835
cmake -DHYDRA_INSTALL_PATH=../Hydra -DPYBIND11_INSTALL_PATH=../pybind11/include -DTHRUST_INSTALL_PATH=../Hydra ../Hydra.Python
3936
make all
4037
41-
The last line will both compile and create a shared ``.so`` file which can be
42-
imported in the python.
38+
The last line will both compile and create a shared ``.so`` file which is the library imported in python.
4339

4440
The best way to check if the installation is correct or not is to run the test
45-
cases provided in the Hydra.Python/tests.
41+
cases provided in the ``Hydra.Python/tests/`` directory.
4642

47-
Creating simple Vector4R particle and calculate it's mass
48-
=========================================================
43+
Creating a simple Lorentz vector and calculating the particle's mass
44+
====================================================================
4945

50-
Let's start by creating importing the module:
46+
Let's start by importing the module:
5147

5248
.. code-block:: python
5349
@@ -56,18 +52,16 @@ Let's start by creating importing the module:
5652
5753
The name ``HydraPython`` is quite long so generally, we use its alias as ``hp``.
5854

59-
Now that we have already imported the module let's just simply create a ``Vector4R``
60-
object.
55+
Now that we have already imported the module let's just simply create the particle Lorentz vector, i.e. the ``Vector4R`` instance.
6156

6257
.. code-block:: python
6358
6459
import HydraPython as hp
6560
vec4 = hp.Vector4R()
6661
print(vec4) # (0, 0, 0, 0)
6762
68-
So this is it. You just created a Vector4R object. The Vector4R object in Hydra
69-
is used as a ``particle``. This understanding is important when
70-
you will use the ``PhaseSpace`` class to generate the Events over N particles.
63+
So this is it. We've just created a ``Vector4R`` object represending the 4-momentum vector of a particle.
64+
This matter is important when the ``PhaseSpace`` class will be used to generate Events with N particles.
7165

72-
The next 3 pages explain the Vector classes (``Vector4R`` and ``Vector3R``), ``Events``
66+
The next 3 pages explain the Vector classes (``Vector4R`` and ``Vector3R``), the ``Events``
7367
classes and the ``PhaseSpace`` class in more detail.

0 commit comments

Comments
 (0)