Data

Tools

Indexes

Applications

Experiments

Open Source Science

https://github.com/brainandforce/normalforms.jl

Calculation of Hermite and Smith normal forms in a single package.

https://github.com/brainandforce/normalforms.jl

Science Score: 13.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • ○
    CITATION.cff file
  • ✓
    codemeta.json file
    Found codemeta.json file
  • ○
    .zenodo.json file
  • ○
    DOI references
  • ○
    Academic publication links
  • ○
    Academic email domains
  • ○
    Institutional organization owner
  • ○
    JOSS paper metadata
  • ○
    Scientific vocabulary similarity
    Low similarity (14.3%) to scientific vocabulary
Last synced: 10 months ago · JSON representation

Repository

Calculation of Hermite and Smith normal forms in a single package.

Basic Info
  • Host: GitHub
  • Owner: brainandforce
  • License: other
  • Language: Julia
  • Default Branch: main
  • Size: 331 KB
Statistics
  • Stars: 6
  • Watchers: 2
  • Forks: 3
  • Open Issues: 3
  • Releases: 9
Created over 3 years ago · Last pushed over 1 year ago
Metadata Files
Readme Changelog License

README.md

NormalForms.jl

Documentation (stable) Documentation (dev) CI status Codecov Aqua.jl

This package allows for the calculation of both the Hermite and Smith normal forms, which are commonly used throughout crystallography.

Packages to calculate the Smith and Hermite normal forms already exist, but this package provides several advantages. First, it integrates into pre-existing infrastructure provided by the LinearAlgebra standard library by exporting the RowHermite, ColumnHermite, and Smith types, which are subtypes of LinearAlgebra.Factorization. Second, effort has been made to thoroughly comment the code so the algorithms can be easily understood. Third, the code is integrated with StaticArrays.jl, and methods are available for SMatrix, which cannot be mutated in-place.

The 0.1 series is compatible with Julia 1.6 and later. All future breaking releases will support the latest LTS at the time of their release. Therefore, you can expect version 0.2.0 to support Julia 1.10 and later.

Installation

NormalForms.jl is now in the Julia package registry! To install, just use the package manager: (@v1.6+) pkg> add NormalForms Alternatively: ``` julia> import Pkg

Pkg.add("NormalForms") You can also add the repo URL, with an optional specifier for the branch you want to track. By default, it tracks `main`. `release` matches the package state in the General repo. (@v1.6+) pkg> add https://github.com/brainandforce/NormalForms.jl#branchname Alternatively: julia> import Pkg

Pkg.add("https://github.com/brainandforce/NormalForms.jl", rev="branchname") ```

To-do list

This package is not in a finished state. The primary block to this is that some matrices cannot be placed in Hermite or Smith normal form because the unimodular factors fail to be unimodular. As of now, it's unclear what causes this to happen, but the solution may come in more extensive testing.

See also

For those interested in the Hermite and Smith normal forms in the context of abstract algebra:

Owner

  • Name: Brandon Flores
  • Login: brainandforce
  • Kind: user
  • Location: Madison, WI

Chemist in the Fredrickson Group at UW-Madison

GitHub Events

Total
  • Create event: 2
  • Commit comment event: 2
  • Release event: 1
  • Issues event: 6
  • Watch event: 1
  • Delete event: 1
  • Issue comment event: 7
  • Push event: 24
  • Pull request event: 3
  • Fork event: 2
Last Year
  • Create event: 2
  • Commit comment event: 2
  • Release event: 1
  • Issues event: 6
  • Watch event: 1
  • Delete event: 1
  • Issue comment event: 7
  • Push event: 24
  • Pull request event: 3
  • Fork event: 2

Issues and Pull Requests

Last synced: 10 months ago

All Time
  • Total issues: 12
  • Total pull requests: 14
  • Average time to close issues: 3 months
  • Average time to close pull requests: 5 days
  • Total issue authors: 4
  • Total pull request authors: 4
  • Average comments per issue: 2.75
  • Average comments per pull request: 0.86
  • Merged pull requests: 13
  • Bot issues: 0
  • Bot pull requests: 1
Past Year
  • Issues: 3
  • Pull requests: 3
  • Average time to close issues: 25 days
  • Average time to close pull requests: 22 days
  • Issue authors: 2
  • Pull request authors: 2
  • Average comments per issue: 1.33
  • Average comments per pull request: 1.33
  • Merged pull requests: 3
  • Bot issues: 0
  • Bot pull requests: 0
View more stats
Top Authors
Issue Authors
  • brainandforce (7)
  • glwhart (2)
  • justus-springer (2)
  • JuliaTagBot (1)
Pull Request Authors
  • brainandforce (10)
  • justus-springer (2)
  • arnedecadt (2)
  • github-actions[bot] (1)
Top Labels
Issue Labels
bug (2) help wanted (1) good first issue (1)
Pull Request Labels

Packages

  • Total packages: 1
  • Total downloads:
    • julia 4 total
  • Total dependent packages: 1
  • Total dependent repositories: 0
  • Total versions: 11
juliahub.com: NormalForms

Calculation of Hermite and Smith normal forms in a single package.

  • Versions: 11
  • Dependent Packages: 1
  • Dependent Repositories: 0
  • Downloads: 4 Total
Rankings
Dependent repos count: 9.9%
Dependent packages count: 38.9%
Average: 40.1%
Forks count: 53.5%
Stargazers count: 58.1%
Last synced: 10 months ago

Dependencies

.github/workflows/CI.yml actions
  • actions/checkout v3 composite
  • codecov/codecov-action v3 composite
  • julia-actions/cache v1 composite
  • julia-actions/julia-buildpkg v1 composite
  • julia-actions/julia-processcoverage v1 composite
  • julia-actions/julia-runtest v1 composite
  • julia-actions/setup-julia v1 composite
.github/workflows/TagBot.yml actions
  • JuliaRegistries/TagBot v1 composite
.github/workflows/documentation.yml actions
  • actions/checkout v3 composite
  • julia-actions/setup-julia v1 composite
.github/workflows/CompatHelper.yml actions