Skip to content

Commit

Permalink
docs: add instructions how to run JADE software container
Browse files Browse the repository at this point in the history
Add first concrete instructions on how to install and run the JADE
software container.
  • Loading branch information
rdebrand authored and tiborsimko committed Sep 29, 2024
1 parent f0ab142 commit 833c8c2
Showing 1 changed file with 16 additions and 12 deletions.
28 changes: 16 additions & 12 deletions data/docs/jade-getting-started/jade-getting-started.md
Original file line number Diff line number Diff line change
@@ -1,21 +1,25 @@
Learn how to use the JADE virtual machine to have a first look at JADE events and use analysis tools:
Learn how to use the JADE software to have a first look at JADE events and use analysis tools:

1. ["How do I start JADE software?"](#start)
2. ["What kind of JADE data will I work on?"](#data)
3. ["I have installed VirtualBox, downloaded JADE VM image and launched it. And now?"](#vbox)
2. ["Installing the JADE software with Docker"](#docker)
3. ["Testing the installed software and running simple data analysis"](#test)

## <a name="start">"How do I start JADE software?"</a>

JADE software comes via a virtual machine image. The only thing you need to
install by yourself on you desktop is VirtualBox. Then you just need to
download the JADE virtual machine image open it with VirtualBox. See
instructions [here](/docs/jade-virtual-machine).
JADE software needs to be run inside a container, e.g. with Docker or Podman. The corresponding GitHub repository can be found [here](https://github.com/andriish/JADE).

## <a name="data">"What kind of JADE data will I work on?"</a>
## <a name="docker">"Installing the JADE software with Docker"</a>

The data samples you can download from this portal consists all events
collected by the JADE.
It is required to have Docker installed and the repository cloned, e.g. with `git clone https://github.com/rdebrand/JADE --branch software-only --depth 1` (will take up to 730 MB disk space, for additional documentation check out the gihub repository).

## <a name="vbox">"I have installed VirtualBox, downloaded JADE VM image and launched it. And now?"</a>
1. Pull the image with `docker pull ghcr.io/andriish/fedora39x86_64i686_gnu:latest`
2. Run the container `docker run -it --platform linux/amd64 --name jade_soft -v $PWD:/home ghcr.io/andriish/fedora39x86_64i686_gnu` \
The `-v` option will mount the current directory (where it might be necessary to use `$(pwd)` instead of `$PWD` if an error occurs) to the home directory inside the container. It is thus useful to set the working directory beforehand to the cloned repository to conveniently run the software scripts and programs. \
Note that not specifying a platform will result in the container software trying to run the image on the hosts platform type, while the image requires to be run on the linux/amd64 platform. The `-it` (interactive, tty) option is also necessary to keep the container running and be interactive, else it might close immediately.
3. Inside the container navigate to the JADE directory with `cd /home/JADE` and run `sh ./jadeinstall.sh --bits=32` \
Note that everything inside the container has to be run with 32 bits, as most of the packages (especially Cernlib) only support this architecture. \
4. The container can be exited by invoking `exit` and one can attach again with `docker start jade_soft` followed by `docker attach jade_soft`

FIXME
## <a name="test">"Testing the installed software and running simple data analysis"</a>

While still attached to the container, the software can simply be tested with `sh ./jadetest.sh --bits=32`.

0 comments on commit 833c8c2

Please sign in to comment.