Skip to content

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

42 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

CascadeDecays.jl

Test workflow status Docs workflow status Dev documentation

CascadeDecays.jl provides flat topology and routing utilities for sequential decay amplitudes. It connects static cascade definitions to event-by-event invariants and helicity-angle kinematics.

Installation

With the checked-in Manifest.toml and Julia 1.11.5, instantiate the project directly:

using Pkg
Pkg.activate(".")
Pkg.instantiate()

If you work with a different Julia version than the one used for this manifest, resolve the environment explicitly and install the non-registered dependencies first:

using Pkg
Pkg.activate(".")
Pkg.develop(url = "https://github.com/mmikhasenko/InstructionalDecayTrees.jl")
Pkg.instantiate()

Development

  • Run tests with julia --project=. test/runtests.jl.
  • Build the docs with julia --project=docs -e 'using Pkg; Pkg.instantiate()' followed by julia --project=docs docs/make.jl (requires Quarto). Documenter resolves @ref links during that build.
  • Render Quarto tutorials locally with bash docs/render-tutorials.sh (from the repo root) or quarto render docs/<tutorial>.qmd --to gfm.
  • When editing a tutorial, set cell output explicitly: the document default is output: false, so add #| output: true only on cells that should print tables or show return values; end other cells with nothing to avoid leaking the last expression.
  • Quarto sources live in docs/*.qmd and are compiled into docs/src/*.md by docs/make.jl.

About

General package for computing decay amplitudes using cascade basis

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages