diff --git a/.github/workflows/CompatHelper.yml b/.github/workflows/CompatHelper.yml index cba9134..456fa05 100644 --- a/.github/workflows/CompatHelper.yml +++ b/.github/workflows/CompatHelper.yml @@ -1,16 +1,16 @@ -name: CompatHelper +name: "CompatHelper" + on: schedule: - cron: 0 0 * * * workflow_dispatch: +permissions: + contents: write + pull-requests: write + jobs: - CompatHelper: - runs-on: ubuntu-latest - steps: - - name: Pkg.add("CompatHelper") - run: julia -e 'using Pkg; Pkg.add("CompatHelper")' - - name: CompatHelper.main() - env: - GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} - COMPATHELPER_PRIV: ${{ secrets.DOCUMENTER_KEY }} - run: julia -e 'using CompatHelper; CompatHelper.main()' + compat-helper: + name: "CompatHelper" + uses: "ITensor/ITensorActions/.github/workflows/CompatHelper.yml@main" + with: + localregistry: "https://github.com/ITensor/ITensorRegistry.git" diff --git a/.github/workflows/IntegrationTestRequest.yml b/.github/workflows/IntegrationTestRequest.yml new file mode 100644 index 0000000..d42fcca --- /dev/null +++ b/.github/workflows/IntegrationTestRequest.yml @@ -0,0 +1,14 @@ +name: "Integration Test Request" + +on: + issue_comment: + types: [created] + +jobs: + integrationrequest: + if: | + github.event.issue.pull_request && + contains(fromJSON('["OWNER", "COLLABORATOR", "MEMBER"]'), github.event.comment.author_association) + uses: ITensor/ITensorActions/.github/workflows/IntegrationTestRequest.yml@main + with: + localregistry: https://github.com/ITensor/ITensorRegistry.git diff --git a/.github/workflows/Registrator.yml b/.github/workflows/Registrator.yml new file mode 100644 index 0000000..255e2af --- /dev/null +++ b/.github/workflows/Registrator.yml @@ -0,0 +1,24 @@ +name: Register Package +on: + workflow_dispatch: + pull_request: + types: + - closed + paths: + - 'Project.toml' + branches: + - 'master' + - 'main' + +permissions: + contents: write + pull-requests: write + +jobs: + Register: + if: github.event_name == 'workflow_dispatch' || github.event.pull_request.merged == true + uses: "ITensor/ITensorActions/.github/workflows/Registrator.yml@main" + with: + localregistry: ITensor/ITensorRegistry + secrets: + REGISTRATOR_KEY: ${{ secrets.REGISTRATOR_KEY }} diff --git a/.github/workflows/VersionCheck.yml b/.github/workflows/VersionCheck.yml new file mode 100644 index 0000000..69444f1 --- /dev/null +++ b/.github/workflows/VersionCheck.yml @@ -0,0 +1,11 @@ +name: "Version Check" + +on: + pull_request: + +jobs: + version-check: + name: "Version Check" + uses: "ITensor/ITensorActions/.github/workflows/VersionCheck.yml@main" + with: + localregistry: https://github.com/ITensor/ITensorRegistry.git diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index 80c74e2..6599365 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -1,6 +1,6 @@ repos: - repo: https://github.com/pre-commit/pre-commit-hooks - rev: v5.0.0 + rev: v4.5.0 hooks: - id: check-merge-conflict - id: check-toml @@ -9,6 +9,6 @@ repos: exclude_types: [markdown] # incompatible with Literate.jl - repo: "https://github.com/domluna/JuliaFormatter.jl" - rev: v2.0.0 + rev: v1.0.62 hooks: - id: "julia-formatter" diff --git a/LICENSE b/LICENSE index 7f5c8c6..351a3f0 100644 --- a/LICENSE +++ b/LICENSE @@ -1,21 +1,201 @@ -MIT License - -Copyright (c) 2024 ITensor developers - -Permission is hereby granted, free of charge, to any person obtaining a copy -of this software and associated documentation files (the "Software"), to deal -in the Software without restriction, including without limitation the rights -to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -copies of the Software, and to permit persons to whom the Software is -furnished to do so, subject to the following conditions: - -The above copyright notice and this permission notice shall be included in all -copies or substantial portions of the Software. - -THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -SOFTWARE. + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright 2024 The Simons Foundation, Inc. - All Rights Reserved. + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. diff --git a/Project.toml b/Project.toml index aef3d9a..3009abe 100644 --- a/Project.toml +++ b/Project.toml @@ -1,7 +1,7 @@ name = "FusionTensors" uuid = "e16ca583-1f51-4df0-8e12-57d32947d33e" authors = ["ITensor developers and contributors"] -version = "0.2.1" +version = "0.2.2" [deps] Accessors = "7d9f7c33-5ae7-4f3b-8dc6-eff91059b697" diff --git a/README.md b/README.md index a19a440..156d8e7 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,22 @@ # FusionTensors.jl -[![Stable](https://img.shields.io/badge/docs-stable-blue.svg)](https://ITensor.github.io/FusionTensors.jl/stable/) -[![Dev](https://img.shields.io/badge/docs-dev-blue.svg)](https://ITensor.github.io/FusionTensors.jl/dev/) +[![Stable](https://img.shields.io/badge/docs-stable-blue.svg)](https://itensor.github.io/FusionTensors.jl/stable/) +[![Dev](https://img.shields.io/badge/docs-dev-blue.svg)](https://itensor.github.io/FusionTensors.jl/dev/) [![Build Status](https://github.com/ITensor/FusionTensors.jl/actions/workflows/Tests.yml/badge.svg?branch=main)](https://github.com/ITensor/FusionTensors.jl/actions/workflows/Tests.yml?query=branch%3Amain) [![Coverage](https://codecov.io/gh/ITensor/FusionTensors.jl/branch/main/graph/badge.svg)](https://codecov.io/gh/ITensor/FusionTensors.jl) [![Code Style: Blue](https://img.shields.io/badge/code%20style-blue-4495d1.svg)](https://github.com/invenia/BlueStyle) [![Aqua](https://raw.githubusercontent.com/JuliaTesting/Aqua.jl/master/badge.svg)](https://github.com/JuliaTesting/Aqua.jl) +## Support + + + + Flatiron Center for Computational Quantum Physics logo. + + + +FusionTensors.jl is supported by the Flatiron Institute, a division of the Simons Foundation. + ## Installation instructions This package resides in the `ITensor/ITensorRegistry` local registry. diff --git a/docs/make.jl b/docs/make.jl index 0af4303..5aaf7e8 100644 --- a/docs/make.jl +++ b/docs/make.jl @@ -10,11 +10,11 @@ makedocs(; authors="ITensor developers and contributors", sitename="FusionTensors.jl", format=Documenter.HTML(; - canonical="https://ITensor.github.io/FusionTensors.jl", + canonical="https://itensor.github.io/FusionTensors.jl", edit_link="main", - assets=String[], + assets=["assets/favicon.ico", "assets/extras.css"], ), - pages=["Home" => "index.md"], + pages=["Home" => "index.md", "Reference" => "reference.md"], ) deploydocs(; diff --git a/docs/make_index.jl b/docs/make_index.jl index 996deca..2ae72dc 100644 --- a/docs/make_index.jl +++ b/docs/make_index.jl @@ -1,9 +1,21 @@ using Literate: Literate using FusionTensors: FusionTensors +function ccq_logo(content) + include_ccq_logo = """ + ```@raw html + Flatiron Center for Computational Quantum Physics logo. + Flatiron Center for Computational Quantum Physics logo. + ``` + """ + content = replace(content, "{CCQ_LOGO}" => include_ccq_logo) + return content +end + Literate.markdown( joinpath(pkgdir(FusionTensors), "examples", "README.jl"), joinpath(pkgdir(FusionTensors), "docs", "src"); flavor=Literate.DocumenterFlavor(), name="index", + postprocess=ccq_logo, ) diff --git a/docs/make_readme.jl b/docs/make_readme.jl index 4f44f07..bb48eba 100644 --- a/docs/make_readme.jl +++ b/docs/make_readme.jl @@ -1,9 +1,21 @@ using Literate: Literate using FusionTensors: FusionTensors +function ccq_logo(content) + include_ccq_logo = """ + + + Flatiron Center for Computational Quantum Physics logo. + + """ + content = replace(content, "{CCQ_LOGO}" => include_ccq_logo) + return content +end + Literate.markdown( joinpath(pkgdir(FusionTensors), "examples", "README.jl"), joinpath(pkgdir(FusionTensors)); flavor=Literate.CommonMarkFlavor(), name="README", + postprocess=ccq_logo, ) diff --git a/docs/src/assets/CCQ-dark.png b/docs/src/assets/CCQ-dark.png new file mode 100644 index 0000000..fbaef52 Binary files /dev/null and b/docs/src/assets/CCQ-dark.png differ diff --git a/docs/src/assets/CCQ.png b/docs/src/assets/CCQ.png new file mode 100644 index 0000000..e13f908 Binary files /dev/null and b/docs/src/assets/CCQ.png differ diff --git a/docs/src/assets/extras.css b/docs/src/assets/extras.css new file mode 100644 index 0000000..aaab0f8 --- /dev/null +++ b/docs/src/assets/extras.css @@ -0,0 +1,15 @@ +.display-light-only { + display: block; +} + +.display-dark-only { + display: none; +} + +.theme--documenter-dark .display-light-only { + display: none; +} + +.theme--documenter-dark .display-dark-only { + display: block; +} diff --git a/docs/src/assets/favicon.ico b/docs/src/assets/favicon.ico new file mode 100644 index 0000000..0b06780 Binary files /dev/null and b/docs/src/assets/favicon.ico differ diff --git a/docs/src/assets/logo-dark.png b/docs/src/assets/logo-dark.png new file mode 100644 index 0000000..7450635 Binary files /dev/null and b/docs/src/assets/logo-dark.png differ diff --git a/docs/src/assets/logo.png b/docs/src/assets/logo.png new file mode 100644 index 0000000..2682e14 Binary files /dev/null and b/docs/src/assets/logo.png differ diff --git a/docs/src/reference.md b/docs/src/reference.md new file mode 100644 index 0000000..edae945 --- /dev/null +++ b/docs/src/reference.md @@ -0,0 +1,5 @@ +# Reference + +```@autodocs +Modules = [FusionTensors] +``` diff --git a/examples/README.jl b/examples/README.jl index 3273af4..42cb0ae 100644 --- a/examples/README.jl +++ b/examples/README.jl @@ -1,12 +1,18 @@ # # FusionTensors.jl # -# [![Stable](https://img.shields.io/badge/docs-stable-blue.svg)](https://ITensor.github.io/FusionTensors.jl/stable/) -# [![Dev](https://img.shields.io/badge/docs-dev-blue.svg)](https://ITensor.github.io/FusionTensors.jl/dev/) +# [![Stable](https://img.shields.io/badge/docs-stable-blue.svg)](https://itensor.github.io/FusionTensors.jl/stable/) +# [![Dev](https://img.shields.io/badge/docs-dev-blue.svg)](https://itensor.github.io/FusionTensors.jl/dev/) # [![Build Status](https://github.com/ITensor/FusionTensors.jl/actions/workflows/Tests.yml/badge.svg?branch=main)](https://github.com/ITensor/FusionTensors.jl/actions/workflows/Tests.yml?query=branch%3Amain) # [![Coverage](https://codecov.io/gh/ITensor/FusionTensors.jl/branch/main/graph/badge.svg)](https://codecov.io/gh/ITensor/FusionTensors.jl) # [![Code Style: Blue](https://img.shields.io/badge/code%20style-blue-4495d1.svg)](https://github.com/invenia/BlueStyle) # [![Aqua](https://raw.githubusercontent.com/JuliaTesting/Aqua.jl/master/badge.svg)](https://github.com/JuliaTesting/Aqua.jl) +# ## Support +# +# {CCQ_LOGO} +# +# FusionTensors.jl is supported by the Flatiron Institute, a division of the Simons Foundation. + # ## Installation instructions # This package resides in the `ITensor/ITensorRegistry` local registry. diff --git a/src/fusiontensor/array_cast.jl b/src/fusiontensor/array_cast.jl index c616571..c081e7b 100644 --- a/src/fusiontensor/array_cast.jl +++ b/src/fusiontensor/array_cast.jl @@ -32,11 +32,8 @@ rtoldefault(arrayt::Type{<:AbstractArray}) = rtoldefault(eltype(arrayt)) rtoldefault(elt::Type{<:Number}) = 10 * eps(real(float(elt))) function checknorm(ft::FusionTensor, a::AbstractArray, atol::Real, rtol::Real) - return isapprox(norm(ft), norm(a); atol=atol, rtol=rtol) || throw( - InexactError( - :FusionTensor, typeof(a), typeof(codomain_axes(ft)), typeof(domain_axes(ft)) - ), - ) + return isapprox(norm(ft), norm(a); atol, rtol) || + throw(InexactError(:FusionTensor, typeof(ft), a)) end function to_fusiontensor( diff --git a/test/runtests.jl b/test/runtests.jl index bd97441..1c52c3e 100644 --- a/test/runtests.jl +++ b/test/runtests.jl @@ -24,9 +24,11 @@ isexamplefile(fn) = # tests in groups based on folder structure for testgroup in filter(isdir, readdir(@__DIR__)) if GROUP == "ALL" || GROUP == uppercase(testgroup) - for file in filter(istestfile, readdir(joinpath(@__DIR__, testgroup); join=true)) + groupdir = joinpath(@__DIR__, testgroup) + for file in filter(istestfile, readdir(groupdir)) + filename = joinpath(groupdir, file) @eval @safetestset $file begin - include($file) + include($filename) end end end diff --git a/test/basics/setup.jl b/test/setup.jl similarity index 100% rename from test/basics/setup.jl rename to test/setup.jl diff --git a/test/basics/test_array_cast.jl b/test/test_array_cast.jl similarity index 100% rename from test/basics/test_array_cast.jl rename to test/test_array_cast.jl diff --git a/test/basics/test_basics.jl b/test/test_basics.jl similarity index 100% rename from test/basics/test_basics.jl rename to test/test_basics.jl diff --git a/test/basics/test_contraction.jl b/test/test_contraction.jl similarity index 100% rename from test/basics/test_contraction.jl rename to test/test_contraction.jl diff --git a/test/basics/test_fusion_trees.jl b/test/test_fusion_trees.jl similarity index 100% rename from test/basics/test_fusion_trees.jl rename to test/test_fusion_trees.jl diff --git a/test/basics/test_linear_algebra.jl b/test/test_linear_algebra.jl similarity index 100% rename from test/basics/test_linear_algebra.jl rename to test/test_linear_algebra.jl diff --git a/test/basics/test_permutedims.jl b/test/test_permutedims.jl similarity index 100% rename from test/basics/test_permutedims.jl rename to test/test_permutedims.jl