Skip to content

Commit

Permalink
Update examples to new atlasapi name and version (#32)
Browse files Browse the repository at this point in the history
  • Loading branch information
willGraham01 authored Feb 26, 2024
1 parent 80aa8d6 commit 0141feb
Show file tree
Hide file tree
Showing 4 changed files with 24 additions and 26 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -141,7 +141,7 @@ coordinates = bgh.get_plane_coordinates(
## Using `brainglobe-heatmap` with other atlases.

`brainglobe-heatmap` uses `brainrender` which, in turn, uses brainglobe's `Atlas API` under the hood. That means that all of `brainglobe-heatmap`'s functionality is compatible with any of the atlases supported by the atlas API. `bgh.heatmap`, `bgh.planner` and `bgh.get_plane_coordinates` all accept a `atlas_name` argument, pass the name of the atlas name you'd like to use!
For more information see the API's [documentation](https://brainglobe.info/documentation/bg-atlasapi/index.html).
For more information see the API's [documentation](https://brainglobe.info/documentation/brainglobe-atlasapi/index.html).

## Contributing
Contributions to `brainglobe-heatmap` are more than welcome. Please see the [Developer's guide](https://github.com/brainglobe/.github/blob/main/CONTRIBUTING.md).
Expand Down
2 changes: 1 addition & 1 deletion examples/cellfinder_cell_density.py
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
"""

import pandas as pd
from bg_atlasapi.bg_atlas import BrainGlobeAtlas
from brainglobe_atlasapi.bg_atlas import BrainGlobeAtlas
from brainrender._io import load_mesh_from_file

import brainglobe_heatmap as bgh
Expand Down
2 changes: 1 addition & 1 deletion examples/slicer_2D.py
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
"""

import matplotlib.patheffects as path_effects
from bg_atlasapi import BrainGlobeAtlas
from brainglobe_atlasapi import BrainGlobeAtlas
from matplotlib import pyplot as plt

import brainglobe_heatmap as bgh
Expand Down
44 changes: 21 additions & 23 deletions pyproject.toml
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
[project]
name = "brainglobe-heatmap"
authors = [{name = "Federico Claudi", email= "[email protected]"}]
authors = [{ name = "Federico Claudi", email = "[email protected]" }]
description = "Rendering anatomical heatmaps with brainrender and matplotlib"
readme = "README.md"
requires-python = ">=3.9.0"
dynamic = ["version"]

dependencies = ["brainrender", "matplotlib", "numpy", "myterial", "rich"]

license = {text = "MIT"}
license = { text = "MIT" }

classifiers = [
"Development Status :: 2 - Pre-Alpha",
Expand All @@ -30,24 +30,20 @@ classifiers = [

[project.optional-dependencies]
dev = [
"pytest",
"pytest-cov",
"coverage",
"tox",
"black",
"mypy",
"pre-commit",
"ruff",
"setuptools_scm",
"pytest",
"pytest-cov",
"coverage",
"tox",
"black",
"mypy",
"pre-commit",
"ruff",
"setuptools_scm",
]


[build-system]
requires = [
"setuptools>=45",
"wheel",
"setuptools_scm[toml]>=6.2",
]
requires = ["setuptools>=45", "wheel", "setuptools_scm[toml]>=6.2"]
build-backend = "setuptools.build_meta"

[tool.setuptools]
Expand All @@ -69,19 +65,21 @@ line-length = 79

[tool.check-manifest]
ignore = [
".yaml",
"tox.ini",
"tests/",
"tests/test_unit/",
"tests/test_integration/",
".yaml",
"tox.ini",
"tests/",
"tests/test_unit/",
"tests/test_integration/",
]

[tool.ruff]
line-length = 79
exclude = ["__init__.py","build",".eggs"]
select = ["I", "E", "F"]
exclude = ["__init__.py", "build", ".eggs"]
fix = true

[tool.ruff.lint]
select = ["I", "E", "F"]

[tool.tox]
legacy_tox_ini = """
[tox]
Expand Down

0 comments on commit 0141feb

Please sign in to comment.