Commit f318c976 authored by Breno Rilho Lemos's avatar Breno Rilho Lemos 💬
Browse files

Improve README

parent 47457e20
...@@ -40,7 +40,7 @@ $ git clone https://git.cta.if.ufrgs.br/ALICE-open-data/alice-blender-animation. ...@@ -40,7 +40,7 @@ $ git clone https://git.cta.if.ufrgs.br/ALICE-open-data/alice-blender-animation.
Make sure the repository is inside the `alice` directory you created. Make sure the repository is inside the `alice` directory you created.
It is then time to download Blender, a free and open source software that is used for animating events. Stick to version 2.79b, or there is no It is then time to download Blender, a free and open source software that is used for animating events. Stick to version 2.79b, or there is no
guarantee the code will work. guarantee the code will work.
```bash ```bash
...@@ -53,10 +53,10 @@ Extract files from package: ...@@ -53,10 +53,10 @@ Extract files from package:
$ tar -jxvf blender-2.79b-linux-glibc219-x86_64.tar.bz2 $ tar -jxvf blender-2.79b-linux-glibc219-x86_64.tar.bz2
``` ```
The next step is to install Aliroot, which is CERN's official software for ALICE physics analysis, so you are able to process the relevant information The next step is to install Aliroot, which is CERN's official software for ALICE physics analysis, so you are able to process the relevant information
for the events. for the events.
In case you are not conCERNed about the data being used for the animation and only wish to generate a standard one, skip to the In case you are not conCERNed about the data being used for the animation and only wish to generate a standard one, skip to the
Default Animation section below. Default Animation section below.
Here is the sequence of steps for installing Aliroot: Here is the sequence of steps for installing Aliroot:
...@@ -79,27 +79,27 @@ $ aliDoctor AliPhysics ...@@ -79,27 +79,27 @@ $ aliDoctor AliPhysics
aliBuild build AliPhysics --defaults user -z aliroot5 aliBuild build AliPhysics --defaults user -z aliroot5
``` ```
After that, you are ready to pick an ESD file at CERN's Open Data Portal. ESD files regarding the ALICE experiment can be found on After that, you are ready to pick an ESD file at CERN's Open Data Portal. ESD files regarding the ALICE experiment can be found on
http://opendata.cern.ch/search?page=1&size=20&experiment=ALICE. You can either manually download your ESD file and save it in the http://opendata.cern.ch/search?page=1&size=20&experiment=ALICE. You can either manually download your ESD file and save it in the
project's repository directory (in the same path as this `README.md` file), under the name `AliESDs.root`, or have your ESD be downloaded automatically, as explained project's repository directory (in the same path as this `README.md` file), under the name `AliESDs.root`, or have your ESD be downloaded automatically, as explained
further. further.
Once you're all set, all there is left to do is run the `workflow_sketch.sh` script through your terminal. Don't forget to access the project's repository Once you're all set, all there is left to do is run the `workflow_sketch.sh` script through your terminal. Don't forget to access the project's repository
directory first: directory first:
```bash ```bash
$ cd ~/alice/alice-blender-animation $ cd ~/alice/alice-blender-animation
``` ```
The script offers several options in order to personalize the output. For example, in order to set the number of frames per second (fps) to 24 and the video The script offers several options in order to personalize the output. For example, in order to set the number of frames per second (fps) to 24 and the video
time duration to 8 seconds, one should run the command like this: time duration to 8 seconds, one should run the command like this:
```bash ```bash
./workflow_sketch.sh --fps 24 -t 8 ./workflow_sketch.sh --fps 24 -t 8
``` ```
As you can see, options are either preceded by double dashes (as in `--fps 24`) or by a single dash (as in `-t 8`). The option's value should follow As you can see, options are either preceded by double dashes (as in `--fps 24`) or by a single dash (as in `-t 8`). The option's value should follow
the option's name, also separated by a space. Some options, such as the `--download` option, don't expect arguments. When any available option is not called, it runs the option's name, also separated by a space. Some options, such as the `--download` option, don't expect arguments. When any available option is not called, it runs
the code with its standard value. See below for a detailed list of all the available options, which can also be checked out by entering: the code with its standard value. See below for a detailed list of all the available options, which can also be checked out by entering:
```bash ```bash
...@@ -112,7 +112,7 @@ In case you have chosen the automatic ESD download option, run the code as: ...@@ -112,7 +112,7 @@ In case you have chosen the automatic ESD download option, run the code as:
./workflow_sketch.sh --url <URL> --download ./workflow_sketch.sh --url <URL> --download
``` ```
where ``<URL>`` is the URL address for the chosen ESD file. Of course, you can add other options as well, if you wish. Here's another working example, including where ``<URL>`` is the URL address for the chosen ESD file. Of course, you can add other options as well, if you wish. Here's another working example, including
the download option: the download option:
```bash ```bash
...@@ -123,46 +123,46 @@ the download option: ...@@ -123,46 +123,46 @@ the download option:
Option Entry Action Standard Value Option Entry Action Standard Value
------------------- ------------------------- ------------------------------------------------------ ---------------- ------------------- ------------------------- ------------------------------------------------------ ----------------
-h or --help none Shows a list with all possible using options. - -h or --help none Shows a list with all possible using options. -
-d or -d or
--download none Informs to download the ESD file, rather than trying - --download none Informs to download the ESD file, rather than trying -
to find one locally to find one locally
-u or --url ESD file URL Informs ESD file URL, in case download option is - -u or --url ESD file URL Informs ESD file URL, in case download option is -
called called
-m ou Positive integer Sets the maximum number of particles allowed in the 1000 -m ou Positive integer Sets the maximum number of particles allowed in the 1000
--maxparticles events to be animated. --maxparticles events to be animated.
--minparticles Positive integer Sets the minimum number of particles allowed in the 0 --minparticles Positive integer Sets the minimum number of particles allowed in the 0
events to be animated. events to be animated.
-n or Non-negative integer Sets number of events to be animated inside chosen 10 -n or Non-negative integer Sets number of events to be animated inside chosen 10
--numberofevents ESD file --numberofevents ESD file
--minavgpz Positive number Gets only events for which the absolute value of 0 --minavgpz Positive number Gets only events for which the absolute value of 0
average momentum in the z direction is greater than average momentum in the z direction is greater than
or equal to the specified value, in GeV/c. Useful or equal to the specified value, in GeV/c. Useful
for animating events with 'boosts' of particles to for animating events with 'boosts' of particles to
the same side. the same side.
--minavgpt Positive number Get only events for which the average transversal 0 --minavgpt Positive number Get only events for which the average transversal 0
momentum is greater than or equal to the specified momentum is greater than or equal to the specified
value, in GeV/c. Useful for animating events with value, in GeV/c. Useful for animating events with
'boosts' of particles on the xy plane. 'boosts' of particles on the xy plane.
-t or -t or
--duration Positive integer Sets animation duration, in seconds 10 --duration Positive integer Sets animation duration, in seconds 10
-r ou --radius Positive number Scales the particle's radius to the informed value 1 -r ou --radius Positive number Scales the particle's radius to the informed value 1
--resolution Whole number from Sets animation resolution percentage. 100 --resolution Whole number from Sets animation resolution percentage. 100
1 to 100 1 to 100
--fps Positive integer Sets animation number of frames per second 24 --fps Positive integer Sets animation number of frames per second 24
--transparency Positive number Sets detector transparency, where zero is full 1 --transparency Positive number Sets detector transparency, where zero is full 1
transparency and 1 is standard transparency transparency and 1 is standard transparency
-c ou --cameras Comma-separated list Sets cameras to animate events with Overview -c ou --cameras Comma-separated list Sets cameras to animate events with Overview
(with no spaces) of (with no spaces) of
cameras. Options: cameras. Options:
...@@ -170,39 +170,38 @@ the download option: ...@@ -170,39 +170,38 @@ the download option:
Overview, Side, Overview, Side,
Moving1, Moving2, Moving1, Moving2,
Moving3, Moving4 Moving3, Moving4
--mosaic none Makes animations in four different cameras (Barrel, - --mosaic none Makes animations in four different cameras (Barrel, -
Forward, Overview and Moving1) and combines them Forward, Overview and Moving1) and combines them
into a single 2x2 clip containing all four into a single 2x2 clip containing all four
perspectives. perspectives.
--picpct Whole number from Informs percentage of animation to take HD picture, 80 --picpct Whole number from Informs percentage of animation to take HD picture, 80
1 to 100 saved along with the clip. 1 to 100 saved along with the clip.
--bgshade Number from 0 to 1 Set background shade of black to VALUE, where 0 is 0 --bgshade Number from 0 to 1 Set background shade of black to VALUE, where 0 is 0
totally black and 1 is totally white. totally black and 1 is totally white.
-a ou --sample none Creates a sample Blender animation of Event 2 from - -a ou --sample none Creates a sample Blender animation of Event 2 from -
URL http://opendata.cern.ch/record/1102/files/asset URL http://opendata.cern.ch/record/1102/files/asset
s/alice/2010/LHC10h/000139038/ESD/0001/AliESDs.root s/alice/2010/LHC10h/000139038/ESD/0001/AliESDs.root
--its none Removes ITS detector from animation - --its none Removes ITS detector from animation -
--detailedtpc none Includes a more detailed version of the TPC - --detailedtpc none Includes a more detailed version of the TPC -
geometry, made by researcher Stefan Rossegger geometry, made by researcher Stefan Rossegger
(stefan.rossegger@gmail.com)
--tpc none Removes TPC detector from animation -
--tpc none Removes TPC detector from animation -
--trd none Removes TRD detector from animation - --trd none Removes TRD detector from animation -
--emcal none Removes EMCal detector from animation - --emcal none Removes EMCal detector from animation -
--blendersave none Saves Blender file along with animation clip - --blendersave none Saves Blender file along with animation clip -
----------------------------------------------------------------------- -----------------------------------------------------------------------
After running the script, it may take a long time to generate all the animations, but as soon as it is done, they will be available inside a new directory uniquely After running the script, it may take a long time to generate all the animations, but as soon as it is done, they will be available inside a new directory uniquely
identified according to the chosen ESD file. Each clip is also identified by event number. Enjoy! identified according to the chosen ESD file. Each clip is also identified by event number. Enjoy!
...@@ -214,5 +213,5 @@ For generating a default animation, simply run the script `workflow_sketch.sh` i ...@@ -214,5 +213,5 @@ For generating a default animation, simply run the script `workflow_sketch.sh` i
./workflow_sketch.sh -a ./workflow_sketch.sh -a
``` ```
After this, a single default animation should be ready. It will be available inside the `blender` directory, in *.mp4* format. Enjoy! You may want to check the table After this, a single default animation should be ready. It will be available inside the `blender` directory, in *.mp4* format. Enjoy! You may want to check the table
above for information on the using options. above for information on the using options.
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment