diff --git a/.coverage/.gitignore b/.coverage/.gitignore index bf12a974..c593c6e1 100644 --- a/.coverage/.gitignore +++ b/.coverage/.gitignore @@ -1 +1,5 @@ +# SPDX-FileCopyrightText: © 2021 Michael Goerz +# +# SPDX-License-Identifier: MIT OR CC0-1.0 + *.info diff --git a/.git-blame-ignore-revs b/.git-blame-ignore-revs index 00871f29..bc5b3c9e 100644 --- a/.git-blame-ignore-revs +++ b/.git-blame-ignore-revs @@ -1,2 +1,6 @@ +# SPDX-FileCopyrightText: © 2021 Michael Goerz +# +# SPDX-License-Identifier: MIT OR CC0-1.0 + # Change to project .JuliaFormatter.toml: use spaces around keyword arguments 37a40bcb05e63e034db46fbc2f0ccd21b5643535 diff --git a/.github/dependabot.yml b/.github/dependabot.yml index 700707ce..c571d783 100644 --- a/.github/dependabot.yml +++ b/.github/dependabot.yml @@ -1,3 +1,7 @@ +# SPDX-FileCopyrightText: © 2021 Michael Goerz +# +# 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 index c2d1de19..1c153b25 100644 --- a/.github/workflows/CI.yml +++ b/.github/workflows/CI.yml @@ -1,3 +1,7 @@ +# SPDX-FileCopyrightText: © 2021 Michael Goerz +# +# SPDX-License-Identifier: MIT OR CC0-1.0 + name: CI on: push: diff --git a/.github/workflows/CompatHelper.yml b/.github/workflows/CompatHelper.yml index cba9134c..73c2e776 100644 --- a/.github/workflows/CompatHelper.yml +++ b/.github/workflows/CompatHelper.yml @@ -1,3 +1,7 @@ +# SPDX-FileCopyrightText: © 2021 Michael Goerz +# +# SPDX-License-Identifier: MIT OR CC0-1.0 + name: CompatHelper on: schedule: diff --git a/.github/workflows/GRAPE.yml b/.github/workflows/GRAPE.yml index 7851867e..cf4e24fc 100644 --- a/.github/workflows/GRAPE.yml +++ b/.github/workflows/GRAPE.yml @@ -1,3 +1,7 @@ +# SPDX-FileCopyrightText: © 2021 Michael Goerz +# +# SPDX-License-Identifier: MIT OR CC0-1.0 + name: Test downstream GRAPE on: push: diff --git a/.github/workflows/Krotov.yml b/.github/workflows/Krotov.yml index 82a1bc88..866abc99 100644 --- a/.github/workflows/Krotov.yml +++ b/.github/workflows/Krotov.yml @@ -1,3 +1,7 @@ +# SPDX-FileCopyrightText: © 2021 Michael Goerz +# +# SPDX-License-Identifier: MIT OR CC0-1.0 + name: Test downstream Krotov on: push: diff --git a/.github/workflows/REUSE.yml b/.github/workflows/REUSE.yml new file mode 100644 index 00000000..07bf967c --- /dev/null +++ b/.github/workflows/REUSE.yml @@ -0,0 +1,21 @@ +# SPDX-FileCopyrightText: © 2021 Michael Goerz +# +# SPDX-License-Identifier: MIT OR CC0-1.0 + +name: REUSE +on: + push: + branches: + - master + - dev + - 'release-*' + pull_request: + branches: + - master +jobs: + reuse: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v4 + - name: REUSE Compliance Check + uses: fsfe/reuse-action@v6 diff --git a/.github/workflows/TagBot.yml b/.github/workflows/TagBot.yml index f49313b6..8b238625 100644 --- a/.github/workflows/TagBot.yml +++ b/.github/workflows/TagBot.yml @@ -1,3 +1,7 @@ +# SPDX-FileCopyrightText: © 2021 Michael Goerz +# +# SPDX-License-Identifier: MIT OR CC0-1.0 + name: TagBot on: issue_comment: diff --git a/.gitignore b/.gitignore index 6aa99265..6a79d735 100644 --- a/.gitignore +++ b/.gitignore @@ -1,3 +1,7 @@ +# SPDX-FileCopyrightText: © 2021 Michael Goerz +# +# SPDX-License-Identifier: MIT OR CC0-1.0 + *.jl.*.cov *.jl.cov *.jl.mem diff --git a/CHANGELOG.md b/CHANGELOG.md index aea15bd5..2aff5083 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,3 +1,9 @@ + + # Release Notes The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), @@ -13,6 +19,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 * Changed: `J_a_fluence` now also works on non-uniform time grids [[#108]] * Changed: `J_b` is now evaluated using the trapezoidal rule [[#105]] * Fixed: Compatibility with Zygote 0.7 +* Added: The project now follows the [REUSE specification](https://reuse.software/) for copyright and licensing information, with SPDX headers on all files ## [v0.11.3] — 2025-09-30 diff --git a/CLAUDE.md b/CLAUDE.md index 51ab3fd5..86c77b58 100644 --- a/CLAUDE.md +++ b/CLAUDE.md @@ -1,3 +1,9 @@ + + # CLAUDE.md This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository. diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 1c47483a..089f4428 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,3 +1,9 @@ + + # Contributing Everyone is welcome to contribute! You can contribute simply by opening issues to report bugs or request features. @@ -6,4 +12,23 @@ Development of all packages in the [JuliaQuantumControl] organization follows sh + +## Licensing + +This package follows the [REUSE specification](https://reuse.software/): every committed file must declare its copyright and license via SPDX information. New files should carry a header in the appropriate comment style, for example: + +```julia +# SPDX-FileCopyrightText: © 2021 Michael Goerz +# +# SPDX-License-Identifier: MIT +``` + +Use these license identifiers by file type: + +- Source code (`src/`, `ext/`, `test/`): `MIT` +- Prose and documentation (`README.md`, `docs/src/*.md`): `MIT OR CC-BY-4.0` +- Meta-docs and trivial config (other top-level `*.md`, `Makefile`, CI YAML, `Project.toml`, …): `MIT OR CC0-1.0` + +For files that cannot carry a comment (images, binary assets), add an adjacent `.license` sidecar; for files rewritten by tooling (`Project.toml`, generated `*.toml`, `*.bib`), add an entry to `REUSE.toml`. Documenter pages (`docs/src/*.md`) put the SPDX tags inside a leading `@meta` block. Run `make reuse` (or `reuse lint`) to verify compliance. + [JuliaQuantumControl]: https://github.com/JuliaQuantumControl diff --git a/LICENSE b/LICENSE index 9976df0a..99f8002c 100644 --- a/LICENSE +++ b/LICENSE @@ -1,3 +1,12 @@ +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) 2024 Michael Goerz , and contributors diff --git a/LICENSES/CC-BY-4.0.txt b/LICENSES/CC-BY-4.0.txt new file mode 100644 index 00000000..13ca539f --- /dev/null +++ b/LICENSES/CC-BY-4.0.txt @@ -0,0 +1,156 @@ +Creative Commons Attribution 4.0 International + + Creative Commons Corporation (“Creative Commons”) is not a law firm and does not provide legal services or legal advice. Distribution of Creative Commons public licenses does not create a lawyer-client or other relationship. Creative Commons makes its licenses and related information available on an “as-is” basis. Creative Commons gives no warranties regarding its licenses, any material licensed under their terms and conditions, or any related information. Creative Commons disclaims all liability for damages resulting from their use to the fullest extent possible. + +Using Creative Commons Public Licenses + +Creative Commons public licenses provide a standard set of terms and conditions that creators and other rights holders may use to share original works of authorship and other material subject to copyright and certain other rights specified in the public license below. The following considerations are for informational purposes only, are not exhaustive, and do not form part of our licenses. + +Considerations for licensors: Our public licenses are intended for use by those authorized to give the public permission to use material in ways otherwise restricted by copyright and certain other rights. Our licenses are irrevocable. Licensors should read and understand the terms and conditions of the license they choose before applying it. Licensors should also secure all rights necessary before applying our licenses so that the public can reuse the material as expected. Licensors should clearly mark any material not subject to the license. This includes other CC-licensed material, or material used under an exception or limitation to copyright. More considerations for licensors. + +Considerations for the public: By using one of our public licenses, a licensor grants the public permission to use the licensed material under specified terms and conditions. If the licensor’s permission is not necessary for any reason–for example, because of any applicable exception or limitation to copyright–then that use is not regulated by the license. Our licenses grant only permissions under copyright and certain other rights that a licensor has authority to grant. Use of the licensed material may still be restricted for other reasons, including because others have copyright or other rights in the material. A licensor may make special requests, such as asking that all changes be marked or described. Although not required by our licenses, you are encouraged to respect those requests where reasonable. More considerations for the public. + +Creative Commons Attribution 4.0 International Public License + +By exercising the Licensed Rights (defined below), You accept and agree to be bound by the terms and conditions of this Creative Commons Attribution 4.0 International Public License ("Public License"). To the extent this Public License may be interpreted as a contract, You are granted the Licensed Rights in consideration of Your acceptance of these terms and conditions, and the Licensor grants You such rights in consideration of benefits the Licensor receives from making the Licensed Material available under these terms and conditions. + +Section 1 – Definitions. + + a. Adapted Material means material subject to Copyright and Similar Rights that is derived from or based upon the Licensed Material and in which the Licensed Material is translated, altered, arranged, transformed, or otherwise modified in a manner requiring permission under the Copyright and Similar Rights held by the Licensor. For purposes of this Public License, where the Licensed Material is a musical work, performance, or sound recording, Adapted Material is always produced where the Licensed Material is synched in timed relation with a moving image. + + b. Adapter's License means the license You apply to Your Copyright and Similar Rights in Your contributions to Adapted Material in accordance with the terms and conditions of this Public License. + + c. Copyright and Similar Rights means copyright and/or similar rights closely related to copyright including, without limitation, performance, broadcast, sound recording, and Sui Generis Database Rights, without regard to how the rights are labeled or categorized. For purposes of this Public License, the rights specified in Section 2(b)(1)-(2) are not Copyright and Similar Rights. + + d. Effective Technological Measures means those measures that, in the absence of proper authority, may not be circumvented under laws fulfilling obligations under Article 11 of the WIPO Copyright Treaty adopted on December 20, 1996, and/or similar international agreements. + + e. Exceptions and Limitations means fair use, fair dealing, and/or any other exception or limitation to Copyright and Similar Rights that applies to Your use of the Licensed Material. + + f. Licensed Material means the artistic or literary work, database, or other material to which the Licensor applied this Public License. + + g. Licensed Rights means the rights granted to You subject to the terms and conditions of this Public License, which are limited to all Copyright and Similar Rights that apply to Your use of the Licensed Material and that the Licensor has authority to license. + + h. Licensor means the individual(s) or entity(ies) granting rights under this Public License. + + i. Share means to provide material to the public by any means or process that requires permission under the Licensed Rights, such as reproduction, public display, public performance, distribution, dissemination, communication, or importation, and to make material available to the public including in ways that members of the public may access the material from a place and at a time individually chosen by them. + + j. Sui Generis Database Rights means rights other than copyright resulting from Directive 96/9/EC of the European Parliament and of the Council of 11 March 1996 on the legal protection of databases, as amended and/or succeeded, as well as other essentially equivalent rights anywhere in the world. + + k. You means the individual or entity exercising the Licensed Rights under this Public License. Your has a corresponding meaning. + +Section 2 – Scope. + + a. License grant. + + 1. Subject to the terms and conditions of this Public License, the Licensor hereby grants You a worldwide, royalty-free, non-sublicensable, non-exclusive, irrevocable license to exercise the Licensed Rights in the Licensed Material to: + + A. reproduce and Share the Licensed Material, in whole or in part; and + + B. produce, reproduce, and Share Adapted Material. + + 2. Exceptions and Limitations. For the avoidance of doubt, where Exceptions and Limitations apply to Your use, this Public License does not apply, and You do not need to comply with its terms and conditions. + + 3. Term. The term of this Public License is specified in Section 6(a). + + 4. Media and formats; technical modifications allowed. The Licensor authorizes You to exercise the Licensed Rights in all media and formats whether now known or hereafter created, and to make technical modifications necessary to do so. The Licensor waives and/or agrees not to assert any right or authority to forbid You from making technical modifications necessary to exercise the Licensed Rights, including technical modifications necessary to circumvent Effective Technological Measures. For purposes of this Public License, simply making modifications authorized by this Section 2(a)(4) never produces Adapted Material. + + 5. Downstream recipients. + + A. Offer from the Licensor – Licensed Material. Every recipient of the Licensed Material automatically receives an offer from the Licensor to exercise the Licensed Rights under the terms and conditions of this Public License. + + B. No downstream restrictions. You may not offer or impose any additional or different terms or conditions on, or apply any Effective Technological Measures to, the Licensed Material if doing so restricts exercise of the Licensed Rights by any recipient of the Licensed Material. + + 6. No endorsement. Nothing in this Public License constitutes or may be construed as permission to assert or imply that You are, or that Your use of the Licensed Material is, connected with, or sponsored, endorsed, or granted official status by, the Licensor or others designated to receive attribution as provided in Section 3(a)(1)(A)(i). + +b. Other rights. + + 1. Moral rights, such as the right of integrity, are not licensed under this Public License, nor are publicity, privacy, and/or other similar personality rights; however, to the extent possible, the Licensor waives and/or agrees not to assert any such rights held by the Licensor to the limited extent necessary to allow You to exercise the Licensed Rights, but not otherwise. + + 2. Patent and trademark rights are not licensed under this Public License. + + 3. To the extent possible, the Licensor waives any right to collect royalties from You for the exercise of the Licensed Rights, whether directly or through a collecting society under any voluntary or waivable statutory or compulsory licensing scheme. In all other cases the Licensor expressly reserves any right to collect such royalties. + +Section 3 – License Conditions. + +Your exercise of the Licensed Rights is expressly made subject to the following conditions. + + a. Attribution. + + 1. If You Share the Licensed Material (including in modified form), You must: + + A. retain the following if it is supplied by the Licensor with the Licensed Material: + + i. identification of the creator(s) of the Licensed Material and any others designated to receive attribution, in any reasonable manner requested by the Licensor (including by pseudonym if designated); + + ii. a copyright notice; + + iii. a notice that refers to this Public License; + + iv. a notice that refers to the disclaimer of warranties; + + v. a URI or hyperlink to the Licensed Material to the extent reasonably practicable; + + B. indicate if You modified the Licensed Material and retain an indication of any previous modifications; and + + C. indicate the Licensed Material is licensed under this Public License, and include the text of, or the URI or hyperlink to, this Public License. + + 2. You may satisfy the conditions in Section 3(a)(1) in any reasonable manner based on the medium, means, and context in which You Share the Licensed Material. For example, it may be reasonable to satisfy the conditions by providing a URI or hyperlink to a resource that includes the required information. + + 3. If requested by the Licensor, You must remove any of the information required by Section 3(a)(1)(A) to the extent reasonably practicable. + + 4. If You Share Adapted Material You produce, the Adapter's License You apply must not prevent recipients of the Adapted Material from complying with this Public License. + +Section 4 – Sui Generis Database Rights. + +Where the Licensed Rights include Sui Generis Database Rights that apply to Your use of the Licensed Material: + + a. for the avoidance of doubt, Section 2(a)(1) grants You the right to extract, reuse, reproduce, and Share all or a substantial portion of the contents of the database; + + b. if You include all or a substantial portion of the database contents in a database in which You have Sui Generis Database Rights, then the database in which You have Sui Generis Database Rights (but not its individual contents) is Adapted Material; and + + c. You must comply with the conditions in Section 3(a) if You Share all or a substantial portion of the contents of the database. +For the avoidance of doubt, this Section 4 supplements and does not replace Your obligations under this Public License where the Licensed Rights include other Copyright and Similar Rights. + +Section 5 – Disclaimer of Warranties and Limitation of Liability. + + a. Unless otherwise separately undertaken by the Licensor, to the extent possible, the Licensor offers the Licensed Material as-is and as-available, and makes no representations or warranties of any kind concerning the Licensed Material, whether express, implied, statutory, or other. This includes, without limitation, warranties of title, merchantability, fitness for a particular purpose, non-infringement, absence of latent or other defects, accuracy, or the presence or absence of errors, whether or not known or discoverable. Where disclaimers of warranties are not allowed in full or in part, this disclaimer may not apply to You. + + b. To the extent possible, in no event will the Licensor be liable to You on any legal theory (including, without limitation, negligence) or otherwise for any direct, special, indirect, incidental, consequential, punitive, exemplary, or other losses, costs, expenses, or damages arising out of this Public License or use of the Licensed Material, even if the Licensor has been advised of the possibility of such losses, costs, expenses, or damages. Where a limitation of liability is not allowed in full or in part, this limitation may not apply to You. + + c. The disclaimer of warranties and limitation of liability provided above shall be interpreted in a manner that, to the extent possible, most closely approximates an absolute disclaimer and waiver of all liability. + +Section 6 – Term and Termination. + + a. This Public License applies for the term of the Copyright and Similar Rights licensed here. However, if You fail to comply with this Public License, then Your rights under this Public License terminate automatically. + + b. Where Your right to use the Licensed Material has terminated under Section 6(a), it reinstates: + + 1. automatically as of the date the violation is cured, provided it is cured within 30 days of Your discovery of the violation; or + + 2. upon express reinstatement by the Licensor. + + c. For the avoidance of doubt, this Section 6(b) does not affect any right the Licensor may have to seek remedies for Your violations of this Public License. + + d. For the avoidance of doubt, the Licensor may also offer the Licensed Material under separate terms or conditions or stop distributing the Licensed Material at any time; however, doing so will not terminate this Public License. + + e. Sections 1, 5, 6, 7, and 8 survive termination of this Public License. + +Section 7 – Other Terms and Conditions. + + a. The Licensor shall not be bound by any additional or different terms or conditions communicated by You unless expressly agreed. + + b. Any arrangements, understandings, or agreements regarding the Licensed Material not stated herein are separate from and independent of the terms and conditions of this Public License. + +Section 8 – Interpretation. + + a. For the avoidance of doubt, this Public License does not, and shall not be interpreted to, reduce, limit, restrict, or impose conditions on any use of the Licensed Material that could lawfully be made without permission under this Public License. + + b. To the extent possible, if any provision of this Public License is deemed unenforceable, it shall be automatically reformed to the minimum extent necessary to make it enforceable. If the provision cannot be reformed, it shall be severed from this Public License without affecting the enforceability of the remaining terms and conditions. + + c. No term or condition of this Public License will be waived and no failure to comply consented to unless expressly agreed to by the Licensor. + + d. Nothing in this Public License constitutes or may be interpreted as a limitation upon, or waiver of, any privileges and immunities that apply to the Licensor or You, including from the legal processes of any jurisdiction or authority. + +Creative Commons is not a party to its public licenses. Notwithstanding, Creative Commons may elect to apply one of its public licenses to material it publishes and in those instances will be considered the “Licensor.” Except for the limited purpose of indicating that material is shared under a Creative Commons public license or as otherwise permitted by the Creative Commons policies published at creativecommons.org/policies, Creative Commons does not authorize the use of the trademark “Creative Commons” or any other trademark or logo of Creative Commons without its prior written consent including, without limitation, in connection with any unauthorized modifications to any of its public licenses or any other arrangements, understandings, or agreements concerning use of licensed material. For the avoidance of doubt, this paragraph does not form part of the public licenses. + +Creative Commons may be contacted at creativecommons.org. diff --git a/LICENSES/CC0-1.0.txt b/LICENSES/CC0-1.0.txt new file mode 100644 index 00000000..0e259d42 --- /dev/null +++ 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 new file mode 100644 index 00000000..d817195d --- /dev/null +++ b/LICENSES/MIT.txt @@ -0,0 +1,18 @@ +MIT License + +Copyright (c) + +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 index 0925f64a..3b63acd0 100644 --- a/Makefile +++ b/Makefile @@ -1,4 +1,8 @@ -.PHONY: help test docs clean distclean devrepl codestyle servedocs check-changelog changelog +# SPDX-FileCopyrightText: © 2021 Michael Goerz +# +# SPDX-License-Identifier: MIT OR CC0-1.0 + +.PHONY: help test docs clean distclean devrepl codestyle servedocs check-changelog changelog reuse .DEFAULT_GOAL := help JULIA ?= julia @@ -87,5 +91,17 @@ changelog: ## Validate CHANGELOG.md and add any missing issue/PR link targets $(JULIA) test/check_changelog.jl --fix +reuse: ## Check REUSE compliance (SPDX copyright and licensing information) + @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 "Error: 'reuse' is not installed (see https://reuse.software)"; 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 index dabdda95..c73a7774 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,9 @@ + + # QuantumControl.jl [![Version](https://juliahub.com/docs/General/QuantumControl/stable/version.svg)](https://juliahub.com/ui/Packages/General/QuantumControl) @@ -5,6 +11,7 @@ [![Dev](https://img.shields.io/badge/docs-dev-blue.svg)](https://juliaquantumcontrol.github.io/QuantumControl.jl/dev) [![Build Status](https://github.com/JuliaQuantumControl/QuantumControl.jl/workflows/CI/badge.svg)](https://github.com/JuliaQuantumControl/QuantumControl.jl/actions) [![Coverage](https://codecov.io/gh/JuliaQuantumControl/QuantumControl.jl/branch/master/graph/badge.svg)](https://codecov.io/gh/JuliaQuantumControl/QuantumControl.jl) +[![REUSE status](https://github.com/JuliaQuantumControl/QuantumControl.jl/actions/workflows/REUSE.yml/badge.svg)](https://github.com/JuliaQuantumControl/QuantumControl.jl/actions/workflows/REUSE.yml) A Julia Framework for Quantum Dynamics and Control. @@ -42,6 +49,11 @@ pkg> add GRAPE See the [list of packages][packages] of the [JuliaQuantumControl][] organization. +## License + +This package is licensed under the [MIT License](LICENSE). It follows the [REUSE specification](https://reuse.software/) for copyright and licensing information: every file carries its copyright and license via SPDX notices (in the file, in an adjacent `.license` file, or in `REUSE.toml`). The source code is licensed under MIT; prose and documentation are additionally available under [CC-BY-4.0](LICENSES/CC-BY-4.0.txt), and configuration and other trivial files under [CC0-1.0](LICENSES/CC0-1.0.txt). The full license texts are in the [`LICENSES/`](LICENSES) directory. + + [JuliaQuantumControl]: https://github.com/JuliaQuantumControl [QuantumControl]: https://github.com/JuliaQuantumControl/QuantumControl.jl [QuantumPropagators]: https://github.com/JuliaQuantumControl/QuantumPropagators.jl diff --git a/REUSE.toml b/REUSE.toml new file mode 100644 index 00000000..4c0b93c7 --- /dev/null +++ b/REUSE.toml @@ -0,0 +1,15 @@ +# SPDX-FileCopyrightText: © 2021 Michael Goerz +# +# SPDX-License-Identifier: MIT OR CC0-1.0 + +version = 1 + +[[annotations]] +path = [ + "**/Project.toml", + "**/Manifest.toml", + "docs/src/inventories/*.toml", + "docs/src/refs.bib", +] +SPDX-FileCopyrightText = "© 2021 Michael Goerz " +SPDX-License-Identifier = "MIT OR CC0-1.0" diff --git a/devrepl.jl b/devrepl.jl index 6f6eee44..dbeffd07 100644 --- a/devrepl.jl +++ b/devrepl.jl @@ -1,3 +1,7 @@ +# SPDX-FileCopyrightText: © 2021 Michael Goerz +# +# SPDX-License-Identifier: MIT OR CC0-1.0 + # Source this script as e.g. # # include("PATH/TO/devrepl.jl") diff --git a/docs/generate_api.jl b/docs/generate_api.jl index 9e8dbb6c..71d5a423 100644 --- a/docs/generate_api.jl +++ b/docs/generate_api.jl @@ -1,3 +1,7 @@ +# SPDX-FileCopyrightText: © 2021 Michael Goerz +# +# SPDX-License-Identifier: MIT OR CC0-1.0 + #! format: off import QuantumControl import Documenter diff --git a/docs/make.jl b/docs/make.jl index bea5baf2..5b9a83a6 100644 --- a/docs/make.jl +++ b/docs/make.jl @@ -1,3 +1,7 @@ +# SPDX-FileCopyrightText: © 2021 Michael Goerz +# +# SPDX-License-Identifier: MIT OR CC0-1.0 + using Pkg if Base.VERSION < v"1.11" Pkg.develop(path = joinpath(@__DIR__, "..")) diff --git a/docs/src/api/.gitignore b/docs/src/api/.gitignore index dd449725..d3220b8f 100644 --- a/docs/src/api/.gitignore +++ b/docs/src/api/.gitignore @@ -1 +1,5 @@ +# SPDX-FileCopyrightText: © 2021 Michael Goerz +# +# SPDX-License-Identifier: MIT OR CC0-1.0 + *.md diff --git a/docs/src/assets/Makefile b/docs/src/assets/Makefile index 60077a9f..f6048d1a 100644 --- a/docs/src/assets/Makefile +++ b/docs/src/assets/Makefile @@ -1,3 +1,7 @@ +# SPDX-FileCopyrightText: © 2021 Michael Goerz +# +# SPDX-License-Identifier: MIT OR CC0-1.0 + .PHONY: clean controlhams.svg: diff --git a/docs/src/assets/citations.css b/docs/src/assets/citations.css index 76140e87..aad6e0f0 100644 --- a/docs/src/assets/citations.css +++ b/docs/src/assets/citations.css @@ -1,3 +1,6 @@ +/* SPDX-FileCopyrightText: © 2021 Michael Goerz */ +/* SPDX-License-Identifier: MIT OR CC0-1.0 */ + .citation dl { display: grid; grid-template-columns: max-content auto; } diff --git a/docs/src/assets/controlhams.svg b/docs/src/assets/controlhams.svg index 4dab010d..ef606207 100644 --- a/docs/src/assets/controlhams.svg +++ b/docs/src/assets/controlhams.svg @@ -1,4 +1,9 @@ + diff --git a/docs/src/assets/controlhams.tex b/docs/src/assets/controlhams.tex index b7da0928..c1c9e654 100644 --- a/docs/src/assets/controlhams.tex +++ b/docs/src/assets/controlhams.tex @@ -1,3 +1,7 @@ +% SPDX-FileCopyrightText: © 2021 Michael Goerz +% +% SPDX-License-Identifier: MIT OR CC-BY-4.0 + \documentclass[preview,12pt]{standalone} \usepackage{amsmath} \usepackage{braket} diff --git a/docs/src/assets/custom.css b/docs/src/assets/custom.css index 6c5f4cfc..ce95013a 100644 --- a/docs/src/assets/custom.css +++ b/docs/src/assets/custom.css @@ -1,3 +1,6 @@ +/* SPDX-FileCopyrightText: © 2021 Michael Goerz */ +/* SPDX-License-Identifier: MIT OR CC0-1.0 */ + h5 {font-size: 1em!important; display:inline; line-height: 1.5!important;} h5::after {content: "—   ";} h5 + p {display:inline;} diff --git a/docs/src/assets/topbar/org_logo.afdesign.license b/docs/src/assets/topbar/org_logo.afdesign.license new file mode 100644 index 00000000..535c8f5c --- /dev/null +++ b/docs/src/assets/topbar/org_logo.afdesign.license @@ -0,0 +1,3 @@ +SPDX-FileCopyrightText: © 2021 Michael Goerz + +SPDX-License-Identifier: MIT OR CC-BY-4.0 diff --git a/docs/src/assets/topbar/org_logo.svg b/docs/src/assets/topbar/org_logo.svg index bfb11722..072e11e7 100644 --- a/docs/src/assets/topbar/org_logo.svg +++ b/docs/src/assets/topbar/org_logo.svg @@ -1,4 +1,9 @@ + diff --git a/docs/src/assets/topbar/topbar.css b/docs/src/assets/topbar/topbar.css index 8825ebcf..9c69657b 100644 --- a/docs/src/assets/topbar/topbar.css +++ b/docs/src/assets/topbar/topbar.css @@ -1,3 +1,6 @@ +/* SPDX-FileCopyrightText: © 2021 Michael Goerz */ +/* SPDX-License-Identifier: MIT OR CC0-1.0 */ + html { --navbar-height: 55px; scroll-padding-top: calc(var(--navbar-height) + 1rem); diff --git a/docs/src/assets/topbar/topbar.js b/docs/src/assets/topbar/topbar.js index 89e4e626..723a8a76 100644 --- a/docs/src/assets/topbar/topbar.js +++ b/docs/src/assets/topbar/topbar.js @@ -1,3 +1,7 @@ +// SPDX-FileCopyrightText: © 2021 Michael Goerz +// +// SPDX-License-Identifier: MIT OR CC0-1.0 + document.addEventListener("DOMContentLoaded", function() { var metaTag = document.querySelector('meta[name="description"]'); var name = ""; diff --git a/docs/src/examples/.gitignore b/docs/src/examples/.gitignore index 3b28521e..0a20d074 100644 --- a/docs/src/examples/.gitignore +++ b/docs/src/examples/.gitignore @@ -1,3 +1,7 @@ +# SPDX-FileCopyrightText: © 2021 Michael Goerz +# +# SPDX-License-Identifier: MIT OR CC0-1.0 + *.md *.jl *.ipynb diff --git a/docs/src/examples/index.md b/docs/src/examples/index.md index ff68e0a9..0c9a971f 100644 --- a/docs/src/examples/index.md +++ b/docs/src/examples/index.md @@ -1,3 +1,8 @@ +```@meta +# SPDX-FileCopyrightText: © 2021 Michael Goerz +# SPDX-License-Identifier: MIT OR CC-BY-4.0 +``` + # [Examples](@id examples-list) ## Krotov-specific examples diff --git a/docs/src/glossary.md b/docs/src/glossary.md index aea07637..f5f80a5f 100644 --- a/docs/src/glossary.md +++ b/docs/src/glossary.md @@ -1,3 +1,8 @@ +```@meta +# SPDX-FileCopyrightText: © 2021 Michael Goerz +# SPDX-License-Identifier: MIT OR CC-BY-4.0 +``` + # Glossary In the context of the JuliaQuantumControl ecosystem, we apply the following nomenclature. diff --git a/docs/src/howto.md b/docs/src/howto.md index c61f6c16..eabd12bc 100644 --- a/docs/src/howto.md +++ b/docs/src/howto.md @@ -1,3 +1,8 @@ +```@meta +# SPDX-FileCopyrightText: © 2021 Michael Goerz +# SPDX-License-Identifier: MIT OR CC-BY-4.0 +``` + # [How-to Guides](@id howto) **Contents** diff --git a/docs/src/index.md b/docs/src/index.md index ea22932e..9ce9c7bf 100644 --- a/docs/src/index.md +++ b/docs/src/index.md @@ -1,3 +1,8 @@ +```@meta +# SPDX-FileCopyrightText: © 2021 Michael Goerz +# SPDX-License-Identifier: MIT OR CC-BY-4.0 +``` + # QuantumControl.jl ```@eval diff --git a/docs/src/methods.md b/docs/src/methods.md index e54e3c91..05f77d16 100644 --- a/docs/src/methods.md +++ b/docs/src/methods.md @@ -1,3 +1,8 @@ +```@meta +# SPDX-FileCopyrightText: © 2021 Michael Goerz +# SPDX-License-Identifier: MIT OR CC-BY-4.0 +``` + # Control Methods All optimizations in the `QuantumControl` package are done by calling `QuantumControl.optimize`, or preferably the high-level wrapper [`@optimize_or_load`](@ref). The actual control methods are implemented in separate packages. The module implementing a particular method should be passed to `optimize` as the `method` keyword argument. diff --git a/docs/src/overview.md b/docs/src/overview.md index ac2cc9d6..02376e20 100644 --- a/docs/src/overview.md +++ b/docs/src/overview.md @@ -1,3 +1,8 @@ +```@meta +# SPDX-FileCopyrightText: © 2021 Michael Goerz +# SPDX-License-Identifier: MIT OR CC-BY-4.0 +``` + # Overview This page describes the API of the `QuantumControl` package by outlining the general procedure for defining and solving quantum control problems. See the [API](@ref) for a detailed reference. diff --git a/docs/src/references.md b/docs/src/references.md index 78f29bc4..9ab1bf85 100644 --- a/docs/src/references.md +++ b/docs/src/references.md @@ -1,3 +1,8 @@ +```@meta +# SPDX-FileCopyrightText: © 2021 Michael Goerz +# SPDX-License-Identifier: MIT OR CC-BY-4.0 +``` + # References ```@bibliography diff --git a/ext/QuantumControlChainRulesCoreExt.jl b/ext/QuantumControlChainRulesCoreExt.jl index 091fe880..8388d158 100644 --- a/ext/QuantumControlChainRulesCoreExt.jl +++ b/ext/QuantumControlChainRulesCoreExt.jl @@ -1,3 +1,7 @@ +# SPDX-FileCopyrightText: © 2021 Michael Goerz +# +# SPDX-License-Identifier: MIT + module QuantumControlChainRulesCoreExt using ChainRulesCore: ChainRulesCore, NoTangent diff --git a/ext/QuantumControlFiniteDifferencesExt.jl b/ext/QuantumControlFiniteDifferencesExt.jl index 026f00bb..6ef5b6c4 100644 --- a/ext/QuantumControlFiniteDifferencesExt.jl +++ b/ext/QuantumControlFiniteDifferencesExt.jl @@ -1,3 +1,7 @@ +# SPDX-FileCopyrightText: © 2021 Michael Goerz +# +# SPDX-License-Identifier: MIT + module QuantumControlFiniteDifferencesExt using LinearAlgebra diff --git a/ext/QuantumControlZygoteExt.jl b/ext/QuantumControlZygoteExt.jl index bf45ebd1..d2127611 100644 --- a/ext/QuantumControlZygoteExt.jl +++ b/ext/QuantumControlZygoteExt.jl @@ -1,3 +1,7 @@ +# SPDX-FileCopyrightText: © 2021 Michael Goerz +# +# SPDX-License-Identifier: MIT + module QuantumControlZygoteExt using LinearAlgebra diff --git a/src/QuantumControl.jl b/src/QuantumControl.jl index 05515a05..5455f7d2 100644 --- a/src/QuantumControl.jl +++ b/src/QuantumControl.jl @@ -1,3 +1,7 @@ +# SPDX-FileCopyrightText: © 2021 Michael Goerz +# +# SPDX-License-Identifier: MIT + #! format: off module QuantumControl include("reexport.jl") diff --git a/src/atexit.jl b/src/atexit.jl index 06ebb60d..2e2ad537 100644 --- a/src/atexit.jl +++ b/src/atexit.jl @@ -1,3 +1,7 @@ +# SPDX-FileCopyrightText: © 2021 Michael Goerz +# +# SPDX-License-Identifier: MIT + using JLD2: jldopen """ diff --git a/src/callbacks.jl b/src/callbacks.jl index e409aedc..4ee45bc2 100644 --- a/src/callbacks.jl +++ b/src/callbacks.jl @@ -1,3 +1,7 @@ +# SPDX-FileCopyrightText: © 2021 Michael Goerz +# +# SPDX-License-Identifier: MIT + """ Construct a method-specific automatic callback for printing iter information. diff --git a/src/conditionalthreads.jl b/src/conditionalthreads.jl index 2bc90e64..2a929c97 100644 --- a/src/conditionalthreads.jl +++ b/src/conditionalthreads.jl @@ -1,3 +1,7 @@ +# SPDX-FileCopyrightText: © 2021 Michael Goerz +# +# SPDX-License-Identifier: MIT + using Base.Threads using Base.Threads: threadid, threading_run @static if Base.VERSION ≥ v"1.9-rc1" diff --git a/src/control_problem.jl b/src/control_problem.jl index 4cdc586c..9eaf05f0 100644 --- a/src/control_problem.jl +++ b/src/control_problem.jl @@ -1,3 +1,7 @@ +# SPDX-FileCopyrightText: © 2021 Michael Goerz +# +# SPDX-License-Identifier: MIT + import QuantumPropagators.Controls: get_controls, get_parameters, substitute diff --git a/src/deprecate.jl b/src/deprecate.jl index 6c3f242c..77c5f3b9 100644 --- a/src/deprecate.jl +++ b/src/deprecate.jl @@ -1,3 +1,7 @@ +# SPDX-FileCopyrightText: © 2021 Michael Goerz +# +# SPDX-License-Identifier: MIT + # COV_EXCL_START OBJECTIVE_MSG = """ `Objective` has been renamed to `Trajectory`. This also affects related diff --git a/src/derivs.jl b/src/derivs.jl index 4cb24816..5b17742f 100644 --- a/src/derivs.jl +++ b/src/derivs.jl @@ -1,3 +1,7 @@ +# SPDX-FileCopyrightText: © 2021 Michael Goerz +# +# SPDX-License-Identifier: MIT + using QuantumPropagators.Generators: Generator, Operator, _make_generator, evaluate using QuantumPropagators.Amplitudes: LockedAmplitude, ShapedAmplitude, GuidedAmplitude diff --git a/src/functionals.jl b/src/functionals.jl index 78b18a6f..0168a631 100644 --- a/src/functionals.jl +++ b/src/functionals.jl @@ -1,3 +1,7 @@ +# SPDX-FileCopyrightText: © 2021 Michael Goerz +# +# SPDX-License-Identifier: MIT + module Functionals export J_T_ss, J_T_sm, J_T_re diff --git a/src/interfaces/amplitude.jl b/src/interfaces/amplitude.jl index f7d30d1a..075062cb 100644 --- a/src/interfaces/amplitude.jl +++ b/src/interfaces/amplitude.jl @@ -1,3 +1,7 @@ +# SPDX-FileCopyrightText: © 2021 Michael Goerz +# +# SPDX-License-Identifier: MIT + using QuantumPropagators using QuantumPropagators.Controls: get_controls, evaluate using QuantumPropagators.Interfaces: catch_abbreviated_backtrace diff --git a/src/interfaces/generator.jl b/src/interfaces/generator.jl index d9407719..ff3db2b7 100644 --- a/src/interfaces/generator.jl +++ b/src/interfaces/generator.jl @@ -1,3 +1,7 @@ +# SPDX-FileCopyrightText: © 2021 Michael Goerz +# +# SPDX-License-Identifier: MIT + using QuantumPropagators using QuantumPropagators.Generators: Generator using QuantumPropagators.Controls: get_controls diff --git a/src/optimize.jl b/src/optimize.jl index 3648a7ce..9eceadca 100644 --- a/src/optimize.jl +++ b/src/optimize.jl @@ -1,3 +1,7 @@ +# SPDX-FileCopyrightText: © 2021 Michael Goerz +# +# SPDX-License-Identifier: MIT + using QuantumPropagators.Controls: substitute using QuantumPropagators.Interfaces: check_state diff --git a/src/print_versions.jl b/src/print_versions.jl index c406bba2..e27ea560 100644 --- a/src/print_versions.jl +++ b/src/print_versions.jl @@ -1,3 +1,7 @@ +# SPDX-FileCopyrightText: © 2021 Michael Goerz +# +# SPDX-License-Identifier: MIT + using Pkg using UUIDs diff --git a/src/propagate.jl b/src/propagate.jl index 9e75dc32..b58fe579 100644 --- a/src/propagate.jl +++ b/src/propagate.jl @@ -1,3 +1,7 @@ +# SPDX-FileCopyrightText: © 2021 Michael Goerz +# +# SPDX-License-Identifier: MIT + # Extension of QuantumPropagators.propagate for trajectories using Logging diff --git a/src/pulse_parameterizations.jl b/src/pulse_parameterizations.jl index 5b51e835..22e55f19 100644 --- a/src/pulse_parameterizations.jl +++ b/src/pulse_parameterizations.jl @@ -1,3 +1,7 @@ +# SPDX-FileCopyrightText: © 2021 Michael Goerz +# +# SPDX-License-Identifier: MIT + module PulseParameterizations export SquareParameterization, diff --git a/src/reexport.jl b/src/reexport.jl index faa373a5..5b8f172e 100644 --- a/src/reexport.jl +++ b/src/reexport.jl @@ -1,3 +1,7 @@ +# SPDX-FileCopyrightText: © 2021 Michael Goerz +# +# SPDX-License-Identifier: MIT + # I'm aware of Reexport.jl, but it doesn't work for QuantumControl.jl # # For one thing, `@reexport using QuantumPropagators` re-exports not just the diff --git a/src/result.jl b/src/result.jl index 3b8ab486..b50e188b 100644 --- a/src/result.jl +++ b/src/result.jl @@ -1,3 +1,7 @@ +# SPDX-FileCopyrightText: © 2021 Michael Goerz +# +# SPDX-License-Identifier: MIT + """ Abstract type for the result object returned by [`optimize`](@ref). Any optimization method implemented on top of `QuantumControl` should subtype diff --git a/src/set_default_ad_framework.jl b/src/set_default_ad_framework.jl index b8c31480..5a4f2252 100644 --- a/src/set_default_ad_framework.jl +++ b/src/set_default_ad_framework.jl @@ -1,3 +1,7 @@ +# SPDX-FileCopyrightText: © 2021 Michael Goerz +# +# SPDX-License-Identifier: MIT + using .Functionals: _set_default_ad_framework """Set the default provider for automatic differentiation. diff --git a/src/trajectories.jl b/src/trajectories.jl index 50001aa4..62effbba 100644 --- a/src/trajectories.jl +++ b/src/trajectories.jl @@ -1,3 +1,7 @@ +# SPDX-FileCopyrightText: © 2021 Michael Goerz +# +# SPDX-License-Identifier: MIT + import Base import QuantumPropagators using Printf diff --git a/src/workflows.jl b/src/workflows.jl index 4382f6b0..6c0b6cf8 100644 --- a/src/workflows.jl +++ b/src/workflows.jl @@ -1,3 +1,7 @@ +# SPDX-FileCopyrightText: © 2021 Michael Goerz +# +# SPDX-License-Identifier: MIT + module Workflows import ..optimize diff --git a/test/check_changelog.jl b/test/check_changelog.jl index c3e74b35..af13e541 100644 --- a/test/check_changelog.jl +++ b/test/check_changelog.jl @@ -1,3 +1,7 @@ +# SPDX-FileCopyrightText: © 2021 Michael Goerz +# +# SPDX-License-Identifier: MIT + # Validate (and optionally fix) the reference-style links in CHANGELOG.md. # # The default check mode is purely textual: it makes no network calls and diff --git a/test/clean.jl b/test/clean.jl index ae69c115..60065c34 100644 --- a/test/clean.jl +++ b/test/clean.jl @@ -1,3 +1,7 @@ +# SPDX-FileCopyrightText: © 2021 Michael Goerz +# +# SPDX-License-Identifier: MIT + """ clean([distclean=false]) diff --git a/test/init.jl b/test/init.jl index 3d96fc64..cbae95c2 100644 --- a/test/init.jl +++ b/test/init.jl @@ -1,3 +1,7 @@ +# SPDX-FileCopyrightText: © 2021 Michael Goerz +# +# SPDX-License-Identifier: MIT + # init file for "make devrepl" using Revise using Plots diff --git a/test/runtests.jl b/test/runtests.jl index dd945115..07d2387f 100644 --- a/test/runtests.jl +++ b/test/runtests.jl @@ -1,3 +1,7 @@ +# SPDX-FileCopyrightText: © 2021 Michael Goerz +# +# SPDX-License-Identifier: MIT + using QuantumControl using QuantumPropagators using IOCapture diff --git a/test/test_adjoint_trajectory.jl b/test/test_adjoint_trajectory.jl index b08eb045..075a38c0 100644 --- a/test/test_adjoint_trajectory.jl +++ b/test/test_adjoint_trajectory.jl @@ -1,3 +1,7 @@ +# SPDX-FileCopyrightText: © 2021 Michael Goerz +# +# SPDX-License-Identifier: MIT + using Test using LinearAlgebra using QuantumControl: Trajectory diff --git a/test/test_atexit.jl b/test/test_atexit.jl index 7a2ff105..6bdf6662 100644 --- a/test/test_atexit.jl +++ b/test/test_atexit.jl @@ -1,3 +1,7 @@ +# SPDX-FileCopyrightText: © 2021 Michael Goerz +# +# SPDX-License-Identifier: MIT + using Test using QuantumControl: set_atexit_save_optimization using QuantumControl: load_optimization diff --git a/test/test_callbacks.jl b/test/test_callbacks.jl index 7e5e5ddc..65c2f252 100644 --- a/test/test_callbacks.jl +++ b/test/test_callbacks.jl @@ -1,3 +1,7 @@ +# SPDX-FileCopyrightText: © 2021 Michael Goerz +# +# SPDX-License-Identifier: MIT + using Test using QuantumControl: chain_callbacks diff --git a/test/test_control_problems.jl b/test/test_control_problems.jl index 7b0962e2..e003ef93 100644 --- a/test/test_control_problems.jl +++ b/test/test_control_problems.jl @@ -1,3 +1,7 @@ +# SPDX-FileCopyrightText: © 2021 Michael Goerz +# +# SPDX-License-Identifier: MIT + using Test using QuantumPropagators: Cheby using QuantumPropagators.Controls: substitute, get_controls diff --git a/test/test_derivs.jl b/test/test_derivs.jl index 5f5419f9..f9c5e70d 100644 --- a/test/test_derivs.jl +++ b/test/test_derivs.jl @@ -1,3 +1,7 @@ +# SPDX-FileCopyrightText: © 2021 Michael Goerz +# +# SPDX-License-Identifier: MIT + using Test using LinearAlgebra using QuantumControl.Controls: get_control_deriv, get_control_derivs diff --git a/test/test_dummy_optimization.jl b/test/test_dummy_optimization.jl index 3a816e6c..55a63a90 100644 --- a/test/test_dummy_optimization.jl +++ b/test/test_dummy_optimization.jl @@ -1,3 +1,7 @@ +# SPDX-FileCopyrightText: © 2021 Michael Goerz +# +# SPDX-License-Identifier: MIT + using Test using QuantumControl: optimize diff --git a/test/test_functionals.jl b/test/test_functionals.jl index 241c8e01..6efc32de 100644 --- a/test/test_functionals.jl +++ b/test/test_functionals.jl @@ -1,3 +1,7 @@ +# SPDX-FileCopyrightText: © 2021 Michael Goerz +# +# SPDX-License-Identifier: MIT + using Test using LinearAlgebra using QuantumControl: QuantumControl, Trajectory diff --git a/test/test_invalid_interfaces.jl b/test/test_invalid_interfaces.jl index 8bdd35ae..f7cf2367 100644 --- a/test/test_invalid_interfaces.jl +++ b/test/test_invalid_interfaces.jl @@ -1,3 +1,7 @@ +# SPDX-FileCopyrightText: © 2021 Michael Goerz +# +# SPDX-License-Identifier: MIT + using Test using Logging: with_logger using LinearAlgebra: I diff --git a/test/test_optimize_kwargs.jl b/test/test_optimize_kwargs.jl index 067a2a4a..e0903cf5 100644 --- a/test/test_optimize_kwargs.jl +++ b/test/test_optimize_kwargs.jl @@ -1,3 +1,7 @@ +# SPDX-FileCopyrightText: © 2021 Michael Goerz +# +# SPDX-License-Identifier: MIT + using Test import QuantumControl using QuantumControl: ControlProblem, Trajectory diff --git a/test/test_optimize_or_load.jl b/test/test_optimize_or_load.jl index e28fbccb..4ab1a43e 100644 --- a/test/test_optimize_or_load.jl +++ b/test/test_optimize_or_load.jl @@ -1,3 +1,7 @@ +# SPDX-FileCopyrightText: © 2021 Michael Goerz +# +# SPDX-License-Identifier: MIT + using Test using IOCapture diff --git a/test/test_parameterization.jl b/test/test_parameterization.jl index a22c3cab..9a08d393 100644 --- a/test/test_parameterization.jl +++ b/test/test_parameterization.jl @@ -1,3 +1,7 @@ +# SPDX-FileCopyrightText: © 2021 Michael Goerz +# +# SPDX-License-Identifier: MIT + using ComponentArrays using RecursiveArrayTools # to ensure extension is loaded using UnPack: @unpack diff --git a/test/test_propagation.jl b/test/test_propagation.jl index d445abcb..f3690692 100644 --- a/test/test_propagation.jl +++ b/test/test_propagation.jl @@ -1,3 +1,7 @@ +# SPDX-FileCopyrightText: © 2021 Michael Goerz +# +# SPDX-License-Identifier: MIT + using Test using QuantumPropagators: ExpProp using QuantumPropagators.Shapes: flattop diff --git a/test/test_pulse_parameterizations.jl b/test/test_pulse_parameterizations.jl index 34a1f200..5c7d8975 100644 --- a/test/test_pulse_parameterizations.jl +++ b/test/test_pulse_parameterizations.jl @@ -1,3 +1,7 @@ +# SPDX-FileCopyrightText: © 2021 Michael Goerz +# +# SPDX-License-Identifier: MIT + using Test using LinearAlgebra using QuantumControl: QuantumControl, ControlProblem, hamiltonian, optimize, Trajectory diff --git a/test/test_result_conversion.jl b/test/test_result_conversion.jl index 1df65e74..0183852f 100644 --- a/test/test_result_conversion.jl +++ b/test/test_result_conversion.jl @@ -1,3 +1,7 @@ +# SPDX-FileCopyrightText: © 2021 Michael Goerz +# +# SPDX-License-Identifier: MIT + using Test using IOCapture diff --git a/test/test_run_or_load.jl b/test/test_run_or_load.jl index 48b67e3e..f50e0057 100644 --- a/test/test_run_or_load.jl +++ b/test/test_run_or_load.jl @@ -1,3 +1,7 @@ +# SPDX-FileCopyrightText: © 2021 Michael Goerz +# +# SPDX-License-Identifier: MIT + using Test using DataFrames using CSV diff --git a/test/test_traj_zygote.jl b/test/test_traj_zygote.jl index 72dbe784..42fafb98 100644 --- a/test/test_traj_zygote.jl +++ b/test/test_traj_zygote.jl @@ -1,3 +1,7 @@ +# SPDX-FileCopyrightText: © 2021 Michael Goerz +# +# SPDX-License-Identifier: MIT + using Test using StableRNGs using IOCapture diff --git a/test/test_trajectories.jl b/test/test_trajectories.jl index cc743582..6e12f366 100644 --- a/test/test_trajectories.jl +++ b/test/test_trajectories.jl @@ -1,3 +1,7 @@ +# SPDX-FileCopyrightText: © 2021 Michael Goerz +# +# SPDX-License-Identifier: MIT + using Test using QuantumControl: Trajectory, propagate_trajectory