Skip to content

chore: prepare the repository for a public release - #18

Merged
icyspirit merged 1 commit into
mainfrom
chore/prepare-public-release
Oct 14, 2026
Merged

icyspirit merged 1 commit into
mainfrom
chore/prepare-public-release

Conversation

@icyspirit

Copy link
Copy Markdown
Owner

Summary

The MIT LICENSE is now on main. This prepares the rest of the repository for being made public:

  • License in the package metadata: pyproject.toml declares license = "MIT" as an SPDX expression (PEP 639), with license-files = ["LICENSE"]. A built wheel carries License-Expression: MIT and the license file. This form needs setuptools 77, so the build requirement moves from 64 to 77.
  • README links:
    • IMAS now points to its public GitHub organization (github.com/iterorganization). Before, it pointed to imas.iter.org, which needs an ITER account.
    • "IDS" links to the public Data Dictionary documentation (imas-data-dictionary.readthedocs.io).
    • A License section closes the README.
  • No mention of a private repository: comments, docstrings and template headers still name the codes whose results a template shows (NuBDeC, SONAMU, FreeGS, autofrd). They no longer name the private repository that runs those codes. The template aliases (-T nubdec, -T sonamu, -T freegs, -T autofrd) are unchanged.
  • Screenshot: docs/template-device.png is taken again. Its Sources field now shows A=demo_A.nc, B=demo_B.nc, as the other screenshots do, instead of a temporary path. Apart from that field and the load time in the status bar, the image is pixel for pixel the same.

Notes

  • Checked before going public:
    • The whole history (58 commits) has no passwords, tokens, keys, internal paths, hosts or IP addresses.
    • Commit authors use noreply addresses only.
    • No file was ever deleted, and the largest blob is a 350 KB screenshot.
    • The tests use synthetic data and the ITER training data bundled with imas-python.
  • Dependencies are compatible with MIT:
    • imas-python and PySide6 are LGPL-3.0, and idscope only imports them.
    • The Data Dictionary package is LGPL-3.0+ / CC-BY-ND-4.0. It is installed, not included.
    • pyqtgraph, PyYAML and netCDF4 are MIT; numpy and contourpy are BSD.
    • PyQt5 (GPL-3.0) is optional and never bundled.
  • What this PR does not change: two older commit messages and the descriptions of PRs 8, 9 and 15 still name the private repository. Changing the commit messages would mean rewriting history, so they are left as they are.

Test plan

  • QT_QPA_PLATFORM=offscreen pytest: 242 passed in the dev environment, a clean PySide6 6.11 environment and a PyQt5 5.15 environment. The clean installs were rebuilt with the new build requirement.
  • A wheel built from the branch has License-Expression: MIT and licenses/LICENSE.
  • git grep -i tbd finds nothing.
  • The new screenshot differs from the old one only in the Sources field and the status bar's load time.
  • pyflakes src tests reports nothing.

🤖 Generated with Claude Code

https://claude.ai/code/session_018aVekYzCRLPE71Mm6UH8Zp


Generated by Claude Code

- pyproject.toml declares the MIT license, as an SPDX expression with the
  LICENSE file. Building it needs setuptools 77.
- The README links IMAS to its public GitHub organization instead of
  imas.iter.org, which needs an ITER account, and IDS to the Data
  Dictionary documentation. It ends with a License section.
- Comments, docstrings and template headers name the codes whose results
  a template shows (NuBDeC, SONAMU, FreeGS, autofrd), without the private
  repository that runs them.
- docs/template-device.png is taken again with the sources as the other
  screenshots show them (A=demo_A.nc, B=demo_B.nc), not a temporary path.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_018aVekYzCRLPE71Mm6UH8Zp
@icyspirit
icyspirit merged commit d72e024 into main Oct 14, 2026
2 checks passed
@icyspirit
icyspirit deleted the chore/prepare-public-release branch October 14, 2026 14:35
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants