tensors.jl

Efficient computations with symmetric and non-symmetric tensors with support for automatic differentiation.

https://github.com/ferrite-fem/tensors.jl

Science Score: 67.0%

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

  • CITATION.cff file
    Found CITATION.cff file
  • codemeta.json file
    Found codemeta.json file
  • .zenodo.json file
    Found .zenodo.json file
  • DOI references
    Found 1 DOI reference(s) in README
  • Academic publication links
  • Committers with academic emails
    4 of 17 committers (23.5%) from academic institutions
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (20.2%) to scientific vocabulary

Keywords

automatic-differentiation cfd finite-elements symmetric-tensors tensor

Keywords from Contributors

julialang unconstrained-optimization unconstrained-optimisation optimisation optim physics dynamical-systems flux chaos the-human-brain
Last synced: 6 months ago · JSON representation ·

Repository

Efficient computations with symmetric and non-symmetric tensors with support for automatic differentiation.

Basic Info
Statistics
  • Stars: 180
  • Watchers: 12
  • Forks: 37
  • Open Issues: 32
  • Releases: 46
Topics
automatic-differentiation cfd finite-elements symmetric-tensors tensor
Created about 9 years ago · Last pushed 7 months ago
Metadata Files
Readme Changelog License Citation

README.md

Tensors.jl

Efficient computations with symmetric and non-symmetric tensors with support for automatic differentiation.

| Documentation | Build Status | |:---------------------------------------:|:-----------------------------------------------------:| | | |

Introduction

This Julia package provides fast operations with symmetric and non-symmetric tensors of order 1, 2 and 4. The tensors are allocated on the stack which means that there is no need to preallocate output results for performance. Unicode infix operators are provided such that the tensor expression in the source code is similar to the one written with mathematical notation. When possible, symmetry of tensors is exploited for better performance. Supports Automatic Differentiation to easily compute first and second order derivatives of tensorial functions.

Installation

The package can be installed with the Julia package manager. From the Julia REPL, type ] to enter the Pkg REPL mode and run:

pkg> add Tensors

Or, equivalently, via the Pkg API:

julia julia> import Pkg; Pkg.add("Tensors")

Documentation

  • STABLEmost recently tagged version of the documentation.

Project Status

The package is tested against Julia 1.X on Linux, macOS, and Windows.

Contributing and Questions

Contributions are very welcome, as are feature requests and suggestions. Please open an issue if you encounter any problems.

Things to work on

If you are interested in contributing to Tensors.jl, here are a few topics that can get you started:

  • Implement support for third order tensors. These are more rarely used than first, second and fourth order tensors but are still useful in some applications. It would be good to support this.
  • Find a way to reduce code duplication without sacrificing performance or compilation time. Currently, there is quite a lot of code duplication in the implementation of different operators. It should be possible to have a higher level code generation framework that generates optimized functions from pretty much only the Einstein summation notation for the operation.
  • Tensors.jl has been developed with mostly the application to continuum mechanics in mind. For other fields, perhaps other tensor operations are useful. Implement these in a well performant manner and give good test coverage and documentation for the new functionalities.

Citing Tensors.jl

If you use Tensors.jl for research and publication, please cite the following article @article{Tensors.jl, title = {Tensors.jl -- Tensor Computations in Julia}, author = {Carlsson, Kristoffer and Ekre, Fredrik}, year = {2019}, journal = {Journal of Open Research Software}, doi = {10.5334/jors.182}, }

Related packages

Both the packages below provide a convenience macro to provide einstein summation notation for standard Julia Array's:

Owner

  • Name: Ferrite-FEM
  • Login: Ferrite-FEM
  • Kind: organization

Citation (CITATION.cff)

cff-version: 1.2.0
title: Tensors.jl
message: >-
  If you use this software, please cite this software using
  the metadata from "preferred-citation".
type: software
authors:
  - family-names: Carlsson
    given-names: Kristoffer
    orcid: 'https://orcid.org/0000-0001-9092-3092'
  - family-names: Ekre
    given-names: Fredrik
    orcid: 'https://orcid.org/0000-0003-2476-5406'
  - name: Tensors.jl contributors
identifiers:
  - type: doi
    value: 10.5281/zenodo.802356
    description: >-
      DOI representing all versions of Tensors.jl (Zenodo
      Concept DOI)
repository-code: 'https://github.com/Ferrite-FEM/Tensors.jl'
license: MIT
preferred-citation:
  authors:
    - family-names: Carlsson
      given-names: Kristoffer
      orcid: 'https://orcid.org/0000-0001-9092-3092'
    - family-names: Ekre
      given-names: Fredrik
      orcid: 'https://orcid.org/0000-0003-2476-5406'
  doi: 10.5334/jors.182
  journal: Journal of Open Research Software
  title: Tensors.jl — Tensor Computations in Julia
  type: article
  year: 2019

GitHub Events

Total
  • Create event: 8
  • Commit comment event: 2
  • Release event: 1
  • Issues event: 4
  • Watch event: 6
  • Delete event: 2
  • Issue comment event: 13
  • Push event: 10
  • Pull request review event: 3
  • Pull request review comment event: 3
  • Pull request event: 8
Last Year
  • Create event: 8
  • Commit comment event: 2
  • Release event: 1
  • Issues event: 4
  • Watch event: 6
  • Delete event: 2
  • Issue comment event: 13
  • Push event: 10
  • Pull request review event: 3
  • Pull request review comment event: 3
  • Pull request event: 8

Committers

Last synced: about 2 years ago

All Time
  • Total Commits: 296
  • Total Committers: 17
  • Avg Commits per committer: 17.412
  • Development Distribution Score (DDS): 0.713
Past Year
  • Commits: 26
  • Committers: 6
  • Avg Commits per committer: 4.333
  • Development Distribution Score (DDS): 0.615
Top Committers
Name Email Commits
Fredrik Ekre f****e@c****e 85
Kristoffer Carlsson k****n@c****e 82
Fredrik Ekre e****k@g****m 71
Knut Andreas Meyer k****m@g****m 19
Fredrik Ekre f****e@h****m 10
Keita Nakamura k****9@g****m 10
Kristoffer Carlsson k****9@g****m 7
Jean-François Barthélémy 8****y 2
Tony Kelman t****y@k****t 2
Kim Louisa Auth a****h@c****e 1
Tim Holy t****y@g****m 1
femtocleaner[bot] f****] 1
Florian Heiderich f****n@h****g 1
Katharine Hyatt k****t 1
miguelraz m****z@c****x 1
Maximilian Köhler m****r@r****e 1
Elliot Saba s****t@g****m 1
Committer Domains (Top 20 + Academic)

Issues and Pull Requests

Last synced: 6 months ago

All Time
  • Total issues: 44
  • Total pull requests: 88
  • Average time to close issues: 8 months
  • Average time to close pull requests: 2 months
  • Total issue authors: 31
  • Total pull request authors: 14
  • Average comments per issue: 2.95
  • Average comments per pull request: 2.23
  • Merged pull requests: 66
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 5
  • Pull requests: 7
  • Average time to close issues: N/A
  • Average time to close pull requests: about 8 hours
  • Issue authors: 5
  • Pull request authors: 3
  • Average comments per issue: 0.2
  • Average comments per pull request: 0.43
  • Merged pull requests: 2
  • Bot issues: 0
  • Bot pull requests: 0
Top Authors
Issue Authors
  • KnutAM (7)
  • koehlerson (3)
  • termi-official (3)
  • fredrikekre (2)
  • Batmanabcdefg (2)
  • TeroFrondelius (1)
  • andreichalapco (1)
  • jfdev001 (1)
  • JuliaTagBot (1)
  • lijas (1)
  • fpguillet (1)
  • ahojukka5 (1)
  • soraros (1)
  • tlow22 (1)
  • victorjesusamoresmedianero (1)
Pull Request Authors
  • fredrikekre (40)
  • KnutAM (30)
  • KristofferC (6)
  • KeitaNakamura (2)
  • jfbarthelemy (2)
  • termi-official (1)
  • platawiec (1)
  • heiderich (1)
  • timholy (1)
  • kimauth (1)
  • yijiangh (1)
  • koehlerson (1)
  • lijas (1)
  • JuliaTagBot (1)
Top Labels
Issue Labels
Pull Request Labels

Dependencies

.github/workflows/CI.yml actions
  • actions/checkout v2 composite
  • codecov/codecov-action v1 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