diff --git a/articles/introducing-the-technical-notes/figures/banner.jpg b/articles/introducing-the-technical-notes/figures/banner.jpg new file mode 100644 index 0000000..7af64e9 Binary files /dev/null and b/articles/introducing-the-technical-notes/figures/banner.jpg differ diff --git a/articles/introducing-the-technical-notes/introducing-the-technical-notes.md b/articles/introducing-the-technical-notes/introducing-the-technical-notes.md new file mode 100644 index 0000000..502a3ca --- /dev/null +++ b/articles/introducing-the-technical-notes/introducing-the-technical-notes.md @@ -0,0 +1,51 @@ +--- +title: Introducing Underworld Technical Notes +description: >- + The writing on this site that people want to cite now has its own series. + A technical note is written like a short paper, gets an archival PDF, and + carries a DOI that resolves to it. +date: 2026-08-14 +authors: + - name: Louis Moresi + orcid: 0000-0003-3685-174X + affiliations: + - Australian National University +license: CC-BY-4.0 +banner: figures/banner.jpg +keywords: + - Underworld Code +--- +
Photo by Lukas Hron / Unsplash
+ +Our underworld web site has always carried two kinds of writing. Some of it is news — a +release, a workshop, a paper accepted. The rest is the sort of thing a reader +later wants to point at: how a solver behaves, what a benchmark +measured and what it demonstrates, why a method works the way it does and +where it stops working. The two have been mixed together, and there has been +no way to cite the second kind. + +So we now have **technical notes** that are written like a short +paper or perhaps a preprint. Each one carries a version, an archival PDF built from the same source as the +page, and a DOI that resolves to that PDF. Deposit is deliberate rather than +automatic: a note is published here first, and only gets an identifier when we +decide it is worth one. + +The point is for us to write down what we have created with enough content +to be useful and not a lot more, and then refer to it — from a paper, from an +issue, from the next note; instead of describing it again. Not quite +documentation and not yet a research publication. + +The first two are up: [Moving the Mesh Without +Remaking It](/moving-the-mesh-without-remaking-it/), on redistributing mesh +nodes to follow the physics without remeshing, and [Running Underworld in a +Browser](/running-underworld-in-a-browser/), on launching any repository at any +version without installing anything. + +Everything written before is still here, at the same addresses. The fifty posts +that already carry DOIs keep them, and those DOIs still resolve. + +If you work with Underworld and have something worth writing down, the notes +are open to you — [how to submit one](/submit/). You can read [all of +them](/notes/), or [browse by topic](/topics/). + +
Comments
Discussion of these notes happens in GitHub Discussions, so it stays with the source and is searchable alongside it.
Read the discussionStart one
diff --git a/articles/introducing-the-technical-notes/metadata.yml b/articles/introducing-the-technical-notes/metadata.yml new file mode 100644 index 0000000..48ba9d7 --- /dev/null +++ b/articles/introducing-the-technical-notes/metadata.yml @@ -0,0 +1,31 @@ +# Validated in CI against schemas/article-metadata.schema.json. +# `pixi run validate` checks this and the cross-file invariants a schema cannot +# express -- that the article file is named .md, that canonical_path +# matches the slug, and that no legacy DOI is ever paired with a new registrant. +id: UWTN 2026-013 +slug: introducing-the-technical-notes +title: Introducing the Technical Notes +article_type: news +status: published +authors: + - name: Louis Moresi + orcid: 0000-0003-3685-174X + affiliation: Australian National University +publication_date: 2026-08-14 +version: 1.0.0 +# The deposit writes archive_doi and repository_record_id when the note is +# published; leave them out until then. `doi` and `doi_registrant` were here +# once and are not fields the schema knows -- every note made from this +# template failed `pixi run validate` on all three of them. +license: CC-BY-4.0 +canonical_path: /introducing-the-technical-notes/ +legacy_paths: [] +# Facets, from vocabulary.yml. Both keys must be present even when empty: a +# note with no subject is normal -- many are purely about method. +subjects: +methods: +ghost_tags: + - Underworld Code +figures: 1 +banner_credit: "Photo by Lukas Hron / Unsplash" +source: native diff --git a/classification.yml b/classification.yml index 3ad124a..68d9c8e 100644 --- a/classification.yml +++ b/classification.yml @@ -312,3 +312,8 @@ moving-the-mesh-without-remaking-it: article_type: technical-note subjects: [mantle-convection, earthquakes-faults] methods: [meshing, solvers, parallel-hpc] + +introducing-the-technical-notes: + article_type: news + subjects: [] + methods: []