Skip to content

docs: point links at the macEMSuite org #82

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
Paullo9 wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

docs: point links at the macEMSuite org #82

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
2 changes: 1 addition & 1 deletion .github/workflows/docs.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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
Expand Down
2 changes: 1 addition & 1 deletion CITATION.cff
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
10 changes: 5 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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).
Expand All @@ -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 <https://mac4dstem.github.io/FormatoKit/documentation/>.
what is next. The API reference (DocC, one page per module) is at <https://macemsuite.github.io/FormatoKit/documentation/>.

## 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
Expand Down
2 changes: 1 addition & 1 deletion docs/parity.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Loading