Skip to content

Commit 92bb984

Browse files
committed
docs: explain link to LiE, LieART in README.md
1 parent cf2becd commit 92bb984

3 files changed

Lines changed: 19 additions & 36 deletions

File tree

CONTRIBUTING.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,13 @@
11
# Contributing
22

3+
## Use of LLMs
4+
5+
Parts of this package have been written with the assistance of large language
6+
models. LLM-generated code is not inherently trustworthy: it can be subtly
7+
wrong, miss edge cases, or introduce regressions. **Human review of every
8+
change is essential** — please read and understand all code before merging,
9+
regardless of how it was produced.
10+
311
## Code formatting
412

513
The project uses [JuliaFormatter.jl](https://github.com/domluna/JuliaFormatter.jl)

README.md

Lines changed: 11 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,9 @@
66
[![Release](https://img.shields.io/github/v/release/HomogeneousTools/Semisimple.jl?color=green)](https://github.com/HomogeneousTools/Semisimple.jl/releases)
77
[![Aqua QA](https://raw.githubusercontent.com/JuliaTesting/Aqua.jl/master/badge.svg)](https://github.com/JuliaTesting/Aqua.jl)
88

9-
A Julia package for computations with finite-dimensional complex semisimple
10-
Lie algebras via their root data: root systems, Weyl groups, weight lattices,
9+
A Julia package for computations with representations of
10+
finite-dimensional complex semisimple Lie algebras
11+
via their root data: root systems, Weyl groups, weight lattices,
1112
and highest-weight representation-theoretic operations.
1213

1314
## Features
@@ -44,6 +45,14 @@ stability caveats. Use OSCAR when you need integrated algebraic objects; use
4445
Semisimple.jl when you need lightweight, optimized highest-weight and character
4546
computations.
4647

48+
## Related software
49+
50+
Semisimple.jl is inspired by (and partially ported from) [LiE](http://wwwmathlabo.univ-poitiers.fr/~maavl/LiE/),
51+
a computer algebra system for Lie group computations written in C, and by similar
52+
functionality available in [SageMath](https://sagemath.org) and [LieART](https://lieart.hepforge.org/)
53+
(the latter targeting [Mathematica](https://www.wolfram.com/mathematica/)).
54+
Note that Semisimple.jl is less feature-complete than any of these; porting more features is planned.
55+
4756
## Installation
4857

4958
```julia

docs/src/index.md

Lines changed: 0 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -10,40 +10,6 @@ root-data computations.
1010
<p><a href="Semisimple.jl.pdf">Download the PDF manual</a>.</p>
1111
```
1212

13-
Semisimple.jl is a finite-type root-data and highest-weight package. It does not
14-
construct concrete Lie algebra elements, brackets, Chevalley bases, ideals,
15-
subalgebras, homomorphisms, arbitrary-field Lie algebras, or module
16-
homomorphisms.
17-
18-
Semisimple.jl is inspired by (and partially ported) from [LiE](http://wwwmathlabo.univ-poitiers.fr/~maavl/LiE/),
19-
a computer algebra system for Lie group computations written in C.
20-
Parts of the Semisimple.jl code have been written with the assistance of Claude Opus 4.6.
21-
22-
Similar features are also available in [SageMath](https://sagemath.org),
23-
and a similar package is [LieART](https://lieart.hepforge.org/),
24-
which runs on the proprietary [Mathematica](https://www.wolfram.com/mathematica/) software.
25-
26-
Note that Semisimple.jl is less feature-complete than any of the aforementioned packages.
27-
Porting more features is planned.
28-
29-
## Relationship to OSCAR
30-
31-
Semisimple.jl overlaps partly with OSCAR's [stable Lie Theory](https://docs.oscar-system.org/stable/LieTheory/intro/)
32-
module, but the emphasis is different. OSCAR stable provides intentionally
33-
minimal combinatorial scaffolding: Cartan matrices, root systems, Weyl groups,
34-
and weight lattices, represented with OSCAR/AbstractAlgebra parent objects and
35-
integer matrices. Semisimple.jl focuses on finite-type complex semisimple root data
36-
with type-level Dynkin types, `StaticArrays`-based weights and roots, optimized
37-
Weyl orbit traversal, and highest-weight representation-ring computations.
38-
39-
OSCAR's [experimental Lie Algebras](https://docs.oscar-system.org/stable/Experimental/LieAlgebras/introduction/)
40-
module is broader on the algebraic side: it has concrete finite-dimensional Lie
41-
algebra objects, brackets, ideals, subalgebras, homomorphisms, modules, and
42-
module homomorphisms. That module is explicitly experimental, so its API carries
43-
stability caveats. Use OSCAR when you need integrated algebraic objects; use
44-
Semisimple.jl when you need lightweight, optimized highest-weight and character
45-
computations.
46-
4713
## Features
4814

4915
- **Dynkin types** — Type-level classification (`TypeA{N}`, `TypeB{N}`, …, `TypeG2`, products) with text Dynkin diagrams

0 commit comments

Comments
 (0)