diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index 68b59ea..fc5877b 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/SpectroKit/documentation/ on every tag. +# published to GitHub Pages at https://macemsuite.github.io/SpectroKit/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, so the docs add no dependency to the manifest: `xcodebuild docbuild` builds the archives from the diff --git a/CITATION.cff b/CITATION.cff index 7b231a5..7d8d3a6 100644 --- a/CITATION.cff +++ b/CITATION.cff @@ -9,7 +9,7 @@ authors: license: GPL-3.0-only version: "0.13.2" # x-release-please-version date-released: "2026-11-01" # x-release-please-date -repository-code: "https://github.com/mac4DSTEM/SpectroKit" +repository-code: "https://github.com/macEMSuite/SpectroKit" abstract: "A Swift library for EDS and EELS spectroscopy on macOS: X-ray identification and quantification, EELS thickness, deconvolution and core-loss edges, a port of exSpy checked against exSpy and HyperSpy." keywords: - EDS diff --git a/README.md b/README.md index 1d8cbaf..381a021 100644 --- a/README.md +++ b/README.md @@ -2,9 +2,9 @@ # SpectroKit -[![CI](https://github.com/mac4DSTEM/SpectroKit/actions/workflows/ci.yml/badge.svg)](https://github.com/mac4DSTEM/SpectroKit/actions/workflows/ci.yml) -[![Release](https://img.shields.io/github/v/tag/mac4DSTEM/SpectroKit?label=release)](https://github.com/mac4DSTEM/SpectroKit/tags) -[![Docs](https://img.shields.io/badge/docs-DocC-blue)](https://mac4dstem.github.io/SpectroKit/documentation/) +[![CI](https://github.com/macEMSuite/SpectroKit/actions/workflows/ci.yml/badge.svg)](https://github.com/macEMSuite/SpectroKit/actions/workflows/ci.yml) +[![Release](https://img.shields.io/github/v/tag/macEMSuite/SpectroKit?label=release)](https://github.com/macEMSuite/SpectroKit/tags) +[![Docs](https://img.shields.io/badge/docs-DocC-blue)](https://macemsuite.github.io/SpectroKit/documentation/) [![License: GPL-3.0-only](https://img.shields.io/badge/license-GPL--3.0--only-blue)](LICENSE) A Swift library for X-ray (EDS) and electron energy-loss (EELS) spectroscopy in the transmission electron microscope: a @@ -41,7 +41,7 @@ let package = Package( name: "MyTool", platforms: [.macOS(.v15)], dependencies: [ - .package(url: "https://github.com/mac4DSTEM/SpectroKit", from: "0.13.2"), + .package(url: "https://github.com/macEMSuite/SpectroKit", from: "0.13.2"), ], targets: [ .executableTarget(name: "MyTool", dependencies: [ @@ -56,7 +56,7 @@ let package = Package( Add only the products you use; `SpectroEDX` and `SpectroEELS` each need `SpectroCore` and bring it. -**File formats.** The readers are not here: they are [FormatoKit](https://github.com/mac4DSTEM/FormatoKit)'s, a dependency +**File formats.** The readers are not here: they are [FormatoKit](https://github.com/macEMSuite/FormatoKit)'s, a dependency SpectroKit resolves by itself, with its own libhdf5 inside (nothing to install). `SpectrumImageOpener` in `SpectroCore` calls them: it opens a Velox `.emd` (Thermo Fisher; FormatoKit's `FormatoEMD`) or a Gatan GMS `.dm4` EDS spectrum image (`FormatoDM`) and needs no import of yours. Add the Formato products to your own target only to read the file yourself: @@ -224,7 +224,7 @@ of this README and nothing else, and `check-readme.py` fails if the README and ` - [`docs/parity.md`](docs/parity.md): SpectroKit against exSpy's documented API, row by row. Numbers are held to the Python reference within its own tolerance; `docs/parity.md` lists each function, its state and its tolerance. -- [API reference (DocC)](https://mac4dstem.github.io/SpectroKit/documentation/): one catalogue per module. +- [API reference (DocC)](https://macemsuite.github.io/SpectroKit/documentation/): one catalogue per module. - [`CHANGELOG.md`](CHANGELOG.md): each release, with a Migration paragraph where a consumer must change something. - [`NOTICE`](NOTICE): the licences and credits in full. diff --git a/docs/parity.md b/docs/parity.md index 04f2b15..3f155c6 100644 --- a/docs/parity.md +++ b/docs/parity.md @@ -319,7 +319,7 @@ it 20.3 % low in counts (Si share 0.546 at% against 0.675 at%, 19 % low; the sha ## Known limits and decisions -Open work is in the [issues](https://github.com/mac4DSTEM/SpectroKit/issues), including the ones closed as *not planned* and +Open work is in the [issues](https://github.com/macEMSuite/SpectroKit/issues), including the ones closed as *not planned* and parked for later (t/λ speed #7, EELS fine structure #10, Richardson-Lucy and weighted MLLS #11, EDS calibration operations #12, standards #14). Speed against HyperSpy and exSpy is in `docs/benchmarks.md`; benchmark rows for the EDX fit and auto ID on a Velox spectrum image, the EELS power-law fit, edge quantification and the large sizes are not written yet.