Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/mineralscloud/linearelasticity.jl

Calculate linear elasticity for some crystals
https://github.com/mineralscloud/linearelasticity.jl

crystallography elasticity julia-package linear-elasticity materials-science mechanical-engineering physics scientific-computing

Last synced: 24 days ago
JSON representation

Calculate linear elasticity for some crystals

Awesome Lists containing this project

README

        

# LinearElasticity

| **Documentation** | [![Stable](https://img.shields.io/badge/docs-stable-blue.svg)](https://MineralsCloud.github.io/LinearElasticity.jl/stable/) [![Dev](https://img.shields.io/badge/docs-dev-blue.svg)](https://MineralsCloud.github.io/LinearElasticity.jl/dev/) |
| :---------------: | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **Build Status** | [![Build Status](https://github.com/MineralsCloud/LinearElasticity.jl/actions/workflows/CI.yml/badge.svg?branch=main)](https://github.com/MineralsCloud/LinearElasticity.jl/actions/workflows/CI.yml?query=branch%3Amain) [![Build Status](https://ci.appveyor.com/api/projects/status/github/MineralsCloud/LinearElasticity.jl?svg=true)](https://ci.appveyor.com/project/MineralsCloud/LinearElasticity-jl)[![Build Status](https://api.cirrus-ci.com/github/MineralsCloud/LinearElasticity.jl.svg)](https://cirrus-ci.com/github/MineralsCloud/LinearElasticity.jl) |
| **Coverage** | [![Coverage](https://github.com/MineralsCloud/LinearElasticity.jl/badges/main/coverage.svg)](https://github.com/MineralsCloud/LinearElasticity.jl/commits/main) [![Coverage](https://codecov.io/gh/MineralsCloud/LinearElasticity.jl/branch/main/graph/badge.svg)](https://codecov.io/gh/MineralsCloud/LinearElasticity.jl) |
| **Others** | [![Code Style: Blue](https://img.shields.io/badge/code%20style-blue-4495d1.svg)](https://github.com/invenia/BlueStyle) [![License](https://img.shields.io/github/license/MineralsCloud/LinearElasticity.jl)](https://github.com/MineralsCloud/LinearElasticity.jl/blob/main/LICENSE) |

The code, which is [hosted on GitHub](https://github.com/MineralsCloud/LinearElasticity.jl), is tested
using various continuous integration services for its validity.

This repository is created and maintained by
[@singularitti](https://github.com/singularitti), and contributions are highly welcome.

## Package features

Compute and convert linear elasticity values based on the Cauchy elasticity theory.

## Installation

The package can be installed with the Julia package manager.
From [the Julia REPL](https://docs.julialang.org/en/v1/stdlib/REPL/), type `]` to enter
the [Pkg mode](https://docs.julialang.org/en/v1/stdlib/REPL/#Pkg-mode) and run:

```julia-repl
pkg> add LinearElasticity
```

Or, equivalently, via [`Pkg.jl`](https://pkgdocs.julialang.org/v1/):

```julia
julia> import Pkg; Pkg.add("LinearElasticity")
```

## Documentation

- [**STABLE**](https://MineralsCloud.github.io/LinearElasticity.jl/stable/) — **documentation of the most recently tagged version.**
- [**DEV**](https://MineralsCloud.github.io/LinearElasticity.jl/dev/) — _documentation of the in-development version._

## Project status

The package is developed for and tested against Julia `v1.6` and above on Linux, macOS, and
Windows.

## Questions and contributions

You can post usage questions on
[our discussion page](https://github.com/MineralsCloud/LinearElasticity.jl/discussions).

We welcome contributions, feature requests, and suggestions. If you encounter any problems,
please open an [issue](https://github.com/MineralsCloud/LinearElasticity.jl/issues).
The [Contributing](@ref) page has
a few guidelines that should be followed when opening pull requests and contributing code.