diff --git a/README.md b/README.md index dda45ec88e2fca99a7ec8bcc68f2f9317ed7d857..473f0fc0db616e7ffe38526de28519761817b78c 100644 --- a/README.md +++ b/README.md @@ -7,7 +7,7 @@ Similar to JUNO Offline, two main structures exist: one is named **`algorithm`** ## Create your own algorithm -Create an algorithm named `ExampleAlg` in `./Analysis` +Create an **`algorithm`** named `ExampleAlg` in `./Analysis` ```bash cd Analysis mkdir ExampleAlg @@ -118,13 +118,13 @@ source setup.sh ``` ## How to add your own algorithm or tool -If the algorithm named `ExampleAlg` was created in `./Analysis`, the folder's name should be add in the `./Analysis/CMakeLists.txt` as +If the **`algorithm`** named `ExampleAlg` was created in `./Analysis`, the folder's name should be add in the `./Analysis/CMakeLists.txt` as ```cmake add_subdirectory(ExampleAlg) ``` ## How to run -There is an example of python script name `run.py` in `./share/`. When you want to run a new tool or algorithm, you can add them into a copy of run.py like +There is an example of python script name `run.py` in `./share/`. When you want to run a new **`tool`** or **`algorithm`**, you can add them into a copy of run.py like ```python import Sniper @@ -150,8 +150,11 @@ alg.property("evtMax").set(args.evtmax) alg.property("toolNameList").set(args.toollist) ``` +And the name of the **`tool`** should be added into `./share/toolList` + ```bash -python run.py --input [list of input] --output [output directory] --evtmax [the number of event will be processed for every ROOT file, -1 means all] --toollist [list of tool] +# python run.py --input [list of input] --output [output directory] --evtmax [the number of event will be processed for every ROOT file, -1 means all] --toollist [list of tool] +python run.py --input ./listOfInput --output ./result/ --evtmax -1 --toollist ./toolList ``` ## Suggestions