Rename pacakge to mritk

Author: finsberg

README.md

@@ -5,7 +5,7 @@
 ## Installation
 
 ```bash
-pip install mri-toolkit
+pip install mritk
 ```
 
 ## Documentation

docs/install.md

@@ -5,40 +5,40 @@
 You can install the package directly from pypi using pip:
 
 ```bash
-pip install mri-toolkit
+pip install mritk
 ```
 
 Note that it is recommended to use a virtual environment when installing the package, to avoid conflicts with other packages. You can create a virtual environment using `venv`:
 
 ```bash
 python3 -m venv venv
 source venv/bin/activate  # On Windows, use `venv\Scripts\activate`
-pip install mri-toolkit
+pip install mritk
 ```
 
 ## Installing extra dependencies
 
-Some features of `mri-toolkit` require additional dependencies. You can install these extra dependencies using pip with the appropriate extras syntax.
+Some features of `mritk` require additional dependencies. You can install these extra dependencies using pip with the appropriate extras syntax.
 
 * **The show command**: To use the `show` command for visualizing MRI data in the terminal, you need to install the `textual-image`, `pillow` and `matplotlib` packages. You can do this with the following command:
 
 ```bash
-pip install mri-toolkit[show]
+pip install mritk[show]
 ```
 
 * **The napari command**: To use the `napari` command for visualizing MRI data in the [Napari viewer](https://napari.org/), you need to install the `napari` package. You can do this with the following command:
 
 ```bash
-pip install mri-toolkit[napari]
+pip install mritk[napari]
 ```
 
 ## Development Installation
 
-If you want to contribute to the development of `mri-toolkit`, you can install the package in editable mode. This allows you to make changes to the source code and have them reflected immediately without needing to reinstall the package (see also the Contributing guide for more info).
+If you want to contribute to the development of `mritk`, you can install the package in editable mode. This allows you to make changes to the source code and have them reflected immediately without needing to reinstall the package (see also the Contributing guide for more info).
 
 ```bash
-git clone https://github.com/scientificcomputing/mri-toolkit.git
-cd mri-toolkit
+git clone https://github.com/scientificcomputing/mritk.git
+cd mritk
 python3 -m venv venv
 source venv/bin/activate  # On Windows, use `venv\Scripts\activate`
 pip install -e .
@@ -47,12 +47,12 @@ pip install -e .
 It is also possible the package directly from GitHub without cloning the repository:
 
 ```bash
-pip install git+https://github.com/scientificcomputing/mri-toolkit.git
+pip install git+https://github.com/scientificcomputing/mritk.git
 ```
 
 ## Installation with pipx
 If you intend to use the command line interface, you may want to install the package in an isolated environment using [`pipx`](https://pipx.pypa.io/latest/). You can do this with the following command:
 
 ```bash
-pipx install mri-toolkit
+pipx install mritk
 ```

docs/napari.md

@@ -5,6 +5,13 @@ The `napari` command opens the specified MRI file in the [Napari](https://napari
 
 :::{note}
 This command requires the optional `[napari]` dependencies and a desktop environment to display the GUI.
+
+You can install these with the following command:
+
+ ```bash
+ pip install mritk[napari]
+ ```
+
 :::
 
 ## Usage

docs/show.md

@@ -8,7 +8,7 @@
  This command requires the optional `[show]` dependencies, which include `textual-image`, `pillow` and `matplotlib`. You can install these with the following command:
 
  ```bash
- pip install mri-toolkit[show]
+ pip install mritk[show]
  ```
 
  :::

pyproject.toml

@@ -1,5 +1,5 @@
 [project]
-name = "mri-toolkit"
+name = "mritk"
 authors = [
     { name = "Jørgen Riseth", email = "jnriseth@gmail.com" },
     { name = "Henrik Finsberg", email = "henriknf@simula.no" },
@@ -51,7 +51,7 @@ docs = [
     "myst-parser",
     "sphinx-multitoc-numbering",
 ]
-all = ["mri-toolkit[extra,test,pypi,show,napari]"]
+all = ["mritk[extra,test,pypi,show,napari]"]
 
 
 [project.urls]

src/mritk/__init__.py

@@ -8,7 +8,7 @@
 from . import data, segmentation, statistics
 
 
-meta = metadata("mri-toolkit")
+meta = metadata("mritk")
 __version__ = meta["Version"]
 __author__ = meta["Author-email"]
 __license__ = meta["license-expression"]