Skip to content

Commit

Permalink
v0.1.2 Add installation instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
@cohensbw
cohensbw committed Oct 29, 2024
1 parent 98663aa commit c9ea544
Show file tree
Hide file tree
Showing 3 changed files with 27 additions and 1 deletion.
2 changes: 1 addition & 1 deletion Project.toml
View file
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
name = "SmoQyKPMCore"
uuid = "30e33e58-a96a-4fec-8c75-57692dd3ff18"
authors = ["Benjamin Cohen-Stead <[email protected]>", "Steven Johnston <[email protected]>", "Kipton Barros <[email protected]>"]
version = "0.1.1"
version = "0.1.2"

[deps]
FFTW = "7a1cc6ca-52ef-59f5-83cd-3a7055c09341"
Expand Down
13 changes: 13 additions & 0 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,19 @@
This package implements and exports an optimized, low-level implementation of the Kernel Polynomial Method (KPM) algorithm for
approximating functions of operators with strictly real, bounded eigenvalues via a Chebyshev polynomial expansion.

## Installation

To install [SmoQyKPMCore](https://github.com/SmoQySuite/SmoQyKPMCore.jl.git),
simply open the Julia REPL and run the commands
```julia
julia> ]
pkg> add SmoQyKPMCore
```
or equivalently via `Pkg` do
```julia
julia> using Pkg; Pkg.add("SmoQyKPMCore")
```

## Funding

The development of this package was supported by the National Science Foundation under Grant No. OAC-2410280.
13 changes: 13 additions & 0 deletions docs/src/index.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,19 @@ The [SmoQyKPMCore](https://github.com/SmoQySuite/SmoQyKPMCore.jl) package implem
low-level implementation of the Kernel Polynomial Method (KPM) algorithm for
approximating functions of operators with strictly real, bounded eigenvalues via a Chebyshev polynomial expansion.

## Installation

To install [SmoQyKPMCore](https://github.com/SmoQySuite/SmoQyKPMCore.jl.git),
simply open the Julia REPL and run the commands
```julia
julia> ]
pkg> add SmoQyKPMCore
```
or equivalently via `Pkg` do
```julia
julia> using Pkg; Pkg.add("SmoQyKPMCore")
```

## Funding

The development of this package was supported by the National Science Foundation under Grant No. OAC-2410280.

2 comments on commit c9ea544

@cohensbw
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 register

@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/118333

Tip: Release Notes

Did you know you can add release notes too? Just add markdown formatted text underneath the comment after the text
"Release notes:" and it will be added to the registry PR, and if TagBot is installed it will also be added to the
release that TagBot creates. i.e.

@JuliaRegistrator register

Release notes:

## Breaking changes

- blah

To add them here just re-invoke and the PR will be updated.

Tagging

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.1.2 -m "<description of version>" c9ea544a562d321b58ee859b910bb4774e26871f
git push origin v0.1.2

Please sign in to comment.