Skip to content

UTA-Advanced-Detector-Technologies/QpixHub

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

19 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

QpixHUB

Q-Pix one stop shop for all analysis software.

We put everything we can onto docker so that there are no longer install or system dependencies for building and testing.

Getting Started

Required Programs

Running the Container

  • Open Docker Desktop App
  • Start Your X Server (Can check if it is running in the task bar hidden icons)
  • Open Windows PowerShell
  • In PowerShell clone the QpixHub repository:
git clone https://github.com/UTA-Advanced-Detector-Technologies/QpixHub
  • Enter the new QpixHub directory. Note: Must be in QpixHub to start the container.
cd QpixHub
  • Start the qpix-analysis container with the docker compose up command. This should make a running qpixhub container in Docker desktop.
docker compose up -d qpix-analysis
  • Open VS Code. NOTE: If you start VS Code before your X-Server, Root and Geant4 will not display properly This is easily remedied by restarting VS Code
  • From VS Code attach to running container and select QpixAnalysis
  • This should make a new VS Code window from which you can operate inside the container using the terminal
  • NOTE: Any changes you make in the container will not be saved unless stored in the “data” directory. Additionally, you can transfer files from the container to your computer by putting them in “data”.
  • To close the container use docker compose down in powershell. This will stop the container and disconnect your VS Code window
docker compose down qpix-analysis

Build an Example

An easy way to check if your X-Server is set up and connected properly is to build the geant4 example B1.

  • Enter the B1 directory
cd cern/geant4/examples/basic/B1
  • Make and enter a build directory
mkdir build; cd build
  • Build B1
cmake ..;
cmake --build . -j 10
  • Run B1
./exampleB1

This should run the B1 example and open a UI window. Seeing this you are all set!

QpixNeut

  • TODO Qpix neutrino analysis applications (coming soon)

example

notebooks

from inside shell run:

jupyter notebook --ip='0.0.0.0' --port=80 --no-browser --allow-root

mounting a directory

  • Note: this is done for you automatically with docker compose run qpix-analysis

option: -v notes: <source_path>:<dest_path> windows exampe:

docker run -v ${PWD}/data/:/home/data -it qpixhub

nix example:

docker run -v $(PWD)/data/:/home/data -it qpixhub

-- run from top level

Troubleshooting

good luck.

Dependencies

Listed below are the dependencies, and their respective versions

ROOT

v6.30

Geant4

Geant4-10.7.4

Marley

GENIE, GSL, libLHAPDFv5, Pythia

Includied in dependencies or explicitly cloned to specific locations

Optix

TODO

  • must move Geant4 to 4.11.1.1 first

run on windows wsl2 to get gui access:

docker run --rm --net host -it -e DISPLAY=:0.0 -v /tmp/.X11-unix:/tmp/.X11-unix papahuhu/qpixana

note: this is observed working only with x410 xforwarding server on windows.

About

Base Docker image which comes with baseline development environment for Q-Pix analysis repos

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 2

  •  
  •  

Languages