Skip to content

Clone and run: run.py, Apache-2.0 + NOTICE, animation and README - #3

Merged
EngFlavioMartins merged 2 commits into
mainfrom
clone-and-run
Oct 22, 2026
Merged

EngFlavioMartins merged 2 commits into
mainfrom
clone-and-run

Conversation

@EngFlavioMartins

Copy link
Copy Markdown
Owner

What changes

  • Clone and run: python run.py sets up a private .venv on its first run (only Python 3.10+ needed) and runs the example; environment.yml for conda.
  • Licence: Apache-2.0 with a NOTICE file that carries the citation (section 4(d) requires redistributions to keep it). CITATION.cff updated.
  • README: animation at the top (docs/assets/animation.webp, made by scripts/render/make_animation.py from this repository's code), a short "Run it" section, the still figure, a copyable BibTeX entry and the licence in plain words.

Checked locally: python run.py from a bare Python, twice (first run sets up, second starts at once).

🤖 Generated with Claude Code

EngFlavioMartins and others added 2 commits October 22, 2026 11:21
… NOTICE

run.py runs the example with any Python 3.10+: it uses the current
environment if it has the packages, and otherwise builds a private .venv
once. environment.yml gives the same set-up with conda. The licence is
now Apache-2.0; its NOTICE file, which redistributions must keep,
carries the citation.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Adds docs/assets/animation.webp at the top of the README, made by
scripts/render/make_animation.py from this repository's own code, and
rewrites the README around python run.py (clone and run), with conda as
an alternative, the still figure, a BibTeX entry and the Apache-2.0
licence. CITATION.cff now states Apache-2.0.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@chatgpt-codex-connector

Copy link
Copy Markdown

Codex Review Summary

This comment shows the latest Codex review activity on this pull request.

Review Status Commit Review trigger
📝 Code Review ⚠️ Failed 2026-10-22T10:20:06.152090Z
We couldn’t complete this review. Comment @codex review to try again.
043f003 PR opened
ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review" or "@codex security review".

Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings.

@chatgpt-codex-connector

Copy link
Copy Markdown

You have reached your Codex usage limits for code reviews. You can see your limits in the Codex usage dashboard.

@EngFlavioMartins
EngFlavioMartins merged commit a21899b into main Oct 22, 2026
2 checks passed
@EngFlavioMartins
EngFlavioMartins deleted the clone-and-run branch October 22, 2026 10:22
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