awietek / XDiag.jl

Julia library for Exact Diagonalization of quantum many-body systems
Apache License 2.0
6 stars 0 forks source link

[XDiag] new package registration #6

Closed awietek closed 4 weeks ago

awietek commented 1 month ago

@JuliaRegistrator register

This is to register a new Julia package XDiag.jl. Its purpose is to perform efficient Exact Diagonalizations of quantum many body physics. This is of use in e.g. solid state physics, chemistry or quantum optics, where full many-body quantum mechanical problems are treated. The package is based on the backend C++ library xdiag, available here: https://github.com/awietek/xdiag The documentation is available under https://awietek.github.io/xdiag/ which is a combined documentation of both the C++ and Julia library.

The Julia library is OpenMP parallelized and features quantum mechanical models for spins and electrons. The C++ side of the code has already been used in several publications and an extensive testing suite is continuously tested for the C++ side. On the julia side in XDiag.jl, several tests certify the correctness of the wrapping.

The original C++ library has been wrapped using CxxWrap.jl and the binaries have been deployed via Yggdrasil, which provided the corresponding XDiag_jll package. The dependencies are kept to a minimum.

JuliaRegistrator commented 1 month ago

Registration pull request created: JuliaRegistries/General/112977

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

Also, note the warning: This looks like a new registration that registers version 0.2.0. Ideally, you should register an initial release with 0.0.1, 0.1.0 or 1.0.0 version numbers This can be safely ignored. However, if you want to fix this you can do so. Call register() again after making the fix. This will update the Pull request.

awietek commented 1 month ago

@JuliaRegistrator register

JuliaRegistrator commented 1 month ago

Registration pull request updated: JuliaRegistries/General/112977

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.2.0 -m "<description of version>" 1de7395b6a5d5a03d3b9cb41aed5b2c1597a3ec3
git push origin v0.2.0

Also, note the warning: This looks like a new registration that registers version 0.2.0. Ideally, you should register an initial release with 0.0.1, 0.1.0 or 1.0.0 version numbers This can be safely ignored. However, if you want to fix this you can do so. Call register() again after making the fix. This will update the Pull request.

awietek commented 1 month ago

@JuliaRegistrator register

JuliaRegistrator commented 1 month ago

Registration pull request updated: JuliaRegistries/General/112977

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.2.0 -m "<description of version>" 5dab22bf8e11d4ebc93480be9ddb4ce6123401b2
git push origin v0.2.0

Also, note the warning: This looks like a new registration that registers version 0.2.0. Ideally, you should register an initial release with 0.0.1, 0.1.0 or 1.0.0 version numbers This can be safely ignored. However, if you want to fix this you can do so. Call register() again after making the fix. This will update the Pull request.

awietek commented 1 month ago

@JuliaRegistrator register

JuliaRegistrator commented 1 month ago

Registration pull request updated: JuliaRegistries/General/112977

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.2.0 -m "<description of version>" 78206103e8d5d64ea5ca87e33726bd71ac9cafa2
git push origin v0.2.0

Also, note the warning: This looks like a new registration that registers version 0.2.0. Ideally, you should register an initial release with 0.0.1, 0.1.0 or 1.0.0 version numbers This can be safely ignored. However, if you want to fix this you can do so. Call register() again after making the fix. This will update the Pull request.

awietek commented 1 month ago

@JuliaRegistrator register

JuliaRegistrator commented 1 month ago

Registration pull request updated: JuliaRegistries/General/112977

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

Also, note the warning: This looks like a new registration that registers version 0.2.0. Ideally, you should register an initial release with 0.0.1, 0.1.0 or 1.0.0 version numbers This can be safely ignored. However, if you want to fix this you can do so. Call register() again after making the fix. This will update the Pull request.