utensil.tngl.sh / pygae-galgebra

0

Symbolic Geometric Algebra/Calculus package for SymPy 🔮 Mirror of https://github.com/pygae/galgebra

0

pygae-galgebra / doc /

at master 8 folders 18 files

Ulysses Tiberious docs(changelog): add 0.6.1 entries for #587, #589, #590; update release date 4mo ago

Correct behavior with kwarg

3 years ago

Setup nbsphinx

8 years ago

Make the latex invisible until it renders

6 years ago

docs(macdonald): update GAlgebraPrimer.pdf to Sep 2023 version; fix README URLs (#575) * docs(macdonald): update GAlgebraPrimer.pdf to Sep 2023 version; fix README date * docs(macdonald): update README date and URL references to Sep 2023 primer

4 months ago

docs(dev): add Step 0 to release process runbook Captures the convention introduced in the 0.6.1 cycle: before preparing the changelog or branching, open a GitHub issue to coordinate the release, explain why we are cutting it now, and list any unusual pre-release todos. Routine steps are already covered by this runbook and need not be repeated.

4 months ago

Fix grad.tex and grad_cmp.tex

7 years ago

Deprecate Get_Program (#349) This function was basically useless. The behavior before was that: * `Get_Program(); Print_Function()` is the same as `Print_Function()` * `Get_Program(True); Print_Function()` is a no-op It's simpler to just not call `Print_Function` if you don't want to print the function. Note that removing lines from the python files means the line number of the deprecation warnings change.

6 years ago

Add module `gprinter`, methods `undual`, `g_invol`, `ccon`, `sp`, `norm2`, `norm` for Mv, with validated tests (#510) Addresses #505 . Co-authored-by: Greg Grunberg <g.s.grunberg@gmail.com> Co-authored-by: Alan Bromborsky <abrombo@users.noreply.github.com>

2 years ago

Use an rst file for galgebra_guide This rst file was generated using nbsphinx and a very small script: ```python from nbsphinx import markdown2rst with open('galgebra.md', encoding='utf8') as f: md = f.read() rst = markdown2rst(md) with open('galgebra_guide.rst', 'w', encoding='utf8') as f: f.write(rst) ``` Since the md file is no longer used, it has been deleted. The advantage of using plain rst is that we can more easily add cross-references, something that markdown is missing. This should allow us to start to deduplicate the API docs. The tables are ridiculously wide, but we can fix this manually without too much work, and the rendering is unaffected.

6 years ago

Use an rst file for galgebra_guide This rst file was generated using nbsphinx and a very small script: ```python from nbsphinx import markdown2rst with open('galgebra.md', encoding='utf8') as f: md = f.read() rst = markdown2rst(md) with open('galgebra_guide.rst', 'w', encoding='utf8') as f: f.write(rst) ``` Since the md file is no longer used, it has been deleted. The advantage of using plain rst is that we can more easily add cross-references, something that markdown is missing. This should allow us to start to deduplicate the API docs. The tables are ridiculously wide, but we can fix this manually without too much work, and the rendering is unaffected.

6 years ago

Improve homepage 1. include README.md 2. move auto-generated API up 3. misc changes to the index

7 years ago

bibliography.rst

Add missing citations, copied back across from the LaTeX

6 years ago

docs(changelog): add 0.6.1 entries for #587, #589, #590; update release date * docs(changelog): add 0.6.1 entries for #587, #589, #590; update release date Adds changelog entries for three PRs merged after the initial 0.6.1 changelog write (#583): - #590 / #576: SymPy 1.13 TR3 performance workaround in curvi_linear_latex - #589 / #588: Step 0 added to release-process runbook - #587 / #586: pyproject.toml migration (PEP 517/621) Also updates the 0.6.1 release date from 2026.04.02 to 2026.04.04 (actual merge date of the last included PR). Addresses the changelog TODOs listed in release issue #588. * docs(changelog): expand 0.6.1 entries for #570, #572, #585 - #570: add ZeroDivisionError fix in Mv._latex, validate_nb_refresh.py, bumping-sympy.md guide, sympy pin bump, and issue #566 reference - #572: remove bumping-sympy.md (belongs to #570, not #572) - #585: add missing entry for is_blade test expansion * docs(changelog): address review — fix tag, ordering, and 570 ZDE split - #590: :support: → :bug: (restores broken CI, not just a workaround) - #585: move to correct descending-number position (between #587 and #580) - #570: split ZeroDivisionError fix into separate :bug:`570` entry so it leads clearly; :support:`570` retains notebook refresh / tooling content

4 months ago

Clarifications for migration guides (#527)

2 years ago

Remove executable bit from everything without a shebang If it doesn't have a shebang and isn't bash or a binary, it shouldn't be marked as executable Performed using `git ls-files | xargs -d '\n' git update-index --chmod=-x`, and then manually removing the three files with a shebang

6 years ago

galgebra_guide.rst

Workaround that preambles no longer works

2 years ago

fix(notebooks): refresh outputs for SymPy 1.13 printing changes (#568) (#570) * fix(notebooks): refresh outputs for SymPy 1.13 printing changes (#568) * feat(scripts): add validate_nb_refresh.py to verify cosmetic-only output changes * docs(dev): add bumping-sympy guide; improve validate_nb_refresh.py CLI help * docs(dev): use .md for bumping-sympy guide; thin .rst wrapper for Sphinx * fix(notebooks): address review feedback on #570 - Bump test_requirements.txt to sympy == 1.13.3 so CI matches the refreshed notebook outputs (root cause of CI failure) - Tighten normalize_plaintext: only strip whitespace in lines that contain unicode box-drawing characters (U+2500-U+257F), leaving other text/plain lines verbatim so sign changes aren't masked - Update pytest command in bumping-sympy.md to match .github/workflows/ ci.yml; add note pointing to CI for the authoritative command * fix(mv): guard Simp.apply in _latex against SymPy 1.13 trigsimp regression SymPy 1.13's trigsimp raises ZeroDivisionError on certain trig expressions (e.g. prolate spheroidal coordinates). Since simplification in _latex is best-effort for display purposes, catch any exception and fall back to the expanded form. Also refreshes LaTeX.ipynb and test_gsg_undual_etc.ipynb outputs for SymPy 1.13.3 printing changes (Mul now renders with \cdot before \left). * fix(mv): narrow exception catch to ZeroDivisionError in _latex; fix doc

4 months ago

Use an rst file for galgebra_guide This rst file was generated using nbsphinx and a very small script: ```python from nbsphinx import markdown2rst with open('galgebra.md', encoding='utf8') as f: md = f.read() rst = markdown2rst(md) with open('galgebra_guide.rst', 'w', encoding='utf8') as f: f.write(rst) ``` Since the md file is no longer used, it has been deleted. The advantage of using plain rst is that we can more easily add cross-references, something that markdown is missing. This should allow us to start to deduplicate the API docs. The tables are ridiculously wide, but we can fix this manually without too much work, and the rendering is unaffected.

6 years ago

module-components.rst

Workaround that preambles no longer works

2 years ago

old_installation.md

Some footnotes belong to old installation doc

7 years ago

old_introduction.md

Remove old introduction and installation guide from main doc

7 years ago

old_migration_guide.md

Clarifications for migration guides (#527)

2 years ago

readthedocs-pip-requirements.txt

Clarifications for migration guides (#527)

2 years ago

Add missing citations, copied back across from the LaTeX

6 years ago

sympy-representation.rst

Workaround that preambles no longer works

2 years ago

Add "Used by" (#528) Add information on how GAlgebra is used in other projects. This list provides information on GAlgebra's usefulness for some, and these downstream projects can be used to validate the GAlgebra against them.

2 years ago

README.md

Documentation#

This is the directory containing files to generate the documentation for galgebra (except for books/, which contains books about galgebra or Geometric Algebra in general from different sources).

For the generated documentation, please visit https://galgebra.readthedocs.io .

The structure of the doc diretory is:

│                                   # Sphinx Doc Source Files:
│                                   #
├─ index.rst                        # The entry point of the Sphinx doc, it references both
│                                   # galgebra_guide.ipynb and api.rst
├─ galgebra.tex                     # The original LaTeX source that generated books/galgebra.pdf
├─ galgebra_guide.rst               # The convert vertion of the latex document.
│                                   # This was converted to markdown manually, then to rST via nodedown and nbsphinx.
├─ api.rst                          # Use automodule to extract doc from galgebra Python source files
│
│                                   # Configurations:
│                                   #
├─ readthedocs-pip-requirements.txt # PIP requirements.txt for readthedocs
├─ conf.py                          # Configurations for Sphinx
│
│                                   # Scripts:
│                                   #
├─ Makefile                         # So `make html` can generate the doc
├─ make.bat                         # Do the same as above for Windows
│
│                                   # Directories Used By Sphinx:
│                                   #
├─ _static/                         # Configured html_static_path for Sphinx, see conf.py
├─ _templates/                      # Configured templates_path for Sphinx, see conf.py
├─ images/                          # Images used in doc
│
│                                   # Legacy Directories:
│                                   #
├─ python/                          # Some Python scripts referenced in the doc but not all of them works
└─ books/                           # Books about galgebra or Geometric Algebra from different sources