Difference between revisions of "DF DCTrackVisualizer Install and Run Instruction"
Jump to navigation
Jump to search
(Created page with "These instruction are specifically for installing and running the DCTrackVisualizer program. =Install= *If you intend to work on the code, install NetBeans if you haven't alre...") |
|||
| (9 intermediate revisions by 2 users not shown) | |||
| Line 5: | Line 5: | ||
*Clone the following Github repository: | *Clone the following Github repository: | ||
**[https://github.com/friadavi/clas12-offline-software friadavi/clas12-offline-software] | **[https://github.com/friadavi/clas12-offline-software friadavi/clas12-offline-software] | ||
| − | **<code>git clone https://github.com/friadavi/clas12-offline-software.git</code> | + | **<code>git clone <nowiki>https://github.com/friadavi/clas12-offline-software.git</nowiki></code> |
*Checkout the dcVisualizer branch | *Checkout the dcVisualizer branch | ||
**<code>git checkout dcVisualizer</code> | **<code>git checkout dcVisualizer</code> | ||
| Line 13: | Line 13: | ||
=Running= | =Running= | ||
| − | Simply run <code><install directory>/coatjava/bin/dctrackviz</code>. Note that it may be necessary to use <code>bash</code> instead of <code>./</code> as the script may not source <code>env.sh</code> otherwise. | + | Simply run <code><install directory>/clas12-offline-software/coatjava/bin/dctrackviz</code>. Note that it may be necessary to use <code>bash</code> instead of <code>./</code> as the script may not source <code>env.sh</code> otherwise. |
| + | =Install within Netbeans= | ||
| + | To open the project in NetBeans: | ||
| + | *Open NetBeans | ||
| + | *Click on File > Open Project | ||
| + | *Go to the install directory | ||
| + | *Open the project clas-viz under clas12-offline-software > common-tools. | ||
| + | *Edit to your heart's delight. | ||
| + | You may need to change the default run directory: | ||
| + | *In the projects pane, right click on clas-viz | ||
| + | *Click on properties | ||
| + | *Click on "Run" in the Categories pane | ||
| + | *Change the working directory to point to your <code>clas12-offline-software</code> directory. | ||
| + | Also Ensure that the following environmental variables are set within NetBeans: | ||
| + | *Open the Project Properties window. | ||
| + | *Click on "Actions" | ||
| + | *Select "Run project" from the "Actions sub-menu" | ||
| + | *Set the following properties: | ||
| + | **<code>Env.CLAS12DIR=path/to/clas12-offline-software/coatjava</code> | ||
| + | ***This can be either an absolute path or a path relative to the working directory you've set. | ||
| + | **<code>Env.SOLENOIDMAP=<name of the solenoid map file you want to use>.dat</code> | ||
| + | **<code>Env.TORUSMAP=<name of the torus map file you want to use>.dat</code> | ||
| + | ==Error Messages== | ||
| + | Put new error messages here: | ||
| + | * | ||
=Main Page= | =Main Page= | ||
[[User:Friadavi]] | [[User:Friadavi]] | ||
Latest revision as of 22:03, 22 December 2018
These instruction are specifically for installing and running the DCTrackVisualizer program.
Install
- If you intend to work on the code, install NetBeans if you haven't already. See here for details.
- Move to or create you're preferred directory. I would suggest NetBeansProjects as a default.
- Clone the following Github repository:
- friadavi/clas12-offline-software
git clone https://github.com/friadavi/clas12-offline-software.git
- Checkout the dcVisualizer branch
git checkout dcVisualizer
- Execute
build-coatjava.sh- I recommend appending
--nounittestsand--nospotbugsso that the build doesn't take forever.
- I recommend appending
- The software should now be installed.
Running
Simply run <install directory>/clas12-offline-software/coatjava/bin/dctrackviz. Note that it may be necessary to use bash instead of ./ as the script may not source env.sh otherwise.
Install within Netbeans
To open the project in NetBeans:
- Open NetBeans
- Click on File > Open Project
- Go to the install directory
- Open the project clas-viz under clas12-offline-software > common-tools.
- Edit to your heart's delight.
You may need to change the default run directory:
- In the projects pane, right click on clas-viz
- Click on properties
- Click on "Run" in the Categories pane
- Change the working directory to point to your
clas12-offline-softwaredirectory.
Also Ensure that the following environmental variables are set within NetBeans:
- Open the Project Properties window.
- Click on "Actions"
- Select "Run project" from the "Actions sub-menu"
- Set the following properties:
Env.CLAS12DIR=path/to/clas12-offline-software/coatjava- This can be either an absolute path or a path relative to the working directory you've set.
Env.SOLENOIDMAP=<name of the solenoid map file you want to use>.datEnv.TORUSMAP=<name of the torus map file you want to use>.dat
Error Messages
Put new error messages here: