Skip to content

Commit

Permalink
update to v1.0
Browse files Browse the repository at this point in the history
  • Loading branch information
tsbinns committed Feb 4, 2023
1 parent e44226a commit 8232d85
Show file tree
Hide file tree
Showing 4 changed files with 14 additions and 10 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ Example screenshot of the plotting:
[See here for the list of requirements](requirements.txt).

## Use Example:
1. Install the package into the desired environment using pip `pip install -i https://test.pypi.org/simple/ mni-to-atlas`
1. Install the package into the desired environment using pip `pip install mni-to-atlas`
2. Import the `AtlasBrowser` class from `mni_to_atlas` into your workspace, e.g. `from mni_to_atlas import AtlasBrowser`
3. Create an instance of the `AtlasBrowser` class and specify an atlas to use, e.g. `atlas = AtlasBrowser("AAL3")`
4. Provide MNI coordinates to the `AtlasBrowser` object to find the corresponding atlas regions, e.g. `regions = atlas.find_regions(coordinates)`, where coordinates is an [n x 3] numpy ndarray, where each row contains an x-, y-, and z-axis MNI coordinate. The `regions` output is a list of strings containing the region names for each set of coordinates
Expand Down
12 changes: 8 additions & 4 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,9 @@ build-backend = "hatchling.build"

[project]
name = "mni_to_atlas"
version = "0.4"
version = "1.0.0"
authors = [
{ name="Thomas Samuel Binns", email="t.s.binns@outlook.com" },
{ name="Thomas Samuel Binns", email="t.s.binns@outlook.com" },
]
description = "A simple Python-based tool for finding brain atlas regions based on MNI coordinates."
readme = "README.md"
Expand All @@ -18,10 +18,14 @@ classifiers = [
]

dependencies = [
"nibabel",
"matplotlib"
"numpy >= 1.22",
"matplotlib >= 3.5",
"nibabel >= 3.2"
]

[project.optional-dependencies]
dev = ["pytest"]

[project.urls]
"Homepage" = "https://github.com/tsbinns/mni_to_atlas"
"Bug Tracker" = "https://github.com/tsbinns/mni_to_atlas/issues"
8 changes: 4 additions & 4 deletions requirements.txt
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
python>=3.9.7
numpy>=1.22.3
matplotlib>=3.5.1
nibabel>=3.2.2
python>=3.9
numpy>=1.22
matplotlib>=3.5
nibabel>=3.2
2 changes: 1 addition & 1 deletion src/mni_to_atlas/__init__.py
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
__version__ = "0.4"
__version__ = "1.0"

from .atlas_browser import AtlasBrowser

Expand Down

0 comments on commit 8232d85

Please sign in to comment.