Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Merge brainreg-napari into brainreg #145

Merged
merged 131 commits into from
Oct 27, 2023
Merged

Merge brainreg-napari into brainreg #145

merged 131 commits into from
Oct 27, 2023

Conversation

willGraham01
Copy link
Contributor

@willGraham01 willGraham01 commented Oct 27, 2023 •
edited
Loading

Merge brainreg-napari into brainreg

Summary

Merges the functionality of brainreg-napari into brainreg, and breaks the package into core and napari submodules.

  • History from the brainreg-napari repository has been deliberately preserved so that contributors are not lost.
  • Package metadata has been suitably updated to include contributors to both projects.
  • CI tests have also been combined into a single workflow.
  • READMEs are yet to be merged into a consistent file, this will be done in a separate PR. All other package meta-files are now consistent with the new structure.

In terms of changes from the old structure with two repositories and packages, there are should be no needs for major code overhauls.

  • Any user code / scripts that previously relied on (old) brainreg will now need to import brainreg.core as opposed to import brainreg.
  • In the event that any users were interacting with the napari-plugin package manually, that will need to change from import brainreg_napari to import brainreg.napari.
  • The plugin's internal name has also changed from brainreg-napari to brainreg, if any users have scripts that access the plugin itself programmatically.

Key files to review

This PR is quite large since it's a merge of two repositories.

Whoever is reviewing, the key files to review are the pyproject.toml (to check the metadata) and the LICENSE, and test_and_deploy workflows. It might also be worth pulling this branch and running the tests locally with tox as a sanity check.

stephenlenzi and others added 30 commits June 25, 2021 15:14
@stephenlenzi
initial commit
1e137cd
@stephenlenzi
adds gui
f3dc54f
@stephenlenzi
removes deprecated folder
c81ed70
@stephenlenzi
Update README.md
d974b5c
@stephenlenzi
Update README.md
7358eaa
@stephenlenzi
adds brainreg to requirements
f716404
@stephenlenzi
Merge branch 'master' of https://github.com/brainglobe/brainreg-napari
b1d247e
@stephenlenzi
renames gui label from register to brainreg
bd54181
@stephenlenzi
renames register to brainreg-register
46dfeee
@stephenlenzi
adds brainglobe repo to setup.py
e1d3dc7
@stephenlenzi
Delete requirements.txt
7ee1036
@stephenlenzi
makes output destination selectable in GUI
ae28db8
@stephenlenzi
Merge branch 'master' of https://github.com/brainglobe/brainreg-napari
46d2568
@adamltyson
Update entry point
4d6cfd6
@stephenlenzi
removes sort_input_file option
2f5bfb8
@adamltyson
Update setup.py
39fc3e7
@stephenlenzi
Merge branch 'master' of https://github.com/brainglobe/brainreg-napari
112d430
@stephenlenzi
updates project urls in setup.cfg
d1c8ce8
@adamltyson
Update support link
88ea564
@stephenlenzi
fixes output path to directory
3fa733f
@stephenlenzi
Merge branch 'master' of https://github.com/brainglobe/brainreg-napari
75c5b40
@stephenlenzi
re adds sort_input_file as hardcoded variable
9cc4a6f
@stephenlenzi
adds atlas options as dropdown
d8f70b4
@stephenlenzi
adds showing the results of registration
07c5ace
@stephenlenzi
removed a global declaration
0e056aa
@stephenlenzi
minor refactoring
9d536d0
@stephenlenzi
deleted commented code
f97ca69
@stephenlenzi
fixes logging output
3e9c2da
@stephenlenzi
only loads relevant output data
2b377b1
@stephenlenzi
outputs scaled overlay of boundaries and atlas
d52e471
pre-commit-ci bot and others added 22 commits August 17, 2023 16:05
@pre-commit-ci
[pre-commit.ci] pre-commit autoupdate (#67)
eae4e55 
updates:
- [github.com/astral-sh/ruff-pre-commit: v0.0.282 → v0.0.284](astral-sh/ruff-pre-commit@v0.0.282...v0.0.284)
- [github.com/pre-commit/mirrors-mypy: v1.4.1 → v1.5.0](pre-commit/mirrors-mypy@v1.4.1...v1.5.0)

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
@pre-commit-ci
[pre-commit.ci] pre-commit autoupdate (#68)
d6d24c2 
updates:
- [github.com/astral-sh/ruff-pre-commit: v0.0.284 → v0.0.285](astral-sh/ruff-pre-commit@v0.0.284...v0.0.285)
- [github.com/pre-commit/mirrors-mypy: v1.5.0 → v1.5.1](pre-commit/mirrors-mypy@v1.5.0...v1.5.1)

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
@pre-commit-ci
[pre-commit.ci] pre-commit autoupdate (#70)
a248303 
updates:
- [github.com/astral-sh/ruff-pre-commit: v0.0.285 → v0.0.286](astral-sh/ruff-pre-commit@v0.0.285...v0.0.286)

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
@adamltyson
Update .pre-commit-config.yaml (#71)
2979e7b
@pre-commit-ci
[pre-commit.ci] pre-commit autoupdate (#72)
d41e01d 
updates:
- [github.com/astral-sh/ruff-pre-commit: v0.0.286 → v0.0.287](astral-sh/ruff-pre-commit@v0.0.286...v0.0.287)

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
@pre-commit-ci
[pre-commit.ci] pre-commit autoupdate (#74)
2f6ff3e 
updates:
- [github.com/astral-sh/ruff-pre-commit: v0.0.287 → v0.0.292](astral-sh/ruff-pre-commit@v0.0.287...v0.0.292)
- [github.com/psf/black: 23.7.0 → 23.9.1](psf/black@23.7.0...23.9.1)

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
@dstansby @adamltyson
Test on Python 3.11 (#49)
989f47a 
* Use composite test action

Fix use-xvfb argument

* Clean tox.ini

* Don't fail fast

* Remove old setup steps

* Clean up dev dependencies

Add pyqt5 back as a dev dep

* Try passing display env

Put back passenv in tox

* Test on Python 3.11

* Update Python versions

---------

Co-authored-by: Adam Tyson <[email protected]>
@adamltyson
Delete .github/workflows/plugin_preview.yml (#75)
71f50d2
@willGraham01
Write safe concat function
06fa8fa
@willGraham01
Use safe concat of dataframes
2939283
@willGraham01
Fix logic of safe concat method
5551354
@willGraham01
pre-commit pass
1ca057b
@willGraham01
Add unit test to aplease codecov overlords
6744221
@willGraham01
Restructure as brainreg/core, adjust imports accordingly
0b84f79
@willGraham01
Make package installable again
b0005f0
@willGraham01
Fix test import
48b441f
@willGraham01
Rework package structure to be compatible with brainreg-core
09ba645
@willGraham01
Update example code with new structure
414689e
@willGraham01
Merge br-napari into br-core, resolve conflicts except for READMEs
e967d51
@willGraham01
Rename napari plugin to drop the -napari suffix
ed1f990
@willGraham01
Merge branch 'bgv1-dev-branch' into merge-in-br-napari
9294d02
@willGraham01
Exclude the to-be-reconciled READMEs from the manifest
0d2fd48
@willGraham01
Copy link
Contributor Author

CodeCov is naturally quite unhappy at merging in a whole repository's worth of history.

@willGraham01 willGraham01 requested a review from a team October 27, 2023 11:09
@willGraham01 willGraham01 self-assigned this Oct 27, 2023
@willGraham01 willGraham01 marked this pull request as ready for review October 27, 2023 11:14
alessandrofelder
alessandrofelder approved these changes Oct 27, 2023
View reviewed changes
Copy link
Member

@alessandrofelder alessandrofelder left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks a lot @willGraham01 - looks good to me

  • as you say, the codecov changes are expected due to the worse coverage in brainreg-napari
  • I've run a local sanity check running tox as requested ✅
  • Superficial manual sanity checks (opening plugins, running brainreg -h) also ✅

@alessandrofelder alessandrofelder merged commit 5add675 into bgv1-dev-branch Oct 27, 2023
13 of 15 checks passed
@alessandrofelder alessandrofelder deleted the merge-in-br-napari branch October 27, 2023 15:46
alessandrofelder added a commit that referenced this pull request Nov 6, 2023
@willGraham01 @stephenlenzi
@adamltyson @neuromusic @dstansby @paddyroddy @alessandrofelder @SimaoBolota-MetaCell @pre-commit-ci
Version 1 release 🥳 (#146)
e91a132 
* Merge `brainreg-napari` into `brainreg` (#145)

* initial commit

* adds gui

* removes deprecated folder

* Update README.md

* Update README.md

* adds brainreg to requirements

* renames gui label from register to brainreg

* renames register to brainreg-register

* adds brainglobe repo to setup.py

* Delete requirements.txt

* makes output destination selectable in GUI

* Update entry point

* removes sort_input_file option

* Update setup.py

* updates project urls in setup.cfg

* Update support link

* fixes output path to directory

* re adds sort_input_file as hardcoded variable

* adds atlas options as dropdown

* adds showing the results of registration

* removed a global declaration

* minor refactoring

* deleted commented code

* fixes logging output

* only loads relevant output data

* outputs scaled overlay of boundaries and atlas

* imports and groups segment plugin with register

* lowers requirements from python >=3.7 to >=3.6 and removes project url from setup.py

* removes superfluous pixel args from logging

* Update readme, setup.py & general reformatting (#16)

* update gitignore

* Update setup.py

* update readme

* format with black

* remove docs

* remove unused import

* delete tests for now

* format imports

* Release (#18)

* Update setup.py

* add bump2version config

* Bump version: 0.0.1 → 0.0.2-rc0

* remove reqs from manifest

* disable tests on GH actions for now

* fixes reset_defaults by ignoring atlas dropdown

* adds additional channels functionality

* Update OS compatibility & update use of napari API

* Bump (#23)

* Bump version: 0.0.2-rc1 → 0.0.2-rc2

* Bump version: 0.0.2-rc2 → 0.0.2-rc3

* Bump version: 0.0.2-rc3 → 0.0.3-rc0

* Add tooltips (#25)

* change default parameter names

* Add tooltips

* Bump version: 0.0.3-rc0 → 0.0.4-rc0

* Update README.md

* Update broken image URL

* Add categories and preview page workflow for the napari hub (#27)

* adds EDAM Bioimaging labels

* adds Action for napari hub preview service

* Update citation

* Update README.md

* Convert to npe2

* Add pyqt library setup

* Fix manifest

* Add basic smoke test

* Add link to contributing guide

* Add pre-commit

* Fix manifest

* Add sample data

* Add example script

* Fix pre-commit and manifest

* Use g-node.org for sample data

* Clean up example

Make noqa more specific

* Set plugin values from metadata

* Add a test for sample data

* Add pooch to requirements

Move pooch req comment

* Test loading sample data through napari

* Set sensible contrast limits

* pre-commit fixes

* Add Python 3.10 support, drop 3.7 support

* Add an integration test

Type block

* Fix getting additional layers

* Factor out add_image_layers function

* Remove arguments from run()

* Refactor blocking/non-blocking behaviour

* Store metadata in napari layers

* Use re-usable action for running tests

* Give better name to add_image_layers

* Add error if trying to load non-existent registration

* Return layers from add_registered_image_layers

* Bump version: 0.0.4-rc0 → 0.0.5-rc0

* Input orientation check (#44)

* Add many features:

- debug mode
- interactive way of checking input orientation
- brain geometry
- save annotations with original orientation

* add comments and docstring.

* Crop the reference atlas when using interactive orientation check with half brains.

* Fix a bug where run throw an error.

* Fix typo in docstrings

* format

* Add info to use if data not loaded before checking orientation

* Update docstrings

Co-authored-by: Jules Scholler <[email protected]>

* Update readme

* format readme

* Add codecov badge

* Added citation file (#45)

* Added citation file

* Changes according to PR comments

* Updated Citation file 

Updated citation file to have the preferred citation coming from the article/book when available

Co-authored-by: Simão sá <[email protected]>

* Update packaging (#46)

* update pre-commit config

* update args for new brainreg version

* lint

* update manifest

* Bump version: 0.0.5-rc0 → 0.0.5-rc1

* update testing

* update packaging

* update requirements

* update manifest

* move entry point to pyproject.toml

* update hub preview version

* update release for use with setuptools_scm

* migrate from BG to neuroinformatics actions

* add setuptools_scm to dev requirements

* reduce number of tested version

* update python versions tested

* update release

* [Napari HUB cli] Metadata enhancement suggestions (#47)

* Copy "Display Name" from secondary to primary file

Display Name was found in a secondary file and copied in the primary one:
* (found here)  "pyproject.toml"
* (copied here) "brainreg_napari/napari.yaml"

* Copy "Summary Sentence" from secondary to primary file

Summary Sentence was found in a secondary file and copied in the primary one:
* (found here)  "pyproject.toml"
* (copied here) ".napari/config.yml"

* Use standard pre-commit config (#51)

* Add standard pre-commit config

* Automated pre-commit fixes

* Testing clean (#50)

* Use composite test action

Fix use-xvfb argument

* Clean tox.ini

* Don't fail fast

* Remove old setup steps

* Clean up dev dependencies

Add pyqt5 back as a dev dep

* Try passing display env

Put back passenv in tox

* Use selected atlas to check orientation

* Add orientation check tests

* [pre-commit.ci] pre-commit autoupdate (#57)

updates:
- [github.com/charliermarsh/ruff-pre-commit: v0.0.240 → v0.0.272](astral-sh/ruff-pre-commit@v0.0.240...v0.0.272)
- [github.com/psf/black: 23.1.0 → 23.3.0](psf/black@23.1.0...23.3.0)
- [github.com/pre-commit/mirrors-mypy: v0.991 → v1.3.0](pre-commit/mirrors-mypy@v0.991...v1.3.0)

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>

* Update links (#56)

* Update README.md

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

---------

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>

* Update dependency (imlib -> brainglobe-utils) (#58)

* [pre-commit.ci] pre-commit autoupdate (#59)

updates:
- [github.com/charliermarsh/ruff-pre-commit: v0.0.272 → v0.0.275](astral-sh/ruff-pre-commit@v0.0.272...v0.0.275)
- [github.com/pre-commit/mirrors-mypy: v1.3.0 → v1.4.1](pre-commit/mirrors-mypy@v1.3.0...v1.4.1)

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>

* [pre-commit.ci] pre-commit autoupdate (#60)

updates:
- https://github.com/charliermarsh/ruff-pre-commit → https://github.com/astral-sh/ruff-pre-commit
- [github.com/astral-sh/ruff-pre-commit: v0.0.275 → v0.0.276](astral-sh/ruff-pre-commit@v0.0.275...v0.0.276)

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>

* [pre-commit.ci] pre-commit autoupdate (#61)

updates:
- [github.com/astral-sh/ruff-pre-commit: v0.0.276 → v0.0.277](astral-sh/ruff-pre-commit@v0.0.276...v0.0.277)

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>

* [pre-commit.ci] pre-commit autoupdate (#62)

updates:
- [github.com/astral-sh/ruff-pre-commit: v0.0.277 → v0.0.278](astral-sh/ruff-pre-commit@v0.0.277...v0.0.278)
- [github.com/psf/black: 23.3.0 → 23.7.0](psf/black@23.3.0...23.7.0)

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>

* [pre-commit.ci] pre-commit autoupdate (#63)

updates:
- [github.com/astral-sh/ruff-pre-commit: v0.0.278 → v0.0.280](astral-sh/ruff-pre-commit@v0.0.278...v0.0.280)

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>

* [pre-commit.ci] pre-commit autoupdate (#65)

updates:
- [github.com/astral-sh/ruff-pre-commit: v0.0.280 → v0.0.281](astral-sh/ruff-pre-commit@v0.0.280...v0.0.281)

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>

* [pre-commit.ci] pre-commit autoupdate (#66)

updates:
- [github.com/astral-sh/ruff-pre-commit: v0.0.281 → v0.0.282](astral-sh/ruff-pre-commit@v0.0.281...v0.0.282)

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>

* [pre-commit.ci] pre-commit autoupdate (#67)

updates:
- [github.com/astral-sh/ruff-pre-commit: v0.0.282 → v0.0.284](astral-sh/ruff-pre-commit@v0.0.282...v0.0.284)
- [github.com/pre-commit/mirrors-mypy: v1.4.1 → v1.5.0](pre-commit/mirrors-mypy@v1.4.1...v1.5.0)

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>

* [pre-commit.ci] pre-commit autoupdate (#68)

updates:
- [github.com/astral-sh/ruff-pre-commit: v0.0.284 → v0.0.285](astral-sh/ruff-pre-commit@v0.0.284...v0.0.285)
- [github.com/pre-commit/mirrors-mypy: v1.5.0 → v1.5.1](pre-commit/mirrors-mypy@v1.5.0...v1.5.1)

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>

* [pre-commit.ci] pre-commit autoupdate (#70)

updates:
- [github.com/astral-sh/ruff-pre-commit: v0.0.285 → v0.0.286](astral-sh/ruff-pre-commit@v0.0.285...v0.0.286)

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>

* Update .pre-commit-config.yaml (#71)

* [pre-commit.ci] pre-commit autoupdate (#72)

updates:
- [github.com/astral-sh/ruff-pre-commit: v0.0.286 → v0.0.287](astral-sh/ruff-pre-commit@v0.0.286...v0.0.287)

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>

* [pre-commit.ci] pre-commit autoupdate (#74)

updates:
- [github.com/astral-sh/ruff-pre-commit: v0.0.287 → v0.0.292](astral-sh/ruff-pre-commit@v0.0.287...v0.0.292)
- [github.com/psf/black: 23.7.0 → 23.9.1](psf/black@23.7.0...23.9.1)

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>

* Test on Python 3.11 (#49)

* Use composite test action

Fix use-xvfb argument

* Clean tox.ini

* Don't fail fast

* Remove old setup steps

* Clean up dev dependencies

Add pyqt5 back as a dev dep

* Try passing display env

Put back passenv in tox

* Test on Python 3.11

* Update Python versions

---------

Co-authored-by: Adam Tyson <[email protected]>

* Delete .github/workflows/plugin_preview.yml (#75)

* Write safe concat function

* Use safe concat of dataframes

* Fix logic of safe concat method

* pre-commit pass

* Add unit test to aplease codecov overlords

* Restructure as brainreg/core, adjust imports accordingly

* Make package installable again

* Fix test import

* Rework package structure to be compatible with brainreg-core

* Update example code with new structure

* Rename napari plugin to drop the -napari suffix

* Exclude the to-be-reconciled READMEs from the manifest

---------

Co-authored-by: stephen <[email protected]>
Co-authored-by: Adam Tyson <[email protected]>
Co-authored-by: Adam Tyson <[email protected]>
Co-authored-by: Justin Kiggins <[email protected]>
Co-authored-by: David Stansby <[email protected]>
Co-authored-by: Patrick Roddy <[email protected]>
Co-authored-by: Alessandro Felder <[email protected]>
Co-authored-by: Jules Scholler <[email protected]>
Co-authored-by: Simão Bolota <[email protected]>
Co-authored-by: Simão sá <[email protected]>
Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>

* Reconcile the `core` and `napari` READMEs (#147)

* Parse existing brainreg readme

* Incorporate plugin readme and update manifest

* Apply Adam's updates

Co-authored-by: Adam Tyson <[email protected]>

---------

Co-authored-by: Adam Tyson <[email protected]>

* Reconcile the `core` and `napari` READMEs (#147)

* Parse existing brainreg readme

* Incorporate plugin readme and update manifest

* Apply Adam's updates

Co-authored-by: Adam Tyson <[email protected]>

---------

Co-authored-by: Adam Tyson <[email protected]>

* Update README.md

* Update with brainreg-segment rename to brainglobe-segmentation (#149)

* Update with brainreg-segment rename to brainglobe-segmentation

* Update pyproject.toml

---------

Co-authored-by: stephen <[email protected]>
Co-authored-by: Adam Tyson <[email protected]>
Co-authored-by: Adam Tyson <[email protected]>
Co-authored-by: Justin Kiggins <[email protected]>
Co-authored-by: David Stansby <[email protected]>
Co-authored-by: Patrick Roddy <[email protected]>
Co-authored-by: Alessandro Felder <[email protected]>
Co-authored-by: Jules Scholler <[email protected]>
Co-authored-by: Simão Bolota <[email protected]>
Co-authored-by: Simão sá <[email protected]>
Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@alessandrofelder alessandrofelder alessandrofelder approved these changes

Assignees

@willGraham01 willGraham01

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
8 participants
@willGraham01 @alessandrofelder @stephenlenzi @adamltyson @neuromusic @dstansby @paddyroddy @SimaoBolota-MetaCell