From d3c76366f8f35f8dda4c2b5d9240a78e3575dedb Mon Sep 17 00:00:00 2001 From: Paul Lobpreis Date: Fri, 6 Nov 2026 19:13:33 +0000 Subject: [PATCH] docs: point links at the macEMSuite org Held until the organization is renamed (mac4DSTEM/macEM-suite#108): the new URLs do not resolve before that. Link and text only, no Package.swift change; those follow bottom-up after the rename. Co-Authored-By: Claude Fable 5.1 Claude-Session: https://claude.ai/code/session_01VkKZEScS1WVMtt5Tixc4R6 --- .github/workflows/docs.yml | 2 +- CITATION.cff | 2 +- README.md | 10 +++++----- docs/parity.md | 2 +- 4 files changed, 8 insertions(+), 8 deletions(-) diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index 238e163..8a64c8e 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -1,5 +1,5 @@ # API reference: one DocC archive per module (the .docc catalogs under Sources/), merged into one static site and -# published to GitHub Pages at https://mac4dstem.github.io/FormatoKit/documentation/ on every tag. +# published to GitHub Pages at https://macemsuite.github.io/FormatoKit/documentation/ on every tag. # On a pull request the site is built and uploaded as an artifact only, so a broken catalog fails before the tag. # # No swift-docc-plugin: the kit adds no package dependency for its docs. `xcodebuild docbuild` builds the archives diff --git a/CITATION.cff b/CITATION.cff index 6e1f50d..4a3b334 100644 --- a/CITATION.cff +++ b/CITATION.cff @@ -12,7 +12,7 @@ authors: version: "0.12.1" # x-release-please-version date-released: "2026-11-01" # x-release-please-date license: GPL-3.0-only -repository-code: "https://github.com/mac4DSTEM/FormatoKit" +repository-code: "https://github.com/macEMSuite/FormatoKit" keywords: - electron microscopy - file formats diff --git a/README.md b/README.md index 008b8e4..e359dc3 100644 --- a/README.md +++ b/README.md @@ -2,9 +2,9 @@ # FormatoKit -[![CI](https://github.com/mac4DSTEM/FormatoKit/actions/workflows/ci.yml/badge.svg)](https://github.com/mac4DSTEM/FormatoKit/actions/workflows/ci.yml) -[![Docs](https://github.com/mac4DSTEM/FormatoKit/actions/workflows/docs.yml/badge.svg)](https://mac4dstem.github.io/FormatoKit/documentation/) -[![Release](https://img.shields.io/github/v/tag/mac4DSTEM/FormatoKit?label=release&sort=semver)](https://github.com/mac4DSTEM/FormatoKit/tags) +[![CI](https://github.com/macEMSuite/FormatoKit/actions/workflows/ci.yml/badge.svg)](https://github.com/macEMSuite/FormatoKit/actions/workflows/ci.yml) +[![Docs](https://github.com/macEMSuite/FormatoKit/actions/workflows/docs.yml/badge.svg)](https://macemsuite.github.io/FormatoKit/documentation/) +[![Release](https://img.shields.io/github/v/tag/macEMSuite/FormatoKit?label=release&sort=semver)](https://github.com/macEMSuite/FormatoKit/tags) [![Licence: GPL-3.0-only](https://img.shields.io/badge/licence-GPL--3.0--only-blue)](LICENSE) A file-format library for macOS: the Mac counterpart of [RosettaSciIO](https://github.com/hyperspy/rosettasciio). @@ -28,12 +28,12 @@ large, one SwiftPM product per module. | `FormatoPeek` | `Peek.thumbnailFrame(url:maxPixels:)` and `Peek.summary(url:)`: one decimated frame and the header facts of a DM, Velox, TIFF, MRC, MSA or py4DSTEM HDF5 file, never more than one frame read (for Quick Look and Finder previews) | 0.10.0 | `docs/parity.md` is the checklist against RosettaSciIO's formats table and its reader options: what reads, what is pinned, -what is next. The API reference (DocC, one page per module) is at . +what is next. The API reference (DocC, one page per module) is at . ## The first ten minutes Add the package to your `Package.swift` -(`.package(url: "https://github.com/mac4DSTEM/FormatoKit.git", from: "0.12.1")`, or `.package(path: "../FormatoKit")` for a +(`.package(url: "https://github.com/macEMSuite/FormatoKit.git", from: "0.12.1")`, or `.package(path: "../FormatoKit")` for a clone), and the products you need (`FormatoDM`, `FormatoEMD`, `FormatoTIFF`; each brings `FormatoCore`). To try it on files you have in hand, use the ones in this repository: planted files made for the tests, under diff --git a/docs/parity.md b/docs/parity.md index 75c672d..670a269 100644 --- a/docs/parity.md +++ b/docs/parity.md @@ -332,7 +332,7 @@ run the suite again without the variable. The regenerated files are committed on ## Known limits and decisions -Open work is in the [issues](https://github.com/mac4DSTEM/FormatoKit/issues), including the ones closed as *not planned* and +Open work is in the [issues](https://github.com/macEMSuite/FormatoKit/issues), including the ones closed as *not planned* and parked for later (read speed #4, GMS EDS geometry #5, more formats #11). Speed against RosettaSciIO is in `docs/benchmarks.md`. - **Read speed.** DM4 2048² f32, TIFF 4096² u16 and DM4 4D 32² x 128² read about 2x slower than RosettaSciIO. The shared lazy