Skip to content

Repository files navigation

ReducedBasisMethods.jl

Stable Latest PkgEval Status Build Status Coverage

This package implements structure-preserving reduced basis methods.

Installation

ReducedBasisMethods.jl and all of its dependencies can be installed via the Julia REPL by typing

]add ReducedBasisMethods

Development

This package does not currently load. src/ReducedBasisMethods.jl does using VlasovMethods, but VlasovMethods is declared in neither [deps] nor Manifest.toml. CI is expected to be red, and the pre-commit load test below will block any commit that stages a .jl file until that is addressed.

Git hooks

Two hooks live in .githooks. They are not active in a fresh clonecore.hooksPath is local configuration and does not travel with a push — so enable them once per clone:

git config core.hooksPath .githooks

pre-commit acts on staged .jl files only, and exits immediately when a commit stages none, so a documentation- or workflow-only commit is not slowed down by it:

  • JuliaFormatter --check, honouring this repository's own .JuliaFormatter.tomlblocks the commit. Formatting is mechanical and always fixable.
  • fatou lint, when fatou is installed — advisory only, and deliberately so: its unused-import rule does not follow include, so it flags the load-bearing imports of every module file.
  • using <Package>, which catches a syntax error or a broken includeblocks.

pre-push runs the full test suite with --check-bounds=auto, but only when pushing to main or master; a topic branch is left to CI. It prints nothing for 10–30 minutes, which looks exactly like a network hang and is not one. If you do interrupt it, check for an orphaned Julia process that the killed hook left behind.

Either hook can be bypassed for a single command with --no-verify, for a change you know it does not apply to:

git commit --no-verify
git push --no-verify

The hooks are generated from one shared copy and are byte-identical across the related repositories, so edit them there rather than here — a local edit is silently undone by the next install.

About

Reduced Basis Methods for Particle Systems

Resources

Stars

1 star

Watchers

1 watching

Forks

Releases

Packages

Contributors

Languages