Skip to content

Restore CARLA MIT license notices and fix package metadata - #3

Open
hilmibukhori5 wants to merge 1 commit into
tango-model-codes-adaptorfrom
licensing-compliance
Open

Restore CARLA MIT license notices and fix package metadata#3
hilmibukhori5 wants to merge 1 commit into
tango-model-codes-adaptorfrom
licensing-compliance

Conversation

@hilmibukhori5

Copy link
Copy Markdown

Summary

Addresses the licensing review: this repository is a fork of CARLA (MIT-licensed), with MISOB's own code added on top. The MIT license and copyright notice for the CARLA-derived code had been dropped when this repository's root LICENSE was replaced with Apache 2.0. Apache 2.0 and MIT are compatible, but MIT requires the original license/copyright to be preserved — this PR restores it and cleans up the package metadata, which was still describing CARLA rather than MISOB.

What changed

  • LICENSES/MIT-CARLA.txt and carla/LICENSE: the complete, unmodified CARLA MIT license text and Tobias Richter copyright notice, recovered from this repository's own first commit (before it was overwritten by the current Apache LICENSE). The root LICENSE (Apache 2.0) is unchanged and covers MISOB's own code; it does not apply to carla/.
  • THIRD_PARTY_NOTICES.md: identifies the CARLA upstream repository, the vendored version (0.0.5, matching CARLA's last published PyPI release), and — generated by diffing the vendored carla/ directory against a fresh clone of upstream CARLA — the concrete list of files that differ from upstream, plus the components that were disabled (renamed .old/.deprecated) rather than removed.
  • setup.py: no longer describes CARLA's own metadata (package name carla-recourse, CARLA's GitHub URL, CARLA's authors, MIT license). Renamed the distribution to misob, pointed url/author at MISOB's own repository and the paper's authors, and set license to Apache-2.0. Also decoupled MISOB's package version from carla/_version.py (part of the vendored MIT-licensed code, and it identifies CARLA's version, not MISOB's) — introduced an explicit MISOB version instead. py_modules/packages/install_requires are unchanged.
  • setup.cfg / MANIFEST.in: updated so the license files are actually bundled into the built package. setup.cfg previously referenced a LICENSE.txt file that never existed in this repository, so no license was ever being packaged at all.

Known follow-up

This renames the pip distribution from carla-recourse to misob. Any requirements.txt that pins carla-recourse @ git+https://github.com/wearepal/MISOB.git@... (e.g. the TANGO Library GitLab project) will need updating back to misob @ git+... once this is merged, or the install will fail with the same "inconsistent name" error this project hit before — just reversed. This needs to be sequenced: merge this first, then update the downstream requirements.txt.

Test plan

  • Fresh venv install succeeds (misob-0.1.0), and import run_misob still works.
  • A full train / log / reload / predict pass against the TANGO adaptor (train_social_burden() and the resulting model artifacts) still succeeds after these changes.

Per Daniele's licensing review: this repository is a fork of CARLA
(MIT-licensed) with MISOB's own code (run_misob.py, dataloader.py)
added on top, but the fork had silently replaced CARLA's MIT license
with an Apache 2.0 root LICENSE, without preserving MIT's required
attribution for the CARLA-derived code under carla/. Apache 2.0 and
MIT are compatible, but MIT requires the original license/copyright
notice to be kept.

- Added LICENSES/MIT-CARLA.txt and carla/LICENSE: the complete,
  unmodified CARLA MIT license text and Tobias Richter copyright
  notice, recovered from this repository's own first commit (before
  it was replaced by the current Apache LICENSE). The root LICENSE
  (Apache 2.0) stays as-is and covers MISOB's own code; it does not
  apply to carla/.
- Added THIRD_PARTY_NOTICES.md identifying the CARLA upstream repo,
  the version/baseline it was vendored from, and -- generated by
  diffing the vendored carla/ directory against a fresh clone of
  upstream CARLA (main, commit 24db00a) -- the concrete list of files
  that differ from upstream, plus the components that were disabled
  (renamed .old/.deprecated) rather than removed.
- setup.py no longer describes CARLA's own metadata (name
  "carla-recourse", CARLA's GitHub URL, CARLA's authors, MIT license):
  renamed the distribution to "misob", pointed url/author at MISOB's
  own repo and paper authors, and set license to Apache-2.0. Also
  decoupled MISOB's own package version from carla/_version.py (which
  is part of the vendored MIT-licensed code and identifies CARLA's
  version, not MISOB's) -- introduced an explicit MISOB version
  instead. py_modules/packages/install_requires are unchanged.
- setup.cfg / MANIFEST.in updated so all four license-related files
  (LICENSE, LICENSES/MIT-CARLA.txt, carla/LICENSE,
  THIRD_PARTY_NOTICES.md) are actually bundled into the built package
  -- setup.cfg previously referenced a LICENSE.txt file that never
  existed in this repository.

Known follow-up: this renames the pip distribution from
"carla-recourse" to "misob". Any requirements.txt entry that pins
`carla-recourse @ git+https://github.com/wearepal/MISOB.git@...`
(e.g. the TANGO Library GitLab project's requirements.txt) will need
updating back to `misob @ git+...` once this is merged, or the
install will fail with the same "inconsistent name" error this project
hit before.

Verified: fresh venv install succeeds (misob-0.1.0), `import run_misob`
still works, and a full train/log/reload/predict pass against the
research repo's train_social_burden() still succeeds afterward.
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.

1 participant