Skip to content

Commit

Permalink
docs: rm tutorial, rm development
Browse files Browse the repository at this point in the history
  • Loading branch information
sumiya11 committed Oct 13, 2024
1 parent 12d09f7 commit de3d3ad
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 6 deletions.
4 changes: 2 additions & 2 deletions docs/_layout/sidebar.html
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ <h1 class="sidebar-title"><a href="/">Groebner<span style="opacity:0.4">.jl</spa
<nav class="sidebar-nav" style="opacity: 0.9">
<a class="sidebar-nav-item {{ispage index.html}}active{{end}}" href="/">Home</a>
<!-- <a class="sidebar-nav-item {{ispage tutorial.html}}active{{end}}" href="/tutorial/">Tutorials</a> -->
<li class="sidebar-nav-item {{ispage tutorial.html}}active{{end}}"><a href="/tutorial/">Introductory tutorial</a>
<!-- <li class="sidebar-nav-item {{ispage tutorial.html}}active{{end}}"><a href="/tutorial/">Introductory tutorial</a> -->
<!-- <ul class="menu-list-child-list ">
<li class="menu-list-item {{ispage tutorial.html}}active{{end}}"><a href="/tutorial/#introduction" class="menu-list-link">Introduction</a>
<li class="menu-list-item {{ispage tutorial.html}}active{{end}}"><a href="/tutorial/#gcd_rref" class="menu-list-link">Gcd & Rref</a>
Expand All @@ -51,7 +51,7 @@ <h1 class="sidebar-title"><a href="/">Groebner<span style="opacity:0.4">.jl</spa
<li class="menu-list-item {{ispage interface.html}}active{{end}}"><a href="/interface/#learn_and_apply"
class="menu-list-link">Learn and Apply</a>
</ul>
<li class="sidebar-nav-item {{ispage developer.html}}active{{end}}"><a href="/developer/">Development</a>
<!-- <li class="sidebar-nav-item {{ispage developer.html}}active{{end}}"><a href="/developer/">Development</a> -->
</nav>

</div>
Expand Down
15 changes: 11 additions & 4 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ where appropriate -->
![](/assets/logo-with-text.svg)
@@

Groebner.jl is a package for fast and generic Gröbner bases computations based on Faugère's [F4 algorithm](https://www-polsys.lip6.fr/~jcf/Papers/F99a.pdf) written in Julia.
Groebner.jl is a package for Gröbner bases computation based on the Faugère's F4 algorithm written in Julia.

## Installation

Expand All @@ -24,12 +24,19 @@ Pkg.add(url="https://github.com/sumiya11/Groebner.jl") # hide
using Pkg; Pkg.add("Groebner")
```

See [Interface](interface) for a description of all exported functions. For a quick introduction to Groebner bases we refer to [Tutorials](tutorial). Meanwhile, below are simple examples.
## Features

Groebner.jl features:

- Gröbner bases over integers modulo a prime and over the rationals
- Gröbner trace algorithms
- Multi-threading by default

See [Interface](interface) page for a list of all exported functions.

## Examples

Currently, polynomials from AbstractAlgebra.jl, DynamicPolynomials.jl, and Nemo.jl
are supported as input.
As input, Groebner.jl supports polynomials from AbstractAlgebra.jl, DynamicPolynomials.jl, and Nemo.jl.

### with AbstractAlgebra.jl

Expand Down

0 comments on commit de3d3ad

Please sign in to comment.