-
Notifications
You must be signed in to change notification settings - Fork 147
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Rework jade getting started #3675
Open
rdebrand
wants to merge
5
commits into
cernopendata:qa
Choose a base branch
from
rdebrand:rdebrand-jade-getting-started
base: qa
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
5b8fda4
Rework jade-getting-started.md
rdebrand 81df9cd
Update jade-getting-started.md
rdebrand 9dab3f4
Update jade-getting-started.md
rdebrand 41b296b
Update jade-getting-started.md
rdebrand 2519c03
Update jade-getting-started.md
rdebrand File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
28 changes: 16 additions & 12 deletions
28
...pendata/modules/fixtures/data/docs/jade-getting-started/jade-getting-started.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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`. |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
BTW do you plan to version the images later? The
latest
tag has a drawback in that it evolves over time, so does not persistently identify the version, see e.g. this essay. When the image get stable, and before the release, it might be good to use semantic versioning and introduce a tag such as1.0
for persistence referencing to the image.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I will look at the issue.