Skip to content
Snippets Groups Projects
Commit f19c69f3 authored by adrien-matta's avatar adrien-matta
Browse files

* Upadating README.md

parent 24704a50
No related branches found
No related tags found
No related merge requests found
...@@ -6,9 +6,9 @@ The NPTool package is based on Root and Geant4. It is aimed to assist experiment ...@@ -6,9 +6,9 @@ The NPTool package is based on Root and Geant4. It is aimed to assist experiment
#Getting the code #Getting the code
### Using git ### Using git
The recommended method to obtain the code is to use git. This insure an easy way to access the update version of the code. First make sure you got git installed, if not, just use your package manager to get it. Then go to the directory where you want to install the nptool folder and type: The recommended method to obtain the code is to use git. This insure an easy way to access the update version of the code. First make sure you got git installed, if not, just use your package manager to get it. Then go to the directory where you want to install the nptool folder and type:
````
>git clone https://github.com/adrien-matta/nptool $ git clone https://github.com/adrien-matta/nptool
````:
This will create the nptool folder with the latest version of nptool. This will create the nptool folder with the latest version of nptool.
### Downloading from Git Hub ### Downloading from Git Hub
...@@ -24,32 +24,46 @@ NPLib is the core of the NPTool package, holding most of the actual code. It is ...@@ -24,32 +24,46 @@ NPLib is the core of the NPTool package, holding most of the actual code. It is
>source /path/to/nptool/nptool.sh >source /path/to/nptool/nptool.sh
Restart your terminal. You should now have all aliases and environment variable properly defined and can now access the NPLib folder by using the command: Restart your terminal. You should now have all aliases and environment variable properly defined and can now access the NPLib folder by using the command:
> NPL ````
$ NPL
````
and you should be in the NPLib directory. and you should be in the NPLib directory.
Before the compilation of the libraries you need to specify the detector you plan to use by calling the configure script. If you give no argument to configure, all detector will be compile. If you wish to limit the number of detector to be compiled, simply specify the detector name in lowercase (e.g. MUST2 -> must2). You can specify more than one detector: Before the compilation of the libraries you need to specify the detector you plan to use by calling the configure script. If you give no argument to configure, all detector will be compile. If you wish to limit the number of detector to be compiled, simply specify the detector name in lowercase (e.g. MUST2 -> must2). You can specify more than one detector:
> ./configure must2 sharc plastic riken ````
$ ./configure must2 sharc plastic riken
````
Then you can compile NPLib by calling You have to performe the configure operation only once, then you compile the whole NPLib with:
> make -jn
where n is the number of core to be used in the compilation. ````
$ make -jn
````
In order to load the nptool libraries when you launch root, you need to add a few line to your ~/.rootlogon.C file. NPTool can do that safely for you using a script. To launch the script simply type: where you replace n is the number of core to be used in the compilation.
> make rootlogon
If you wish to compile only one subdirectory, simply add the name of the directory in lower case, e.g. for compiling the Physics directory:
````
$ make -jn Physics
````
In order to load the nptool libraries when you launch root, you need to add a few line to your ~/.rootlogon.C file. NPTool can do that safely for you using a script. To launch the script simply type:
````
$ make rootlogon
````
Depending on the existence of the .rootlogon.C file in your home directory, the output of the script might be different. If you already have a .rootlogon.C file that make reference to nptool then the script will leave it unchanged. Depending on the existence of the .rootlogon.C file in your home directory, the output of the script might be different. If you already have a .rootlogon.C file that make reference to nptool then the script will leave it unchanged.
###Building NPSimulation ###Building NPSimulation
This part of the package rely on Geant4 to perform Monte Carlo simulation. You need to first compile and configure correctly NPLib in order for NPSimulation to compile and run. The compilation is done as follow: This part of the package rely on Geant4 to perform Monte Carlo simulation. You need to first compile and configure correctly NPLib in order for NPSimulation to compile and run. The compilation is done as follow:
```` ````
NPS $ NPS
make -jn $ make -jn
````` `````
This should produce the NPSimulation executable, you can check this by running the help display This should produce the NPSimulation executable, you can check this by running the help display
> NPSimulation -h ````
$ NPSimulation -h
````
THIS FILE IS UNDER DEVELOPMENT THIS FILE IS UNDER DEVELOPMENT
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment