Apply REUSE licensing

goerz · goerz · commit c2f8c6655f0d · 2026-06-20T12:49:41.000-04:00
diff --git a/.coverage/.gitignore b/.coverage/.gitignore
@@ -1 +1,5 @@
+# SPDX-FileCopyrightText: © 2022 Michael Goerz <mail@michaelgoerz.net>
+#
+# SPDX-License-Identifier: MIT OR CC0-1.0
+
 *.info
diff --git a/.github/dependabot.yml b/.github/dependabot.yml
@@ -1,3 +1,7 @@
+# SPDX-FileCopyrightText: © 2022 Michael Goerz <mail@michaelgoerz.net>
+#
+# SPDX-License-Identifier: MIT OR CC0-1.0
+
 # https://docs.github.com/github/administering-a-repository/configuration-options-for-dependency-updates
 version: 2
 updates:
diff --git a/.github/workflows/CI.yml b/.github/workflows/CI.yml
@@ -1,3 +1,7 @@
+# SPDX-FileCopyrightText: © 2022 Michael Goerz <mail@michaelgoerz.net>
+#
+# SPDX-License-Identifier: MIT OR CC0-1.0
+
 name: CI
 on:
   push:
diff --git a/.github/workflows/CompatHelper.yml b/.github/workflows/CompatHelper.yml
@@ -1,3 +1,7 @@
+# SPDX-FileCopyrightText: © 2022 Michael Goerz <mail@michaelgoerz.net>
+#
+# SPDX-License-Identifier: MIT OR CC0-1.0
+
 name: CompatHelper
 on:
   schedule:
diff --git a/.github/workflows/REUSE.yml b/.github/workflows/REUSE.yml
@@ -0,0 +1,27 @@
+# SPDX-FileCopyrightText: © 2022 Michael Goerz <mail@michaelgoerz.net>
+#
+# SPDX-License-Identifier: MIT OR CC0-1.0
+
+name: REUSE
+on:
+  push:
+    branches:
+      - master
+      - dev
+      - 'release-*'
+    tags:
+      - '*'
+  pull_request:
+    branches:
+      - master
+permissions:
+  contents: read
+jobs:
+  reuse-compliance-check:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v6
+
+      - name: REUSE Compliance Check
+        uses: fsfe/reuse-action@v6
diff --git a/.github/workflows/TagBot.yml b/.github/workflows/TagBot.yml
@@ -1,3 +1,7 @@
+# SPDX-FileCopyrightText: © 2022 Michael Goerz <mail@michaelgoerz.net>
+#
+# SPDX-License-Identifier: MIT OR CC0-1.0
+
 name: TagBot
 on:
   issue_comment:
diff --git a/.gitignore b/.gitignore
@@ -1,3 +1,7 @@
+# SPDX-FileCopyrightText: © 2022 Michael Goerz <mail@michaelgoerz.net>
+#
+# SPDX-License-Identifier: MIT OR CC0-1.0
+
 *.jl.*.cov
 *.jl.cov
 *.jl.mem
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -1,3 +1,9 @@
+<!--
+SPDX-FileCopyrightText: © 2022 Michael Goerz <mail@michaelgoerz.net>
+
+SPDX-License-Identifier: MIT OR CC0-1.0
+-->
+
 # Contributing
 
 Everyone is welcome to contribute! You can contribute simply by opening issues to report bugs or request features.
@@ -6,4 +12,9 @@ Development of all packages in the [JuliaQuantumControl] organization follows sh
 
 <https://github.com/JuliaQuantumControl/.github/blob/master/CONTRIBUTING.md>
 
+
+## Licensing
+
+This package is [REUSE-compliant](https://reuse.software): every file declares its copyright and license via SPDX tags, which CI enforces (verify locally with `make reuse`). When adding a new file, include an SPDX header (or a sidecar `*.license` file when the format has no comment syntax) with the copyright `© <year> Michael Goerz <mail@michaelgoerz.net>`, and choose the license by category: source code (`src/`, `ext/`, `test/`) → `MIT`; prose/documentation (`README`, `docs/src/*.md`) → `MIT OR CC-BY-4.0`; trivial config/tooling (`Makefile`, `.gitignore`, CI YAML, `Project.toml`, …) → `MIT OR CC0-1.0`. Any license used must have its text in `LICENSES/`.
+
 [JuliaQuantumControl]: https://github.com/JuliaQuantumControl
diff --git a/LICENSE b/LICENSE
@@ -1,6 +1,15 @@
+This project follows the REUSE specification for copyright and licensing
+information. The authoritative copyright and licensing information is provided
+by SPDX notices in individual files and, where applicable, by REUSE.toml.
+
+The primary source code for the package is licensed under the MIT License
+(below). The full license texts for the licenses used in this project are
+located in the LICENSES/ directory. See https://reuse.software/ for more
+information about the REUSE specification.
+
 MIT License
 
-Copyright (c) 2022 Michael Goerz <mail@michaelgoerz.net>
+Copyright (c) 2022 Michael Goerz <mail@michaelgoerz.net> and contributors
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal
diff --git a/LICENSES/CC-BY-4.0.txt b/LICENSES/CC-BY-4.0.txt
diff --git a/LICENSES/CC0-1.0.txt b/LICENSES/CC0-1.0.txt
@@ -0,0 +1,121 @@
+Creative Commons Legal Code
+
+CC0 1.0 Universal
+
+    CREATIVE COMMONS CORPORATION IS NOT A LAW FIRM AND DOES NOT PROVIDE
+    LEGAL SERVICES. DISTRIBUTION OF THIS DOCUMENT DOES NOT CREATE AN
+    ATTORNEY-CLIENT RELATIONSHIP. CREATIVE COMMONS PROVIDES THIS
+    INFORMATION ON AN "AS-IS" BASIS. CREATIVE COMMONS MAKES NO WARRANTIES
+    REGARDING THE USE OF THIS DOCUMENT OR THE INFORMATION OR WORKS
+    PROVIDED HEREUNDER, AND DISCLAIMS LIABILITY FOR DAMAGES RESULTING FROM
+    THE USE OF THIS DOCUMENT OR THE INFORMATION OR WORKS PROVIDED
+    HEREUNDER.
+
+Statement of Purpose
+
+The laws of most jurisdictions throughout the world automatically confer
+exclusive Copyright and Related Rights (defined below) upon the creator
+and subsequent owner(s) (each and all, an "owner") of an original work of
+authorship and/or a database (each, a "Work").
+
+Certain owners wish to permanently relinquish those rights to a Work for
+the purpose of contributing to a commons of creative, cultural and
+scientific works ("Commons") that the public can reliably and without fear
+of later claims of infringement build upon, modify, incorporate in other
+works, reuse and redistribute as freely as possible in any form whatsoever
+and for any purposes, including without limitation commercial purposes.
+These owners may contribute to the Commons to promote the ideal of a free
+culture and the further production of creative, cultural and scientific
+works, or to gain reputation or greater distribution for their Work in
+part through the use and efforts of others.
+
+For these and/or other purposes and motivations, and without any
+expectation of additional consideration or compensation, the person
+associating CC0 with a Work (the "Affirmer"), to the extent that he or she
+is an owner of Copyright and Related Rights in the Work, voluntarily
+elects to apply CC0 to the Work and publicly distribute the Work under its
+terms, with knowledge of his or her Copyright and Related Rights in the
+Work and the meaning and intended legal effect of CC0 on those rights.
+
+1. Copyright and Related Rights. A Work made available under CC0 may be
+protected by copyright and related or neighboring rights ("Copyright and
+Related Rights"). Copyright and Related Rights include, but are not
+limited to, the following:
+
+  i. the right to reproduce, adapt, distribute, perform, display,
+     communicate, and translate a Work;
+ ii. moral rights retained by the original author(s) and/or performer(s);
+iii. publicity and privacy rights pertaining to a person's image or
+     likeness depicted in a Work;
+ iv. rights protecting against unfair competition in regards to a Work,
+     subject to the limitations in paragraph 4(a), below;
+  v. rights protecting the extraction, dissemination, use and reuse of data
+     in a Work;
+ vi. database rights (such as those arising under Directive 96/9/EC of the
+     European Parliament and of the Council of 11 March 1996 on the legal
+     protection of databases, and under any national implementation
+     thereof, including any amended or successor version of such
+     directive); and
+vii. other similar, equivalent or corresponding rights throughout the
+     world based on applicable law or treaty, and any national
+     implementations thereof.
+
+2. Waiver. To the greatest extent permitted by, but not in contravention
+of, applicable law, Affirmer hereby overtly, fully, permanently,
+irrevocably and unconditionally waives, abandons, and surrenders all of
+Affirmer's Copyright and Related Rights and associated claims and causes
+of action, whether now known or unknown (including existing as well as
+future claims and causes of action), in the Work (i) in all territories
+worldwide, (ii) for the maximum duration provided by applicable law or
+treaty (including future time extensions), (iii) in any current or future
+medium and for any number of copies, and (iv) for any purpose whatsoever,
+including without limitation commercial, advertising or promotional
+purposes (the "Waiver"). Affirmer makes the Waiver for the benefit of each
+member of the public at large and to the detriment of Affirmer's heirs and
+successors, fully intending that such Waiver shall not be subject to
+revocation, rescission, cancellation, termination, or any other legal or
+equitable action to disrupt the quiet enjoyment of the Work by the public
+as contemplated by Affirmer's express Statement of Purpose.
+
+3. Public License Fallback. Should any part of the Waiver for any reason
+be judged legally invalid or ineffective under applicable law, then the
+Waiver shall be preserved to the maximum extent permitted taking into
+account Affirmer's express Statement of Purpose. In addition, to the
+extent the Waiver is so judged Affirmer hereby grants to each affected
+person a royalty-free, non transferable, non sublicensable, non exclusive,
+irrevocable and unconditional license to exercise Affirmer's Copyright and
+Related Rights in the Work (i) in all territories worldwide, (ii) for the
+maximum duration provided by applicable law or treaty (including future
+time extensions), (iii) in any current or future medium and for any number
+of copies, and (iv) for any purpose whatsoever, including without
+limitation commercial, advertising or promotional purposes (the
+"License"). The License shall be deemed effective as of the date CC0 was
+applied by Affirmer to the Work. Should any part of the License for any
+reason be judged legally invalid or ineffective under applicable law, such
+partial invalidity or ineffectiveness shall not invalidate the remainder
+of the License, and in such case Affirmer hereby affirms that he or she
+will not (i) exercise any of his or her remaining Copyright and Related
+Rights in the Work or (ii) assert any associated claims and causes of
+action with respect to the Work, in either case contrary to Affirmer's
+express Statement of Purpose.
+
+4. Limitations and Disclaimers.
+
+ a. No trademark or patent rights held by Affirmer are waived, abandoned,
+    surrendered, licensed or otherwise affected by this document.
+ b. Affirmer offers the Work as-is and makes no representations or
+    warranties of any kind concerning the Work, express, implied,
+    statutory or otherwise, including without limitation warranties of
+    title, merchantability, fitness for a particular purpose, non
+    infringement, or the absence of latent or other defects, accuracy, or
+    the present or absence of errors, whether or not discoverable, all to
+    the greatest extent permissible under applicable law.
+ c. Affirmer disclaims responsibility for clearing rights of other persons
+    that may apply to the Work or any use thereof, including without
+    limitation any person's Copyright and Related Rights in the Work.
+    Further, Affirmer disclaims responsibility for obtaining any necessary
+    consents, permissions or other rights required for any use of the
+    Work.
+ d. Affirmer understands and acknowledges that Creative Commons is not a
+    party to this document and has no duty or obligation with respect to
+    this CC0 or use of the Work.
diff --git a/LICENSES/MIT.txt b/LICENSES/MIT.txt
@@ -0,0 +1,18 @@
+MIT License
+
+Copyright (c) <year> <copyright holders>
+
+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.
diff --git a/Makefile b/Makefile
@@ -1,4 +1,8 @@
-.PHONY: help test docs clean distclean devrepl codestyle servedocs
+# SPDX-FileCopyrightText: © 2022 Michael Goerz <mail@michaelgoerz.net>
+#
+# SPDX-License-Identifier: MIT OR CC0-1.0
+
+.PHONY: help test docs clean distclean devrepl codestyle servedocs reuse
 .DEFAULT_GOAL := help
 
 JULIA ?= julia
@@ -62,5 +66,17 @@ codestyle: test/Manifest.toml .JuliaFormatter.toml ## Apply the codestyle to the
 	$(JULIA) --project=test -e 'using JuliaFormatter; format(".", verbose=true)'
 	@echo "Done. Consider using 'make devrepl'"
 
+reuse: ## Check REUSE/SPDX licensing compliance (requires uv or pipx)
+	@if command -v reuse >/dev/null 2>&1; then \
+	    reuse lint; \
+	elif command -v uvx >/dev/null 2>&1; then \
+	    uvx reuse lint; \
+	elif command -v pipx >/dev/null 2>&1; then \
+	    pipx run reuse lint; \
+	else \
+	    echo "Please install 'reuse' (https://reuse.software), or 'uv'/'pipx'"; \
+	    exit 1; \
+	fi
+
 distclean: clean ## Restore to a clean checkout state
 	$(JULIA) -e 'include("test/clean.jl"); clean(distclean=true)'
diff --git a/README.md b/README.md
@@ -1,3 +1,9 @@
+<!--
+SPDX-FileCopyrightText: © 2022 Michael Goerz <mail@michaelgoerz.net>
+
+SPDX-License-Identifier: MIT OR CC-BY-4.0
+-->
+
 # QuantumGradientGenerators
 
 [![Version](https://juliahub.com/docs/General/QuantumGradientGenerators/stable/version.svg)](https://juliahub.com/ui/Packages/General/QuantumGradientGenerators)
diff --git a/REUSE.toml b/REUSE.toml
@@ -0,0 +1,11 @@
+version = 1
+
+# Package metadata files are managed by Julia's Pkg and cannot reliably carry
+# SPDX comment headers.
+[[annotations]]
+path = [
+    "**/Project.toml",
+    "**/Manifest.toml",
+]
+SPDX-FileCopyrightText = "© 2022 Michael Goerz <mail@michaelgoerz.net>"
+SPDX-License-Identifier = "MIT OR CC0-1.0"
diff --git a/devrepl.jl b/devrepl.jl
@@ -1,3 +1,7 @@
+# SPDX-FileCopyrightText: © 2022 Michael Goerz <mail@michaelgoerz.net>
+#
+# SPDX-License-Identifier: MIT OR CC0-1.0
+
 # Source this script as e.g.
 #
 #     include("PATH/TO/devrepl.jl")
diff --git a/docs/make.jl b/docs/make.jl
@@ -1,3 +1,7 @@
+# SPDX-FileCopyrightText: © 2022 Michael Goerz <mail@michaelgoerz.net>
+#
+# SPDX-License-Identifier: MIT OR CC0-1.0
+
 using QuantumGradientGenerators
 using Documenter
 using DocumenterInterLinks
diff --git a/docs/src/api.md b/docs/src/api.md
@@ -1,3 +1,9 @@
+<!--
+SPDX-FileCopyrightText: © 2022 Michael Goerz <mail@michaelgoerz.net>
+
+SPDX-License-Identifier: MIT OR CC-BY-4.0
+-->
+
 # `QuantumGradientGenerators` API
 
 ## Index
diff --git a/docs/src/index.md b/docs/src/index.md
@@ -1,4 +1,6 @@
 ```@meta
+# SPDX-FileCopyrightText: © 2022 Michael Goerz <mail@michaelgoerz.net>
+# SPDX-License-Identifier: MIT OR CC-BY-4.0
 CurrentModule = QuantumGradientGenerators
 ```
 
diff --git a/ext/QuantumGradientGeneratorsArrayInterfaceExt.jl b/ext/QuantumGradientGeneratorsArrayInterfaceExt.jl
@@ -1,3 +1,7 @@
+# SPDX-FileCopyrightText: © 2022 Michael Goerz <mail@michaelgoerz.net>
+#
+# SPDX-License-Identifier: MIT
+
 module QuantumGradientGeneratorsArrayInterfaceExt
 
 import ArrayInterface
diff --git a/src/QuantumGradientGenerators.jl b/src/QuantumGradientGenerators.jl
@@ -1,3 +1,7 @@
+# SPDX-FileCopyrightText: © 2022 Michael Goerz <mail@michaelgoerz.net>
+#
+# SPDX-License-Identifier: MIT
+
 module QuantumGradientGenerators
 
 export GradGenerator, GradgenOperator, GradVector, resetgradvec!
diff --git a/src/evaluate.jl b/src/evaluate.jl
@@ -1,3 +1,7 @@
+# SPDX-FileCopyrightText: © 2022 Michael Goerz <mail@michaelgoerz.net>
+#
+# SPDX-License-Identifier: MIT
+
 import QuantumControl.QuantumPropagators.Controls: evaluate, evaluate!
 
 
diff --git a/src/grad_generator.jl b/src/grad_generator.jl
@@ -1,3 +1,7 @@
+# SPDX-FileCopyrightText: © 2022 Michael Goerz <mail@michaelgoerz.net>
+#
+# SPDX-License-Identifier: MIT
+
 using QuantumControl.Controls: get_control_derivs
 import QuantumControl.QuantumPropagators.Controls: get_controls
 import QuantumControl.QuantumPropagators.Controls: get_parameters
diff --git a/src/grad_vector.jl b/src/grad_vector.jl
@@ -1,3 +1,7 @@
+# SPDX-FileCopyrightText: © 2022 Michael Goerz <mail@michaelgoerz.net>
+#
+# SPDX-License-Identifier: MIT
+
 import QuantumControl.QuantumPropagators: _exp_prop_convert_state
 import QuantumControl.QuantumPropagators.Interfaces:
     supports_inplace, supports_vector_interface
diff --git a/src/gradgen_operator.jl b/src/gradgen_operator.jl
@@ -1,3 +1,7 @@
+# SPDX-FileCopyrightText: © 2022 Michael Goerz <mail@michaelgoerz.net>
+#
+# SPDX-License-Identifier: MIT
+
 using Random: GLOBAL_RNG
 import QuantumControl.QuantumPropagators: _exp_prop_convert_operator
 import QuantumControl.QuantumPropagators.Controls: get_controls
diff --git a/src/linalg.jl b/src/linalg.jl
@@ -1,3 +1,7 @@
+# SPDX-FileCopyrightText: © 2022 Michael Goerz <mail@michaelgoerz.net>
+#
+# SPDX-License-Identifier: MIT
+
 import LinearAlgebra
 import Base: +, -, *
 
diff --git a/test/clean.jl b/test/clean.jl
@@ -1,3 +1,7 @@
+# SPDX-FileCopyrightText: © 2022 Michael Goerz <mail@michaelgoerz.net>
+#
+# SPDX-License-Identifier: MIT
+
 """
     clean([distclean=false])
 
diff --git a/test/init.jl b/test/init.jl
diff --git a/test/runtests.jl b/test/runtests.jl
diff --git a/test/test_gradgen.jl b/test/test_gradgen.jl
diff --git a/test/test_interface.jl b/test/test_interface.jl
diff --git a/test/test_specrad.jl b/test/test_specrad.jl

-Original file line number
+Diff line change
@@ @@ -1 +1,5 @@ @@
 +# SPDX-FileCopyrightText: © 2022 Michael Goerz <mail@michaelgoerz.net>
 +#
 +# SPDX-License-Identifier: MIT OR CC0-1.0
++
 *.info