Skip to content

docs: point links at the macEMSuite org #77

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
+8 −8
Draft

docs: point links at the macEMSuite org #77

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/DiffractoKit/documentation/ on every tag.
# published to GitHub Pages at https://macemsuite.github.io/DiffractoKit/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 dependency for its docs (its one package dependency is ImagoKit). `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 @@ -9,7 +9,7 @@ authors:
version: 0.12.0 # x-release-please-version
date-released: 2026-11-01 # x-release-please-date
license: GPL-3.0-only
repository-code: "https://github.com/mac4DSTEM/DiffractoKit"
repository-code: "https://github.com/macEMSuite/DiffractoKit"
keywords:
- crystallography
- electron diffraction
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,8 +2,8 @@

# DiffractoKit

[![CI](https://github.com/mac4DSTEM/DiffractoKit/actions/workflows/ci.yml/badge.svg)](https://github.com/mac4DSTEM/DiffractoKit/actions/workflows/ci.yml)
[![Docs](https://github.com/mac4DSTEM/DiffractoKit/actions/workflows/docs.yml/badge.svg)](https://mac4dstem.github.io/DiffractoKit/)
[![CI](https://github.com/macEMSuite/DiffractoKit/actions/workflows/ci.yml/badge.svg)](https://github.com/macEMSuite/DiffractoKit/actions/workflows/ci.yml)
[![Docs](https://github.com/macEMSuite/DiffractoKit/actions/workflows/docs.yml/badge.svg)](https://macemsuite.github.io/DiffractoKit/)

Crystallography and electron diffraction as a Swift package: the numbers a scientist reads, never UI. DiffractoKit
is the Swift counterpart of the crystallography parts of **pymatgen**, **py4DSTEM** and **pyxem**: the unit cell and its
Expand All @@ -13,7 +13,7 @@ diffraction pattern (wavelength, camera length, reciprocal-space pixel size, the
imported by tagged version into applications.

Swift 6 strict concurrency on `Foundation`, `simd`, `CryptoKit`, Metal (the ACOM matcher's optional GPU path) and
[ImagoKit](https://github.com/mac4DSTEM/ImagoKit) (its FFT, on Accelerate); no Python. Headless, one SwiftPM product per
[ImagoKit](https://github.com/macEMSuite/ImagoKit) (its FFT, on Accelerate); no Python. Headless, one SwiftPM product per
module. The one accelerated path, `ACOMMatcher.matchAll(..., backend: .metal)`, keeps the CPU path as its reference and is
checked against it.
**Status: 0.x** ([semantic versioning](https://semver.org): a minor release may change the API, and every release has a
Expand All @@ -38,7 +38,7 @@ One SwiftPM product per module; a module imports only the ones above it in this
```swift
// Package.swift
dependencies: [
.package(url: "https://github.com/mac4DSTEM/DiffractoKit", from: "0.12.0"), // x-release-please-version
.package(url: "https://github.com/macEMSuite/DiffractoKit", from: "0.12.0"), // x-release-please-version
],
targets: [
.target(name: "MyApp", dependencies: [
Expand All @@ -50,7 +50,7 @@ targets: [
```

The package needs macOS 15 or iOS 18 and a Swift 6.2 toolchain (`swift-tools-version: 6.2`). Its only package dependency is
[ImagoKit](https://github.com/mac4DSTEM/ImagoKit), used by `DiffractoOrientation` alone (its `FFT1D`, on Accelerate);
[ImagoKit](https://github.com/macEMSuite/ImagoKit), used by `DiffractoOrientation` alone (its `FFT1D`, on Accelerate);
the system frameworks are Foundation, simd, CryptoKit and, for the optional GPU matcher, Metal. It carries no unsafe
flags: your build compiles it optimised itself; a Debug build of the reflection loops and of the ring fit is slow.
`DiffractoGeometry` depends on the other two, but each file that names a type of a module should import that module itself
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 @@ -399,7 +399,7 @@ upstream counterpart and therefore no row above.

## Known limits and decisions

Open work is in the [issues](https://github.com/mac4DSTEM/DiffractoKit/issues), including the ones closed as *not planned*
Open work is in the [issues](https://github.com/macEMSuite/DiffractoKit/issues), including the ones closed as *not planned*
and parked for later (`cif_import` speed #5, `reflections(kMax:)` speed #6, phase-matching options #7, orix gaps #13). Speed
against Python is in `docs/benchmarks.md`.

Expand Down
Loading