Skip to content

Commit 39abccc

Browse files
committed
docs: naming consistency itk-wasm -> ITK-Wasm
The overall project is called ITK-Wasm. The npm package is still itk-wasm. The Python package is itkwasm. Keep the idiomatic package names.
1 parent 7187eca commit 39abccc

File tree

96 files changed

+697
-697
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

96 files changed

+697
-697
lines changed

CHANGELOG.md

Lines changed: 528 additions & 528 deletions
Large diffs are not rendered by default.

CITATION.cff

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ keywords:
2929
- scientific-computing
3030
- visualization
3131
repository-code: >-
32-
https://github.com/InsightSoftwareConsortium/itk-wasm
32+
https://github.com/InsightSoftwareConsortium/ITK-Wasm
3333
url: 'https://wasm.itk.org'
3434
repository-artifact: 'https://www.npmjs.com/package/itk-wasm'
3535
license: Apache-2.0

CMake/ITKExternalData.cmake

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,7 @@ if(NOT ITK_FORBID_DOWNLOADS)
5959
"https://cloudflare-ipfs.com/ipfs/%(hash)"
6060

6161
# DataLad repository on gin.g-node.org
62-
"https://gin.g-node.org/InsightSoftwareConsortium/itk-wasm-testing-data/raw/main/Objects/CID/%(hash)"
62+
"https://gin.g-node.org/InsightSoftwareConsortium/ITK-Wasm-testing-data/raw/main/Objects/CID/%(hash)"
6363
)
6464
endif()
6565

README.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,23 @@
1-
itk-wasm
1+
ITK-Wasm
22
========
33

4-
[![Examples](https://github.com/InsightSoftwareConsortium/itk-wasm/actions/workflows/examples.yml/badge.svg)](https://github.com/InsightSoftwareConsortium/itk-wasm/actions/workflows/examples.yml)
5-
[![Toolchains](https://github.com/InsightSoftwareConsortium/itk-wasm/actions/workflows/toolchains.yml/badge.svg)](https://github.com/InsightSoftwareConsortium/itk-wasm/actions/workflows/toolchains.yml)
6-
[![JavaScript, TypeScript](https://github.com/InsightSoftwareConsortium/itk-wasm/actions/workflows/javascript-typescript.yml/badge.svg)](https://github.com/InsightSoftwareConsortium/itk-wasm/actions/workflows/javascript-typescript.yml)
7-
[![Python Wasm](https://github.com/InsightSoftwareConsortium/itk-wasm/actions/workflows/python-wasm.yml/badge.svg)](https://github.com/InsightSoftwareConsortium/itk-wasm/actions/workflows/python-wasm.yml)
8-
[![C++,Native Python](https://github.com/InsightSoftwareConsortium/itk-wasm/actions/workflows/cxx-python.yml/badge.svg)](https://github.com/InsightSoftwareConsortium/itk-wasm/actions/workflows/cxx-python.yml)
9-
[![WASI](https://github.com/InsightSoftwareConsortium/itk-wasm/actions/workflows/wasi.yml/badge.svg)](https://github.com/InsightSoftwareConsortium/itk-wasm/actions/workflows/wasi.yml)
10-
[![Documentation](https://github.com/InsightSoftwareConsortium/itk-wasm/actions/workflows/documentation.yml/badge.svg)](https://github.com/InsightSoftwareConsortium/itk-wasm/actions/workflows/documentation.yml)
4+
[![Examples](https://github.com/InsightSoftwareConsortium/ITK-Wasm/actions/workflows/examples.yml/badge.svg)](https://github.com/InsightSoftwareConsortium/ITK-Wasm/actions/workflows/examples.yml)
5+
[![Toolchains](https://github.com/InsightSoftwareConsortium/ITK-Wasm/actions/workflows/toolchains.yml/badge.svg)](https://github.com/InsightSoftwareConsortium/ITK-Wasm/actions/workflows/toolchains.yml)
6+
[![JavaScript, TypeScript](https://github.com/InsightSoftwareConsortium/ITK-Wasm/actions/workflows/javascript-typescript.yml/badge.svg)](https://github.com/InsightSoftwareConsortium/ITK-Wasm/actions/workflows/javascript-typescript.yml)
7+
[![Python Wasm](https://github.com/InsightSoftwareConsortium/ITK-Wasm/actions/workflows/python-wasm.yml/badge.svg)](https://github.com/InsightSoftwareConsortium/ITK-Wasm/actions/workflows/python-wasm.yml)
8+
[![C++,Native Python](https://github.com/InsightSoftwareConsortium/ITK-Wasm/actions/workflows/cxx-python.yml/badge.svg)](https://github.com/InsightSoftwareConsortium/ITK-Wasm/actions/workflows/cxx-python.yml)
9+
[![WASI](https://github.com/InsightSoftwareConsortium/ITK-Wasm/actions/workflows/wasi.yml/badge.svg)](https://github.com/InsightSoftwareConsortium/ITK-Wasm/actions/workflows/wasi.yml)
10+
[![Documentation](https://github.com/InsightSoftwareConsortium/ITK-Wasm/actions/workflows/documentation.yml/badge.svg)](https://github.com/InsightSoftwareConsortium/ITK-Wasm/actions/workflows/documentation.yml)
1111

1212
[![npm version](https://badge.fury.io/js/itk-wasm.svg)](https://www.npmjs.com/package/itk-wasm)
1313
[![npm version](https://badge.fury.io/py/itkwasm.svg)](https://pypi.org/project/itkwasm/)
1414
[![npm version](https://badge.fury.io/py/itk-webassemblyinterface.svg)](https://pypi.org/project/itk-webassemblyinterface/)
1515

1616
[![DOI](https://zenodo.org/badge/45812381.svg)](https://zenodo.org/badge/latestdoi/45812381)
1717

18-
![License](https://img.shields.io/github/license/InsightSoftwareConsortium/itk-wasm) ![GitHub commit activity](https://img.shields.io/github/commit-activity/y/InsightSoftwareConsortium/itk-wasm)
18+
![License](https://img.shields.io/github/license/InsightSoftwareConsortium/ITK-Wasm) ![GitHub commit activity](https://img.shields.io/github/commit-activity/y/InsightSoftwareConsortium/ITK-Wasm)
1919

20-
*itk-wasm* combines [ITK](https://www.itk.org/) and
20+
*ITK-Wasm* combines [ITK](https://www.itk.org/) and
2121
[WebAssembly](https://webassembly.org/) to enable high-performance spatial
2222
analysis in a web browser, Node.js, Python, and reproducible execution across
2323
programming languages and hardware architectures.
@@ -27,7 +27,7 @@ The project provides tools to a) build C/C++ code to
2727
JavaScript/TypeScript/Python data structures, and traditional file formats, c)
2828
transfer data efficiently in and out of the WebAssembly runtime, and d)
2929
asynchronous, parallel execution of processing pipelines in a worker pool.
30-
*itk-wasm* can be used to execute [ITK](https://www.itk.org/)
30+
*ITK-Wasm* can be used to execute [ITK](https://www.itk.org/)
3131
or arbitrary C++ codes in the browser, on a
3232
workstation / server with [Node.js](https://nodejs.org/) or [Python](https://python.org), or standalone
3333
execution and wrapped in [WASI](https://wasi.dev/) runtimes.

docs/conf.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@
5151
# Furo options
5252
html_theme_options = {
5353
"top_of_page_button": "edit",
54-
"source_repository": "https://github.com/InsightSoftwareConsortium/itk-wasm/",
54+
"source_repository": "https://github.com/InsightSoftwareConsortium/ITK-Wasm/",
5555
"source_branch": "main",
5656
"source_directory": "docs",
5757
}

docs/cxx/interface_types.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Interface Types
22

3-
itk-wasm execution pipelines support the following [interface types](https://github.com/InsightSoftwareConsortium/itk-wasm/tree/main/src/core/InterfaceTypes.ts):
3+
itk-wasm execution pipelines support the following [interface types](https://github.com/InsightSoftwareConsortium/ITK-Wasm/tree/main/src/core/InterfaceTypes.ts):
44

55
- [TextFile](../typescript/interface_types/TextFile)
66
- [BinaryFile](../typescript/interface_types/BinaryFile)
@@ -15,7 +15,7 @@ These interfaces types are supported in the [Emscripten interface](../typescript
1515

1616
---
1717

18-
The following [CLI11](https://github.com/CLIUtils/CLI11) [`itk::wasm::Pipeline`](https://github.com/InsightSoftwareConsortium/itk-wasm/tree/main/include/itkPipeline.h) components can be included in a C++ to ingest and produce these interface types. For `Input` types, use `Get()` to get the corresponding C++ object value after `ITK_WASM_PARSE_ARGS` is called. For `Output` types, use `Set(value)` to output the value before `main` exits. For example,
18+
The following [CLI11](https://github.com/CLIUtils/CLI11) [`itk::wasm::Pipeline`](https://github.com/InsightSoftwareConsortium/ITK-Wasm/tree/main/include/itkPipeline.h) components can be included in a C++ to ingest and produce these interface types. For `Input` types, use `Get()` to get the corresponding C++ object value after `ITK_WASM_PARSE_ARGS` is called. For `Output` types, use `Set(value)` to output the value before `main` exits. For example,
1919

2020
```cpp
2121
#include "itkPipeline.h"

docs/cxx/tutorial/debugging.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ int main() {
2424
}
2525
```
2626

27-
[The example](https://github.com/InsightSoftwareConsortium/itk-wasm/tree/main/examples/debugging) provides npm scripts as a convenient way to execute debugging commands that you may also invoke directly in a command line shell.
27+
[The example](https://github.com/InsightSoftwareConsortium/ITK-Wasm/tree/main/examples/debugging) provides npm scripts as a convenient way to execute debugging commands that you may also invoke directly in a command line shell.
2828

2929
To run these examples, first [install and test](./hello_world) Podman or Docker and Node/NPM. Then, install the package dependencies and run the example commands.
3030

docs/cxx/tutorial/hello_world.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ This example walks through how to compile a *hello world* executable written in
66

77
Before getting started, make sure [Node.js](https://nodejs.org/en/download/) and [Podman (recommended)](https://podman.io/docs/installation) or [Docker](https://docs.docker.com/install/) are installed. On Linux, make sure you can run [`podman` or `docker` without `sudo`](https://askubuntu.com/questions/477551/how-can-i-use-docker-without-sudo). On Windows, we highly recommend [Podman](https://podman.io/docs/installation).
88

9-
While we recommend following along step-by-step, the complete example can also be found in the [`examples/` directory of the project repository](https://github.com/InsightSoftwareConsortium/itk-wasm/tree/main/examples/hello-world).
9+
While we recommend following along step-by-step, the complete example can also be found in the [`examples/` directory of the project repository](https://github.com/InsightSoftwareConsortium/ITK-Wasm/tree/main/examples/hello-world).
1010

1111
Let's get started! 🚀
1212

docs/development/hacking_itk_wasm.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ cmake -BITK-build -SITK -DBUILD_TESTING=OFF -DModule_MeshToPolyData=ON
4545
cmake --build ITK-build
4646

4747
# Build the WebAssemblyInterface module from this module against ITK
48-
git clone https://github.com/InsightSoftwareConsortium/itk-wasm
48+
git clone https://github.com/InsightSoftwareConsortium/ITK-Wasm
4949
cmake -Bitk-wasm-build -Sitk-wasm -DBUILD_TESTING=ON -DITK_DIR=$PWD/ITK-build
5050
cmake --build itk-wasm-build
5151

@@ -108,7 +108,7 @@ Development requires:
108108
To build and test the CLI,
109109

110110
```sh
111-
git clone https://github.com/InsightSoftwareConsortium/itk-wasm
111+
git clone https://github.com/InsightSoftwareConsortium/ITK-Wasm
112112
cd itk-wasm/packages/core/typescript/itk-wasm
113113
pnpm install
114114
pnpm build
@@ -128,7 +128,7 @@ The development of `itk-wasm` is described above in the Command line interface s
128128
To develop the `itkwasm` Python package, which configured with [hatch](https://hatch.pypa.io/latest/):
129129

130130
```sh
131-
git clone https://github.com/InsightSoftwareConsortium/itk-wasm
131+
git clone https://github.com/InsightSoftwareConsortium/ITK-Wasm
132132
cd itk-wasm/packages/core/python/itkwasm
133133

134134
pip install hatch
@@ -236,7 +236,7 @@ and rebuild whenever the documentation changes.
236236
[C++ compiler toolchain]: https://docs.itk.org/en/latest/supported_compilers.html
237237
[CMake]: https://cmake.org
238238
[conventional commit]: https://www.conventionalcommits.org/en/v1.0.0/#summary
239-
[current repository and branch]: https://github.com/InsightSoftwareConsortium/itk-wasm/blob/main/src/docker/itk-wasm-base/Dockerfile#L39-L41
239+
[current repository and branch]: https://github.com/InsightSoftwareConsortium/ITK-Wasm/blob/main/src/docker/itk-wasm-base/Dockerfile#L39-L41
240240
[data.kitware.com]: https://data.kitware.com/
241241
[FileBase]: https://filebase.com/
242242
[hatch]: https://hatch.pypa.io/latest/

docs/development/itk_js_to_itk_wasm_migration_guide.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -82,7 +82,7 @@ The io packages are:
8282
2. `@itk-wasm/mesh-io`
8383
3. `@itk-wasm/dicom`
8484

85-
An example that vendors these package's webassembly assets into an application for deployment can be found in the [Vite-based test applcation configuration](https://github.com/InsightSoftwareConsortium/itk-wasm/blob/main/packages/mesh-io/typescript/vite.config.js).
85+
An example that vendors these package's webassembly assets into an application for deployment can be found in the [Vite-based test applcation configuration](https://github.com/InsightSoftwareConsortium/ITK-Wasm/blob/main/packages/mesh-io/typescript/vite.config.js).
8686

8787
### DICOM image IO functions
8888

0 commit comments

Comments
 (0)