Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mineralscloud/abinitiosoftwarebase.jl
Provides a common API that shared by some ab initio software
https://github.com/mineralscloud/abinitiosoftwarebase.jl
abinitio-simulations commands julia-package
Last synced: about 1 month ago
JSON representation
Provides a common API that shared by some ab initio software
- Host: GitHub
- URL: https://github.com/mineralscloud/abinitiosoftwarebase.jl
- Owner: MineralsCloud
- License: mit
- Created: 2020-06-13T06:08:30.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2024-11-15T05:04:18.000Z (about 2 months ago)
- Last Synced: 2024-11-20T04:12:07.452Z (about 1 month ago)
- Topics: abinitio-simulations, commands, julia-package
- Language: Julia
- Homepage: https://mineralscloud.github.io/AbInitioSoftwareBase.jl/
- Size: 1020 KB
- Stars: 2
- Watchers: 2
- Forks: 1
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# AbInitioSoftwareBase
| **Documentation** | **Build Status** | **Others** |
| :--------------------------------------------------------------------------------: | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: | :---------------------------------------------------------------------------------------: |
| [![Stable][docs-stable-img]][docs-stable-url] [![Dev][docs-dev-img]][docs-dev-url] | [![Build Status][gha-img]][gha-url] [![Build Status][appveyor-img]][appveyor-url] [![Build Status][cirrus-img]][cirrus-url] [![pipeline status][gitlab-img]][gitlab-url] [![Coverage][codecov-img]][codecov-url] | [![GitHub license][license-img]][license-url] [![Code Style: Blue][style-img]][style-url] |
[docs-stable-img]: https://img.shields.io/badge/docs-stable-blue.svg
[docs-stable-url]: https://MineralsCloud.github.io/AbInitioSoftwareBase.jl/stable
[docs-dev-img]: https://img.shields.io/badge/docs-dev-blue.svg
[docs-dev-url]: https://MineralsCloud.github.io/AbInitioSoftwareBase.jl/dev
[gha-img]: https://github.com/MineralsCloud/AbInitioSoftwareBase.jl/workflows/CI/badge.svg
[gha-url]: https://github.com/MineralsCloud/AbInitioSoftwareBase.jl/actions
[appveyor-img]: https://ci.appveyor.com/api/projects/status/github/MineralsCloud/AbInitioSoftwareBase.jl?svg=true
[appveyor-url]: https://ci.appveyor.com/project/singularitti/AbInitioSoftwareBase-jl
[cirrus-img]: https://api.cirrus-ci.com/github/MineralsCloud/AbInitioSoftwareBase.jl.svg
[cirrus-url]: https://cirrus-ci.com/github/MineralsCloud/AbInitioSoftwareBase.jl
[gitlab-img]: https://gitlab.com/singularitti/AbInitioSoftwareBase.jl/badges/main/pipeline.svg
[gitlab-url]: https://gitlab.com/singularitti/AbInitioSoftwareBase.jl/-/pipelines
[codecov-img]: https://codecov.io/gh/MineralsCloud/AbInitioSoftwareBase.jl/branch/main/graph/badge.svg
[codecov-url]: https://codecov.io/gh/MineralsCloud/AbInitioSoftwareBase.jl
[license-img]: https://img.shields.io/github/license/MineralsCloud/AbInitioSoftwareBase.jl
[license-url]: https://github.com/MineralsCloud/AbInitioSoftwareBase.jl/blob/main/LICENSE
[style-img]: https://img.shields.io/badge/code%20style-blue-4495d1.svg
[style-url]: https://github.com/invenia/BlueStyle
The code is [hosted on GitHub](https://github.com/MineralsCloud/AbInitioSoftwareBase.jl),
with some continuous integration services to test its validity.
This repository is created and maintained by [@singularitti](https://github.com/singularitti).
You are very welcome to contribute.
## 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 AbInitioSoftwareBase
```
Or, equivalently, via the [`Pkg` API](https://pkgdocs.julialang.org/v1/getting-started/):
```julia
julia> import Pkg; Pkg.add("AbInitioSoftwareBase")
```
## Documentation
- [**STABLE**][docs-stable-url] — **documentation of the most recently tagged version.**
- [**DEV**][docs-dev-url] — _documentation of the in-development version._
## Project status
The package is tested against, and being developed for, Julia `1.6` and above on Linux,
macOS, and Windows.
## Questions and contributions
You are welcome to post usage questions on [our discussion page][discussions-url].
Contributions are very welcome, as are feature requests and suggestions. Please open an
[issue][issues-url] if you encounter any problems. The [Contributing](@ref) page has
guidelines that should be followed when opening pull requests and contributing code.
[discussions-url]: https://github.com/MineralsCloud/AbInitioSoftwareBase.jl/discussions
[issues-url]: https://github.com/MineralsCloud/AbInitioSoftwareBase.jl/issues