Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,4 +28,14 @@ hugo server
| `ci.yml` | the site builds and names every member organisation and repository; the notebook prints what the page says |
| `links.yml` | every link and image of the built site resolves (`landingkit links`) |

## Documentation

The documentation site is [go-scikit/docs](https://github.com/go-scikit/docs),
served at <https://go-scikit.github.io/docs/>. The roadmap section of the page
lists the parity-plan organisations with their status (a package is "released"
only when a tag exists) and, where they exist, their landing and docs sites:
[go-approx](https://go-approx.github.io/), [go-dsp](https://go-dsp.github.io/),
[go-sparse](https://go-sparse.github.io/) and
[go-bignum](https://go-bignum.github.io/).

BSD-3-Clause.
24 changes: 19 additions & 5 deletions hugo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -124,7 +124,8 @@ disableKinds = ['taxonomy', 'term', 'rss', 'sitemap', '404']

# The roadmap section (#roadmap). Every statement is from
# https://github.com/go-scikit/roadmap (PLAN.md and STATUS.md); the new
# organisations have no sites yet, so they link to their GitHub pages.
# organisations that have a landing and a documentation site carry `site` and
# `docs`; the others link to their GitHub pages.
[[params.waves]]
name = "Wave 1: the everyday MATLAB core"
what = "Correctly rounded <code>big.Float</code> functions and a Go oracle harness; sparse matrices and iterative solvers; interpolation and splines; filter design and spectral estimation."
Expand All @@ -144,20 +145,28 @@ disableKinds = ['taxonomy', 'term', 'rss', 'sitemap', '404']

[[params.neworgs]]
name = "go-bignum"
state = "in progress"
state = "bigfloat in development, not yet tagged"
what = "arbitrary precision, number theory, the Go oracle harness"
site = "https://go-bignum.github.io/"
docs = "https://go-bignum.github.io/docs/"
[[params.neworgs]]
name = "go-sparse"
state = "in progress"
state = "sparse v0.1.0 released"
what = "sparse matrices, orderings, iterative and direct solvers, sparse eigensolvers"
site = "https://go-sparse.github.io/"
docs = "https://go-sparse.github.io/docs/"
[[params.neworgs]]
name = "go-approx"
state = "interp v0.1.0 released; poly performance work in review (poly#2)"
state = "interp and poly v0.1.0 released"
what = "interpolation, splines, polynomials, Chebyshev and AAA approximation, scattered data"
site = "https://go-approx.github.io/"
docs = "https://go-approx.github.io/docs/"
[[params.neworgs]]
name = "go-dsp"
state = "in progress"
state = "signal v0.1.0 released"
what = "filter design and filtering, spectral estimation, resampling, wavelets, audio I/O"
site = "https://go-dsp.github.io/"
docs = "https://go-dsp.github.io/docs/"
[[params.neworgs]]
name = "go-symbolic"
state = "planned"
Expand Down Expand Up @@ -207,6 +216,11 @@ disableKinds = ['taxonomy', 'term', 'rss', 'sitemap', '404']
kind = "assets"
href = "https://github.com/go-scikit/brand"
blurb = "Logos and icons in SVG / PNG / JPG / ICO / ICNS; the mark is the stack, written by a Go program from the list of member organisations."
[[params.repos]]
name = "docs"
kind = "docs"
href = "https://github.com/go-scikit/docs"
blurb = "The documentation site (Hugo and Hextra), served at go-scikit.github.io/docs: the member organisations with their landing and docs links, and the status of the parity-plan packages."
[[params.repos]]
name = "roadmap"
kind = "plan"
Expand Down
6 changes: 3 additions & 3 deletions layouts/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -101,16 +101,16 @@ <h2>{{ len .Site.Params.claims }} claims, each <i>with its evidence</i>.</h2>
<section id="roadmap" style="padding-top:10px"><div class="wrap">
<span class="eyebrow">Roadmap</span>
<h2>Parity with MATLAB and Mathematica, <i>in four waves</i>.</h2>
<p class="lead">The goal is feature parity with MATLAB (base and toolboxes) and Mathematica, in pure Go (CGO=0), each piece validated against the reference tools of its domain. The plan, the home of each domain and the order of the work are in the <a href="https://github.com/go-scikit/roadmap"><u>roadmap repository</u></a>: <a href="https://github.com/go-scikit/roadmap/blob/main/PLAN.md"><u>PLAN.md</u></a>, <a href="https://github.com/go-scikit/roadmap/blob/main/STATUS.md"><u>STATUS.md</u></a> and the <a href="https://github.com/go-scikit/roadmap/tree/main/bib"><u>bibliography</u></a>. One package of the new organisations has been released so far: <a href="https://github.com/go-approx/interp"><u>go-approx/interp</u></a> v0.1.0 (speed comparison in its <a href="https://github.com/go-approx/interp/blob/main/docs/perf.md"><u>docs/perf.md</u></a>). The vector-update kernels <code>Axpy</code>, <code>Xpby</code>, <code>AxpyDot</code> and <code>Scale</code> shipped in go-simd/floats v0.4.0. Performance pull requests are in review for <a href="https://github.com/go-approx/poly/pull/2"><u>poly</u></a>, <a href="https://github.com/go-dsp/signal/pull/2"><u>signal</u></a> and <a href="https://github.com/go-sparse/sparse/pull/2"><u>sparse</u></a>.</p>
<p class="lead">The goal is feature parity with MATLAB (base and toolboxes) and Mathematica, in pure Go (CGO=0), each piece validated against the reference tools of its domain. The plan, the home of each domain and the order of the work are in the <a href="https://github.com/go-scikit/roadmap"><u>roadmap repository</u></a>: <a href="https://github.com/go-scikit/roadmap/blob/main/PLAN.md"><u>PLAN.md</u></a>, <a href="https://github.com/go-scikit/roadmap/blob/main/STATUS.md"><u>STATUS.md</u></a> and the <a href="https://github.com/go-scikit/roadmap/tree/main/bib"><u>bibliography</u></a>. Four packages of the new organisations have been released at v0.1.0: <a href="https://github.com/go-approx/interp"><u>go-approx/interp</u></a> (speed comparison in its <a href="https://github.com/go-approx/interp/blob/main/docs/perf.md"><u>docs/perf.md</u></a>), <a href="https://github.com/go-approx/poly"><u>go-approx/poly</u></a>, <a href="https://github.com/go-dsp/signal"><u>go-dsp/signal</u></a> and <a href="https://github.com/go-sparse/sparse"><u>go-sparse/sparse</u></a>; <a href="https://github.com/go-bignum/bigfloat"><u>go-bignum/bigfloat</u></a> is in development and not yet tagged. The vector-update kernels <code>Axpy</code>, <code>Xpby</code>, <code>AxpyDot</code> and <code>Scale</code> shipped in go-simd/floats v0.4.0.</p>
<div class="grid">
{{ range .Site.Params.waves }}
<div class="card"><h3>{{ .name }}</h3><p>{{ .what | safeHTML }}</p><p style="margin-top:12px;color:var(--slate);font-size:13.5px">Homes: {{ .homes }}</p></div>
{{ end }}
</div>
<p class="lead" style="margin-top:30px">The {{ len .Site.Params.neworgs }} new organisations have no sites yet; they are on GitHub.</p>
<p class="lead" style="margin-top:30px">The {{ len .Site.Params.neworgs }} new organisations. The first four have a landing page and documentation; the others are on GitHub only.</p>
<ul>
{{ range .Site.Params.neworgs }}
<li><a href="https://github.com/{{ .name }}"><b>{{ .name }}</b></a> ({{ .state }}): {{ .what }}</li>
<li><a href="https://github.com/{{ .name }}"><b>{{ .name }}</b></a> ({{ .state }}): {{ .what }}{{ with .site }} &middot; <a href="{{ . }}"><u>landing</u></a>{{ end }}{{ with .docs }} &middot; <a href="{{ . }}"><u>docs</u></a>{{ end }}</li>
{{ end }}
</ul>
</div></section>
Expand Down
Loading