Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/singularitti/spglib.jl

A Julia wrapper for the spglib C-API
https://github.com/singularitti/spglib.jl

c-api c-wrapper condensed-matter-physics crystal-structure crystallography julia-package materials-science scientific-computing symmetry-detection wrapper

Last synced: 12 days ago
JSON representation

A Julia wrapper for the spglib C-API

Host: GitHub
URL: https://github.com/singularitti/spglib.jl
Owner: singularitti
License: mit
Created: 2019-08-10T10:25:20.000Z (over 5 years ago)
Default Branch: main
Last Pushed: 2024-11-18T23:23:08.000Z (about 1 month ago)
Last Synced: 2024-12-07T07:31:45.653Z (16 days ago)
Topics: c-api, c-wrapper, condensed-matter-physics, crystal-structure, crystallography, julia-package, materials-science, scientific-computing, symmetry-detection, wrapper
Language: Julia
Homepage: https://singularitti.github.io/Spglib.jl/
Size: 2.25 MB
Stars: 19
Watchers: 5
Forks: 10
Open Issues: 2
Metadata Files:
- Readme: README.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        # Spglib

| **Documentation** | [![Stable](https://img.shields.io/badge/docs-stable-blue.svg)](https://singularitti.github.io/Spglib.jl/stable/) [![Dev](https://img.shields.io/badge/docs-dev-blue.svg)](https://singularitti.github.io/Spglib.jl/dev/)                                                                                                                                                                                                                                                                             |

| :---------------: | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |

| **Build Status**  | [![Build Status](https://github.com/singularitti/Spglib.jl/actions/workflows/CI.yml/badge.svg?branch=main)](https://github.com/singularitti/Spglib.jl/actions/workflows/CI.yml?query=branch%3Amain) [![Build Status](https://ci.appveyor.com/api/projects/status/github/singularitti/Spglib.jl?svg=true)](https://ci.appveyor.com/project/singularitti/Spglib-jl)[![Build Status](https://api.cirrus-ci.com/github/singularitti/Spglib.jl.svg)](https://cirrus-ci.com/github/singularitti/Spglib.jl) |

|   **Coverage**    | [![Coverage](https://github.com/singularitti/Spglib.jl/badges/main/coverage.svg)](https://github.com/singularitti/Spglib.jl/commits/main) [![Coverage](https://codecov.io/gh/singularitti/Spglib.jl/branch/main/graph/badge.svg)](https://codecov.io/gh/singularitti/Spglib.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/singularitti/Spglib.jl)](https://github.com/singularitti/Spglib.jl/blob/main/LICENSE)                                                                                                                                                                                                                                       |

The code, which is [hosted on GitHub](https://github.com/singularitti/Spglib.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

`Spglib.jl` is a Julia wrapper of the C library [Spglib](https://github.com/spglib/spglib).

See [this page](https://spglib.readthedocs.io/en/latest/interface.html#julia-interface).

It is used for finding and handling crystal symmetries.

There was a package [`LibSymspg.jl`](https://juliahub.com/ui/Packages/LibSymspg/D1i7g)

thanks to [@unkcpz](https://github.com/unkcpz).

However, it is no longer actively maintained.

This package:

- enables the finding and handling of crystal symmetries;

- includes new naming conventions, input types, and return types of functions.

## 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 Spglib

```

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

```julia

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

```

## Documentation

- [**STABLE**](https://singularitti.github.io/Spglib.jl/stable/) — **documentation of the most recently tagged version.**

- [**DEV**](https://singularitti.github.io/Spglib.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/singularitti/Spglib.jl/discussions).

We welcome contributions, feature requests, and suggestions. If you encounter any problems,

please open an [issue](https://github.com/singularitti/Spglib.jl/issues).

The [Contributing](@ref) page has

a few guidelines that should be followed when opening pull requests and contributing code.

## Stargazers over time

[![Stargazers over time](https://starchart.cc/singularitti/Spglib.jl.svg?variant=adaptive)](https://starchart.cc/singularitti/Spglib.jl)