Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
mfherbst committed Jan 24, 2023
1 parent 1409a82 commit d176ced
Showing 1 changed file with 10 additions and 4 deletions.
14 changes: 10 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,15 @@

| **Build Status** | **License** |
|:--------------------------------------------------------------------- |:-------------------------------- |
| ![][ci-img] [![][cov-img]][cov-url] | [![][license-img]][license-url] |
| ![][ci-img] [![][cigpu-img]][cigpu-url] [![][ccov-img]][ccov-url] | [![][license-img]][license-url] |

[ci-img]: https://github.com/JuliaMolSim/Libxc.jl/workflows/CI/badge.svg

[cov-img]: https://coveralls.io/repos/JuliaMolSim/Libxc.jl/badge.svg?branch=master&service=github
[cov-url]: https://coveralls.io/github/JuliaMolSim/Libxc.jl?branch=master
[cigpu-img]: https://git.uni-paderborn.de/herbstm/Libxc.jl/badges/master/pipeline.svg?key_text=GPU%20CI
[cigpu-url]: https://git.uni-paderborn.de/herbstm/Libxc.jl/-/pipelines

[ccov-img]: https://codecov.io/gh/JuliaMolSim/Libxc.jl/branch/master/graph/badge.svg?token=ZL7RUND4YE
[ccov-url]: https://codecov.io/gh/JuliaMolSim/Libxc.jl

[license-img]: https://img.shields.io/github/license/JuliaMolSim/Libxc.jl.svg?maxAge=2592000
[license-url]: https://github.com/JuliaMolSim/Libxc.jl/blob/master/LICENSE
Expand Down Expand Up @@ -46,7 +49,10 @@ result = evaluate(gga_x, rho=rho, sigma=sigma, derivative=0)

## Status
Full support for evaluating LDA, GGA and meta-GGA functionals
as shown above. Hybrid or range-separated hybrids and VV10-type functionals
on CPUs as shown above. Experimental GPU support by dispatching to the CUDA
version of libxc when `evaluate` is called with `CuArray`s.

Hybrid or range-separated hybrids and VV10-type functionals
export parameters required in the host programs as properties of the `Functional`
Julia object. For example
```julia
Expand Down

2 comments on commit d176ced

@mfherbst
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@JuliaRegistrator
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Registration pull request created: JuliaRegistries/General/76260

After the above pull request is merged, it is recommended that a tag is created on this repository for the registered package version.

This will be done automatically if the Julia TagBot GitHub Action is installed, or can be done manually through the github interface, or via:

git tag -a v0.3.13 -m "<description of version>" d176ced362dd7c246d14dbcd207255d1de528b80
git push origin v0.3.13

Please sign in to comment.