Enable Binder environment for PRs by kwankyu · Pull Request #36245 · sagemath/sage

kwankyu · 2023-09-11T03:05:56Z

Solves sagemath/sage-binder-env#3, but now on GitHub platform.

The author of a PR can use (workflow-dispatch) "Create Binder branch" workflow in her own forked repo to create a new branch "contribution-binder" for a PR branch "contribution". Then she can post the new "contribution-binder" branch or just the Binder badge on the PR description. The reviewers can click the Binder badge to open the Binder environment to test the Sage built with the PR.

Specifically the procedure is
(1) Go to your forked Sage repo
(2) In the Actions tab, find "Create Binder branch" workflow
(3) Run the workflow with your PR branch named say "contribution"
(4) Wait for the workflow run to finish
(5) In the Code tab, select the new "contribution-binder" branch
(6) Edit the generated Dockerfile as you need (and commit)
(7) Find the Binder badge in README.md
(8) Copy the Binder badge from README.md (in edit mode)
(9) Paste the Binder badge into the description of your PR in the sagemath/sage repo
(10) Click the Binder badge to start creating the Binder environment
(11) Leave it open and come back after an hour.
(12) The Binder badge is now ready for reviewers of your PR

The Binder environment branch has Dockerfile, README.md, and a directory notebooks. The Dockerfile builds Sage incrementally with the PR branch. The README.md is the official Sage readme file, but has the Binder badge. The notebooks directory can be used to put some testing Jupyter notebooks provided by the PR author. The notebooks are available in the invoked JupyterLab.

The PR author is supposed to run the Binder badge once so that Binder builds the Docker image. This step takes the longest time, but reasonably fast as it is incremental build. Subsequent runs of the Binder badge take much less time.

For example, this

https://github.com/kwankyu/sage/tree/p/binder-enabled-repo-binder

is the Binder environment branch for this PR. Note that -binder is suffixed to the PR branch p/binder-enabled-repo, and this is the Binder badge

for the Binder environment built with this PR branch. This badge is taken from the README.md file of the above Binder environment branch.

📝 Checklist

The title is concise, informative, and self-explanatory.
The description explains in detail what this PR is about.
I have linked a relevant issue or discussion.
I have created tests covering the changes.
I have updated the documentation accordingly.

⌛ Dependencies

Add badges to README.md #36815

sagemathgh-36815: Add badges to README.md   for those who want to play with Sage instantly, and also as a preparation for sagemath#36245. See this [REAME.md](https://github.com/kwankyu/sage/tree/p/add-binder- badge-to-readme).    ### 📝 Checklist     - [x] The title is concise, informative, and self-explanatory. - [x] The description explains in detail what this PR is about. - [x] I have linked a relevant issue or discussion. - [ ] I have created tests covering the changes. - [ ] I have updated the documentation accordingly. ### ⌛ Dependencies   URL: sagemath#36815 Reported by: Kwankyu Lee Reviewer(s): Matthias Köppe

github-actions · 2024-03-11T03:46:01Z

Documentation preview for this PR (built with commit 3a05362; changes) is ready! 🎉
This preview will update shortly after each push to this PR.

mkoeppe · 2024-03-11T05:44:58Z

The branches that this creates -- they do not contain the Sage sources, correct?

kwankyu · 2024-03-11T05:55:30Z

No. It adds a Dockerfile and a directory notebooks to the sage source, and and modifies README.md.

kwankyu · 2024-03-11T06:00:49Z

It creates a branch of the PR branch in origin, the forked repository.

kwankyu · 2024-03-11T06:01:44Z

A recent example is in #35467

sagemathgh-35467: Attach Jacobians to function fields and curves    ### 📚 Description We attach Jacobians to function fields and curves, enabling arithmetic with the points of the Jacobian. Fixes sagemath#34232. A point of Jacobian is represented by an effective divisor `D` such that the point is the divisor class of `D - B` (of degree 0) with a fixed base divisor `B`. There are two models for Jacobian arithmetic: - Hess model: `D` is internally represented by a pair of certain ideals and arithmetic relies on divisor reduction using Riemann-Roch space computation by Hess' algorithm. - Khuri-Makdisi model: `D` is internally represented by a linear subspace `W_D` of a linear space `V` and arithmetic uses Khuri-Makdisi's linear algebra algorithms. For implementation, sagemath#15113 was referenced. An example with non-hyperelliptic genus 3 curve: ```sage sage: A2.<x,y> = AffineSpace(QQ, 2) sage: f = y^3 + x^4 - 5*x^2*y + 2*x*y - x^2 - 5*y - 4*x + 1 sage: C = Curve(f, A2) sage: X = C.projective_closure() sage: X.genus() 3 sage: X.rational_points(bound=5) [(0 : 0 : 1), (1/3 : 1/3 : 1)] sage: Q = X(0,0,1).place() sage: P = X(1,1,3).place() sage: D = P - Q sage: D.degree() 0 sage: J = X.jacobian(model='hess', base_div=3*Q) sage: G = J.group() sage: p = G.point(D) sage: 2*p + 3*p == 5*p True ``` An example with elliptic curve: ```sage sage: k.<a> = GF((5,2)) sage: E = EllipticCurve(k,[1,0]); E Elliptic Curve defined by y^2 = x^3 + x over Finite Field in a of size 5^2 sage: E.order() 32 sage: P = E([a, 2*a + 4]) sage: P (a : 2*a + 4 : 1) sage: P.order() 8 sage: p = P.point_of_jacobian_of_curve() sage: p [Place (x + 4*a, y + 3*a + 1)] sage: p.order() 8 sage: Q = 3*P sage: q = Q.point_of_jacobian_of_curve() sage: q == 3*p True sage: G = p.parent() sage: G.order() 32 sage: G Group of rational points of Jacobian over Finite Field in a of size 5^2 (Hess model) sage: J = G.parent(); J Jacobian of Projective Plane Curve over Finite Field in a of size 5^2 defined by x^2*y + y^3 - x*z^2 (Hess model) sage: J.curve() == E.affine_patch(2).projective_closure() True ``` An example with hyperelliptic curve: ```sage sage: R.<x> = PolynomialRing(GF(11)) sage: f = x^6 + x + 1 sage: H = HyperellipticCurve(f) sage: J = H.jacobian() sage: D = J(H.lift_x(1)) sage: D # divisor in Mumford representation (x + 10, y + 6) sage: jacobian_order = sum(H.frobenius_polynomial()) sage: jacobian_order 234 sage: p = D.point_of_jacobian_of_curve(); p sage: p # Jacobian point represented by an effective divisor [Place (1/x0, 1/x0^3*x1 + 1) + Place (x0 + 10, x1 + 6)] sage: p.order() 39 sage: 234*p == 0 True sage: G = p.parent() sage: G Group of rational points of Jacobian over Finite Field of size 11 (Hess model) sage: J = G.parent() sage: J Jacobian of Projective Plane Curve over Finite Field of size 11 defined by x0^6 + x0^5*x1 + x1^6 - x0^4*x2^2 (Hess model) sage: C = J.curve() sage: C Projective Plane Curve over Finite Field of size 11 defined by x0^6 + x0^5*x1 + x1^6 - x0^4*x2^2 sage: C.affine_patch(0) == H.affine_patch(2) True ``` [![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2 /gh/kwankyu/sage/p/35467/add-jacobian-groups-notebook-binder) prepared with sagemath#36245     ### 📝 Checklist  - [x] The title is concise, informative, and self-explanatory. - [x] The description explains in detail what this PR is about. - [x] I have linked a relevant issue or discussion. - [x] I have created tests covering the changes. - [x] I have updated the documentation accordingly. ### ⌛ Dependencies   URL: sagemath#35467 Reported by: Kwankyu Lee Reviewer(s): Kwankyu Lee, Matthias Köppe

### 📚 Description We attach Jacobians to function fields and curves, enabling arithmetic with the points of the Jacobian. Fixes sagemath#34232. A point of Jacobian is represented by an effective divisor `D` such that the point is the divisor class of `D - B` (of degree 0) with a fixed base divisor `B`. There are two models for Jacobian arithmetic: - Hess model: `D` is internally represented by a pair of certain ideals and arithmetic relies on divisor reduction using Riemann-Roch space computation by Hess' algorithm. - Khuri-Makdisi model: `D` is internally represented by a linear subspace `W_D` of a linear space `V` and arithmetic uses Khuri-Makdisi's linear algebra algorithms. For implementation, sagemath#15113 was referenced. An example with non-hyperelliptic genus 3 curve: ```sage sage: A2.<x,y> = AffineSpace(QQ, 2) sage: f = y^3 + x^4 - 5*x^2*y + 2*x*y - x^2 - 5*y - 4*x + 1 sage: C = Curve(f, A2) sage: X = C.projective_closure() sage: X.genus() 3 sage: X.rational_points(bound=5) [(0 : 0 : 1), (1/3 : 1/3 : 1)] sage: Q = X(0,0,1).place() sage: P = X(1,1,3).place() sage: D = P - Q sage: D.degree() 0 sage: J = X.jacobian(model='hess', base_div=3*Q) sage: G = J.group() sage: p = G.point(D) sage: 2*p + 3*p == 5*p True ``` An example with elliptic curve: ```sage sage: k.<a> = GF((5,2)) sage: E = EllipticCurve(k,[1,0]); E Elliptic Curve defined by y^2 = x^3 + x over Finite Field in a of size 5^2 sage: E.order() 32 sage: P = E([a, 2*a + 4]) sage: P (a : 2*a + 4 : 1) sage: P.order() 8 sage: p = P.point_of_jacobian_of_curve() sage: p [Place (x + 4*a, y + 3*a + 1)] sage: p.order() 8 sage: Q = 3*P sage: q = Q.point_of_jacobian_of_curve() sage: q == 3*p True sage: G = p.parent() sage: G.order() 32 sage: G Group of rational points of Jacobian over Finite Field in a of size 5^2 (Hess model) sage: J = G.parent(); J Jacobian of Projective Plane Curve over Finite Field in a of size 5^2 defined by x^2*y + y^3 - x*z^2 (Hess model) sage: J.curve() == E.affine_patch(2).projective_closure() True ``` An example with hyperelliptic curve: ```sage sage: R.<x> = PolynomialRing(GF(11)) sage: f = x^6 + x + 1 sage: H = HyperellipticCurve(f) sage: J = H.jacobian() sage: D = J(H.lift_x(1)) sage: D # divisor in Mumford representation (x + 10, y + 6) sage: jacobian_order = sum(H.frobenius_polynomial()) sage: jacobian_order 234 sage: p = D.point_of_jacobian_of_curve(); p sage: p # Jacobian point represented by an effective divisor [Place (1/x0, 1/x0^3*x1 + 1) + Place (x0 + 10, x1 + 6)] sage: p.order() 39 sage: 234*p == 0 True sage: G = p.parent() sage: G Group of rational points of Jacobian over Finite Field of size 11 (Hess model) sage: J = G.parent() sage: J Jacobian of Projective Plane Curve over Finite Field of size 11 defined by x0^6 + x0^5*x1 + x1^6 - x0^4*x2^2 (Hess model) sage: C = J.curve() sage: C Projective Plane Curve over Finite Field of size 11 defined by x0^6 + x0^5*x1 + x1^6 - x0^4*x2^2 sage: C.affine_patch(0) == H.affine_patch(2) True ``` [![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2 /gh/kwankyu/sage/p/35467/add-jacobian-groups-notebook-binder) prepared with sagemath#36245     ### 📝 Checklist  - [x] The title is concise, informative, and self-explanatory. - [x] The description explains in detail what this PR is about. - [x] I have linked a relevant issue or discussion. - [x] I have created tests covering the changes. - [x] I have updated the documentation accordingly. ### ⌛ Dependencies   URL: sagemath#35467 Reported by: Kwankyu Lee Reviewer(s): Kwankyu Lee, Matthias Köppe

sagemathgh-35467: Attach Jacobians to function fields and curves    ### 📚 Description We attach Jacobians to function fields and curves, enabling arithmetic with the points of the Jacobian. Fixes sagemath#34232. A point of Jacobian is represented by an effective divisor `D` such that the point is the divisor class of `D - B` (of degree 0) with a fixed base divisor `B`. There are two models for Jacobian arithmetic: - Hess model: `D` is internally represented by a pair of certain ideals and arithmetic relies on divisor reduction using Riemann-Roch space computation by Hess' algorithm. - Khuri-Makdisi model: `D` is internally represented by a linear subspace `W_D` of a linear space `V` and arithmetic uses Khuri-Makdisi's linear algebra algorithms. For implementation, sagemath#15113 was referenced. An example with non-hyperelliptic genus 3 curve: ```sage sage: A2.<x,y> = AffineSpace(QQ, 2) sage: f = y^3 + x^4 - 5*x^2*y + 2*x*y - x^2 - 5*y - 4*x + 1 sage: C = Curve(f, A2) sage: X = C.projective_closure() sage: X.genus() 3 sage: X.rational_points(bound=5) [(0 : 0 : 1), (1/3 : 1/3 : 1)] sage: Q = X(0,0,1).place() sage: P = X(1,1,3).place() sage: D = P - Q sage: D.degree() 0 sage: J = X.jacobian(model='hess', base_div=3*Q) sage: G = J.group() sage: p = G.point(D) sage: 2*p + 3*p == 5*p True ``` An example with elliptic curve: ```sage sage: k.<a> = GF((5,2)) sage: E = EllipticCurve(k,[1,0]); E Elliptic Curve defined by y^2 = x^3 + x over Finite Field in a of size 5^2 sage: E.order() 32 sage: P = E([a, 2*a + 4]) sage: P (a : 2*a + 4 : 1) sage: P.order() 8 sage: p = P.point_of_jacobian_of_curve() sage: p [Place (x + 4*a, y + 3*a + 1)] sage: p.order() 8 sage: Q = 3*P sage: q = Q.point_of_jacobian_of_curve() sage: q == 3*p True sage: G = p.parent() sage: G.order() 32 sage: G Group of rational points of Jacobian over Finite Field in a of size 5^2 (Hess model) sage: J = G.parent(); J Jacobian of Projective Plane Curve over Finite Field in a of size 5^2 defined by x^2*y + y^3 - x*z^2 (Hess model) sage: J.curve() == E.affine_patch(2).projective_closure() True ``` An example with hyperelliptic curve: ```sage sage: R.<x> = PolynomialRing(GF(11)) sage: f = x^6 + x + 1 sage: H = HyperellipticCurve(f) sage: J = H.jacobian() sage: D = J(H.lift_x(1)) sage: D # divisor in Mumford representation (x + 10, y + 6) sage: jacobian_order = sum(H.frobenius_polynomial()) sage: jacobian_order 234 sage: p = D.point_of_jacobian_of_curve(); p sage: p # Jacobian point represented by an effective divisor [Place (1/x0, 1/x0^3*x1 + 1) + Place (x0 + 10, x1 + 6)] sage: p.order() 39 sage: 234*p == 0 True sage: G = p.parent() sage: G Group of rational points of Jacobian over Finite Field of size 11 (Hess model) sage: J = G.parent() sage: J Jacobian of Projective Plane Curve over Finite Field of size 11 defined by x0^6 + x0^5*x1 + x1^6 - x0^4*x2^2 (Hess model) sage: C = J.curve() sage: C Projective Plane Curve over Finite Field of size 11 defined by x0^6 + x0^5*x1 + x1^6 - x0^4*x2^2 sage: C.affine_patch(0) == H.affine_patch(2) True ``` [![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2 /gh/kwankyu/sage/p/35467/add-jacobian-groups-notebook-binder) prepared with sagemath#36245     ### 📝 Checklist  - [x] The title is concise, informative, and self-explanatory. - [x] The description explains in detail what this PR is about. - [x] I have linked a relevant issue or discussion. - [x] I have created tests covering the changes. - [x] I have updated the documentation accordingly. ### ⌛ Dependencies   URL: sagemath#35467 Reported by: Kwankyu Lee Reviewer(s): Kwankyu Lee, Matthias Köppe

kwankyu force-pushed the p/binder-enabled-repo branch from 357629e to 7cca95a Compare September 11, 2023 03:10

kwankyu mentioned this pull request Sep 12, 2023

Use binder for reviewing trac tickets sagemath/sage-binder-env#3

Closed

kwankyu force-pushed the p/binder-enabled-repo branch 2 times, most recently from 547dee1 to 5930e3d Compare September 15, 2023 06:12

kwankyu mentioned this pull request Sep 25, 2023

Revive sage live doc using jupyter-sphinx #36144

Merged

5 tasks

vbraun force-pushed the develop branch from 883e05f to e349b00 Compare November 12, 2023 16:25

kwankyu force-pushed the p/binder-enabled-repo branch 5 times, most recently from 8bc5b18 to cd97a1b Compare December 2, 2023 10:50

kwankyu added s: needs review c: scripts labels Dec 2, 2023

kwankyu mentioned this pull request Dec 4, 2023

Add badges to README.md #36815

Merged

5 tasks

kwankyu force-pushed the p/binder-enabled-repo branch from cd97a1b to 2f3753a Compare December 4, 2023 04:42

kwankyu marked this pull request as ready for review December 4, 2023 04:43

kwankyu added s: needs work and removed s: needs review labels Dec 4, 2023

kwankyu force-pushed the p/binder-enabled-repo branch 2 times, most recently from 8d4f219 to ee50dc0 Compare December 16, 2023 22:56

kwankyu added s: needs review and removed s: needs work labels Dec 16, 2023

kwankyu force-pushed the p/binder-enabled-repo branch 6 times, most recently from 11dfcd7 to 4e558f9 Compare December 18, 2023 10:33

kwankyu force-pushed the p/binder-enabled-repo branch 7 times, most recently from 86faf2a to f5c436c Compare December 18, 2023 19:24

kwankyu removed the s: needs review label Dec 19, 2023

kwankyu force-pushed the p/binder-enabled-repo branch from f5c436c to 2a1dc21 Compare March 10, 2024 10:29

kwankyu added the s: needs review label Mar 10, 2024

kwankyu mentioned this pull request Mar 10, 2024

Attach Jacobians to function fields and curves #35467

Merged

5 tasks

kwankyu force-pushed the p/binder-enabled-repo branch from 4ba1a99 to 5a59a1e Compare June 3, 2024 06:45

github-actions bot added the v: moderate label Jun 3, 2024

vbraun force-pushed the develop branch from eba5e19 to e5f42fa Compare June 3, 2024 22:15

Add binder.yml

3a05362

kwankyu force-pushed the p/binder-enabled-repo branch from 5a59a1e to 3a05362 Compare August 4, 2024 10:48

kwankyu added pending and removed s: needs review labels Oct 5, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Enable Binder environment for PRs#36245

Enable Binder environment for PRs#36245
kwankyu wants to merge 1 commit intosagemath:developfrom
kwankyu:p/binder-enabled-repo

kwankyu commented Sep 11, 2023 •

edited

Loading

Uh oh!

github-actions bot commented Mar 11, 2024 •

edited

Loading

Uh oh!

mkoeppe commented Mar 11, 2024

Uh oh!

kwankyu commented Mar 11, 2024 •

edited

Loading

Uh oh!

kwankyu commented Mar 11, 2024

Uh oh!

kwankyu commented Mar 11, 2024 •

edited

Loading

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Uh oh!

Conversation

kwankyu commented Sep 11, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

📝 Checklist

⌛ Dependencies

Uh oh!

github-actions bot commented Mar 11, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

mkoeppe commented Mar 11, 2024

Uh oh!

kwankyu commented Mar 11, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

kwankyu commented Mar 11, 2024

Uh oh!

kwankyu commented Mar 11, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

kwankyu commented Sep 11, 2023 •

edited

Loading

github-actions bot commented Mar 11, 2024 •

edited

Loading

kwankyu commented Mar 11, 2024 •

edited

Loading

kwankyu commented Mar 11, 2024 •

edited

Loading