Skip to content

Commit

Permalink
Updated banners in ReadMe
Browse files Browse the repository at this point in the history
  • Loading branch information
peremato committed Sep 25, 2024
1 parent f84b820 commit 160c4da
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 3 deletions.
8 changes: 7 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,12 @@
<img src="docs/src/assets/pythia-logo-b.png" alt="Pythia8" width="100"/>
</a>

## Description
[![Dev](https://img.shields.io/badge/docs-dev-blue.svg)](https:///JuliaHEP.github.io/Pythia8.jl/dev/)
[![Build Status](https://github.com/JuliaHEP/XRootD.jl/workflows/CI/badge.svg)](https://github.com/JuliaHEP/Pythia8.jl/actions)
[![License](https://img.shields.io/badge/license-GPL-blue.svg)](LICENSE)

## Pythia8.jl
Julia bindings for the [Pythia8](https://pythia.org) generator of high-energy physics collision events.

See the [documentation](https:///JuliaHEP.github.io/Pythia8.jl) for the installation and basic usage.

4 changes: 2 additions & 2 deletions docs/src/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ julia> list(csets, "Init:")
```
Note that class methods are called with the object instance as first argument. In C++ the `parm(...)` method of the `Settings` class would be called as `csets.parm("Beams:eA")` being `csets` an instance of `Settings`, while in Julia it is called as `parm(csets, "Beams:eA")`. Thanks to the Julia multi-dispatch we do not need to prefix the methods with the module name `Pythia8.parm`, even for very common function names such as `list`.

Also notice that the default printout of any wrapped object is the form `C++ type(at some address @0xXXXXXX)` like this one: `CxxRef{Pythia8!Settings}(Ptr{Pythia8!Settings} @0x00000001200d02d0)`. In this particular example the C++ type is a reference to `Pythia8::Settings` and the object is at the memory address `0x00000001200d02d0`.
Also notice that the default printout of any wrapped object is of the form `C++/Julia type(at some address @0xXXXXXX)` like this one: `CxxRef{Pythia8!Settings}(Ptr{Pythia8!Settings} @0x00000001200d02d0)`. In this particular example, the C++ type is a reference to `Pythia8::Settings` and the object is at the memory address `0x00000001200d02d0`.

## Examples
Currently the following examples are implemented replicating the equivalent Python ones.
Expand All @@ -67,7 +67,7 @@ Simple test program to illustrate the usage of `PythiaParallel` in Julia. The ph
Example how you can use `UserHooks` to trace pT spectrum through the program, and veto undesirable jet multiplicities. It is based on `main242.cc`.

## Tests
Unit tests can be run with `julia --project=. test/runtests.jl`. It runs in addition all the implemented examples to ensure their correct execution and detect any regression.
Unit tests can be run with `julia --project=. test/runtests.jl`. It runs in addition all the implemented examples to ensure their correct execution and detection of any regression.

## Roadmap
There are a number of issues and problems still to be resolved. We keep track of them in this list:
Expand Down

0 comments on commit 160c4da

Please sign in to comment.