Repository navigation
docs: name every fixture source with its licence - #39
Merged
Merged
Conversation
…xture README NOTICE gains a section that lists each test-fixture source with its licence: the CIFs (from the mac4DSTEM tests or written here; none is a copy of a COD, AMCSD or ICSD entry; WS2 cites Schutte et al. 1987, the structure COD 5910003 also holds under CC0), the oracle outputs of pymatgen (MIT), spglib (BSD-3-Clause), orix 0.15.0 (GPL-3.0-or-later), py4DSTEM f050d207 (GPL-3.0), NumPy and SciPy (BSD-3-Clause), and the Materials Project records (CC BY 4.0). No fixture is taken from the test data of those packages. The pymatgen copyright line now quotes its LICENSE file, and the orix entry now names its own copyright line and GPL-3.0-or-later, as its sources state. Tests/Fixtures/README.md gets the same list as a table, and the README licence paragraph points to it. Done: the fixture-licence part of #17. Next: the Swift Package Index badge, which needs the package listed first. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
The licence paragraph said every fixture is generated by the kit and the pinned reference under GPL-3.0-only. The table in the same file says the CIFs come from the mac4DSTEM 7448401b tests (GPL-3.0) or were written for this kit. The paragraph now says the same: pin JSON files are generated, 16 CIFs are from the mac4DSTEM tests, 10 were written for this kit, 3 Materials Project records are third party. Each CIF row now names its source in the Note column, read from its first comment line. Done: the README, the table and NOTICE name the same sources and licences. Next: review and merge of the PR. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Requested by Paul · project thread
Part of #17
#28 did NOTICE provenance, the Materials Project and orix credits, the licence id, the README, CITATION and the CHANGELOG form. This PR finishes the fixture licences: NOTICE and the fixture README now name every third-party fixture source with its licence, each checked at the source.
What changed
How the licences were checked
LICENSEin materialsproject/pymatgen (MIT).orix/__init__.pyheader and the pyproject classifier (GPL-3.0-or-later).LICENSE.txtandsetup.pyat f050d207 (GPLv3).Left open on #17
Test evidence
Docs only, no code change. The CI gate staying green is the test.
🤖 Generated with Claude Code