diff --git a/docs/misc/development.md b/docs/misc/development.md index cdbe01d0..689e614f 100644 --- a/docs/misc/development.md +++ b/docs/misc/development.md @@ -1,5 +1,5 @@ # Developing SNAKE {#developing-snake} -## Developement environment {#developement-environment} +## Development environment {#developement-environment} We recommend to use a virtual environment, and install SNAKE-FMRI and its dependencies in it. diff --git a/docs/mrd-simulation.md b/docs/mrd-simulation.md index a1b8437a..33ed51b5 100644 --- a/docs/mrd-simulation.md +++ b/docs/mrd-simulation.md @@ -18,7 +18,7 @@ The SNAKE MRD file structure is as follows: - `header` group: contains the metadata for the file, as well as serialized information for the simulation. - `acquisition` group: contains the raw k-space data and the acquisition parameters. - - `images` group: contains the static informations for the simulation (phantom, coil sensitivity maps, etc.). + - `images` group: contains the static information for the simulation (phantom, coil sensitivity maps, etc.). - `waveforms` group: contains the dynamic information for the simulation (motion, physiological noise, etc.). diff --git a/examples/example_T2s_EPI.py b/examples/example_T2s_EPI.py index aeedc0bd..98bcf992 100644 --- a/examples/example_T2s_EPI.py +++ b/examples/example_T2s_EPI.py @@ -112,7 +112,7 @@ # This is available in the companion package ``snake.toolkit``. # # Loading the ``.mrd`` file to retrieve all information can be done using the -# ``ismrmd`` python package, but SNAKE provides convient dataloaders, which are +# ``ismrmd`` python package, but SNAKE provides convenient dataloaders, which are # more efficient, and take cares of managing underlying files access. As we are # showcasing the API, we will do things manually here, and use only core SNAKE. diff --git a/examples/example_anat_EPI.py b/examples/example_anat_EPI.py index f02c13c3..3a22342f 100644 --- a/examples/example_anat_EPI.py +++ b/examples/example_anat_EPI.py @@ -41,7 +41,7 @@ # # The simulation acquires # the data describe in a phantom. A phantom consists of fuzzy segmentation of -# head tissue, and their MR intrisic parameters +# head tissue, and their MR intrinsic parameters # (density, T1, T2, T2*, magnetic susceptibilities) # # Here we use Brainweb reference mask and values for convenience. @@ -124,7 +124,7 @@ # This is available in the companion package ``snake.toolkit``. # # Loading the ``.mrd`` file to retrieve all information can be done using the -# ``ismrmd`` python package, but SNAKE provides convient dataloaders, which are +# ``ismrmd`` python package, but SNAKE provides convenient dataloaders, which are # more efficient, and take cares of managing underlying files access. As we are # showcasing the API, we will do things manually here, and use only core SNAKE. diff --git a/examples/example_gpu_anat_spirals.py b/examples/example_gpu_anat_spirals.py index a727ab58..036589f9 100644 --- a/examples/example_gpu_anat_spirals.py +++ b/examples/example_gpu_anat_spirals.py @@ -160,7 +160,7 @@ # This is available in the companion package ``snake.toolkit``. # # Loading the ``.mrd`` file to retrieve all information can be done using the -# ``ismrmd`` python package, but SNAKE provides convient dataloaders, which are +# ``ismrmd`` python package, but SNAKE provides convenient dataloaders, which are # more efficient, and take cares of managing underlying files access. As we are # showcasing the API, we will do things manually here, and use only core SNAKE. diff --git a/pyproject.toml b/pyproject.toml index 1014d6cc..199e0a0d 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -141,3 +141,4 @@ exclude = ["examples/"] [tool.codespell] ignore-words-list = ["TE","fpr"] +skip = ["docs/generated", "*.ipynb"]