aind-ibl-ephys-alignment-preprocessing 0.1.1__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (46) hide show
  1. aind_ibl_ephys_alignment_preprocessing-0.1.1/.copier-answers.yml +24 -0
  2. aind_ibl_ephys_alignment_preprocessing-0.1.1/.github/ISSUE_TEMPLATE/bug_report.md +38 -0
  3. aind_ibl_ephys_alignment_preprocessing-0.1.1/.github/ISSUE_TEMPLATE/feature_request.md +20 -0
  4. aind_ibl_ephys_alignment_preprocessing-0.1.1/.github/ISSUE_TEMPLATE/user-story.md +27 -0
  5. aind_ibl_ephys_alignment_preprocessing-0.1.1/.github/dependabot.yml +19 -0
  6. aind_ibl_ephys_alignment_preprocessing-0.1.1/.github/workflows/bump-call.yml +33 -0
  7. aind_ibl_ephys_alignment_preprocessing-0.1.1/.github/workflows/ci-call.yml +38 -0
  8. aind_ibl_ephys_alignment_preprocessing-0.1.1/.github/workflows/docs-ci.yml +18 -0
  9. aind_ibl_ephys_alignment_preprocessing-0.1.1/.github/workflows/publish-call.yml +25 -0
  10. aind_ibl_ephys_alignment_preprocessing-0.1.1/.gitignore +145 -0
  11. aind_ibl_ephys_alignment_preprocessing-0.1.1/.python-version +1 -0
  12. aind_ibl_ephys_alignment_preprocessing-0.1.1/.readthedocs.yaml +26 -0
  13. aind_ibl_ephys_alignment_preprocessing-0.1.1/CHANGELOG.md +18 -0
  14. aind_ibl_ephys_alignment_preprocessing-0.1.1/LICENSE +22 -0
  15. aind_ibl_ephys_alignment_preprocessing-0.1.1/PKG-INFO +87 -0
  16. aind_ibl_ephys_alignment_preprocessing-0.1.1/README.md +60 -0
  17. aind_ibl_ephys_alignment_preprocessing-0.1.1/docs/source/_static/dark-logo.svg +129 -0
  18. aind_ibl_ephys_alignment_preprocessing-0.1.1/docs/source/_static/favicon.ico +0 -0
  19. aind_ibl_ephys_alignment_preprocessing-0.1.1/docs/source/_static/light-logo.svg +128 -0
  20. aind_ibl_ephys_alignment_preprocessing-0.1.1/docs/source/api.rst +12 -0
  21. aind_ibl_ephys_alignment_preprocessing-0.1.1/docs/source/conf.py +97 -0
  22. aind_ibl_ephys_alignment_preprocessing-0.1.1/docs/source/index.md +39 -0
  23. aind_ibl_ephys_alignment_preprocessing-0.1.1/pyproject.toml +132 -0
  24. aind_ibl_ephys_alignment_preprocessing-0.1.1/scripts/run_linters_and_checks.sh +64 -0
  25. aind_ibl_ephys_alignment_preprocessing-0.1.1/src/aind_ibl_ephys_alignment_preprocessing/__init__.py +38 -0
  26. aind_ibl_ephys_alignment_preprocessing-0.1.1/src/aind_ibl_ephys_alignment_preprocessing/_async/__init__.py +1 -0
  27. aind_ibl_ephys_alignment_preprocessing-0.1.1/src/aind_ibl_ephys_alignment_preprocessing/_async/concurrency.py +220 -0
  28. aind_ibl_ephys_alignment_preprocessing-0.1.1/src/aind_ibl_ephys_alignment_preprocessing/_async/ephys.py +199 -0
  29. aind_ibl_ephys_alignment_preprocessing-0.1.1/src/aind_ibl_ephys_alignment_preprocessing/_async/histology.py +300 -0
  30. aind_ibl_ephys_alignment_preprocessing-0.1.1/src/aind_ibl_ephys_alignment_preprocessing/_async/pipeline.py +222 -0
  31. aind_ibl_ephys_alignment_preprocessing-0.1.1/src/aind_ibl_ephys_alignment_preprocessing/_async/probes.py +268 -0
  32. aind_ibl_ephys_alignment_preprocessing-0.1.1/src/aind_ibl_ephys_alignment_preprocessing/_constants.py +6 -0
  33. aind_ibl_ephys_alignment_preprocessing-0.1.1/src/aind_ibl_ephys_alignment_preprocessing/discovery.py +150 -0
  34. aind_ibl_ephys_alignment_preprocessing-0.1.1/src/aind_ibl_ephys_alignment_preprocessing/ephys.py +58 -0
  35. aind_ibl_ephys_alignment_preprocessing-0.1.1/src/aind_ibl_ephys_alignment_preprocessing/histology.py +328 -0
  36. aind_ibl_ephys_alignment_preprocessing-0.1.1/src/aind_ibl_ephys_alignment_preprocessing/manifest.py +272 -0
  37. aind_ibl_ephys_alignment_preprocessing-0.1.1/src/aind_ibl_ephys_alignment_preprocessing/pipeline.py +122 -0
  38. aind_ibl_ephys_alignment_preprocessing-0.1.1/src/aind_ibl_ephys_alignment_preprocessing/probes.py +163 -0
  39. aind_ibl_ephys_alignment_preprocessing-0.1.1/src/aind_ibl_ephys_alignment_preprocessing/py.typed +1 -0
  40. aind_ibl_ephys_alignment_preprocessing-0.1.1/src/aind_ibl_ephys_alignment_preprocessing/scripts/__init__.py +1 -0
  41. aind_ibl_ephys_alignment_preprocessing-0.1.1/src/aind_ibl_ephys_alignment_preprocessing/scripts/run.py +57 -0
  42. aind_ibl_ephys_alignment_preprocessing-0.1.1/src/aind_ibl_ephys_alignment_preprocessing/types.py +312 -0
  43. aind_ibl_ephys_alignment_preprocessing-0.1.1/src/aind_ibl_ephys_alignment_preprocessing/validation.py +678 -0
  44. aind_ibl_ephys_alignment_preprocessing-0.1.1/tests/__init__.py +1 -0
  45. aind_ibl_ephys_alignment_preprocessing-0.1.1/tests/test_example.py +166 -0
  46. aind_ibl_ephys_alignment_preprocessing-0.1.1/uv.lock +4316 -0
@@ -0,0 +1,24 @@
1
+ # Changes here will be overwritten by Copier; NEVER EDIT MANUALLY
2
+ _commit: 0.1.4
3
+ _src_path: /home/galen.lynch/Documents/Code/aind-python-copier-template
4
+ author_email: galen@galenlynch.com
5
+ author_fullname: Galen Lynch
6
+ current_year: '2026'
7
+ github_org: AllenNeuralDynamics
8
+ github_url: https://github.com/AllenNeuralDynamics/aind-ibl-ephys-alignment-preprocessing
9
+ include_cli: true
10
+ include_docs: true
11
+ include_notebooks: false
12
+ include_type_hints: true
13
+ institute_name: Allen Institute for Neural Dynamics
14
+ license: MIT
15
+ project_description: Library to prepare histology and ephys for the IBL ephys alignment
16
+ GUI
17
+ project_name: AIND IBL Ephys Alignment Preprocessing
18
+ project_slug: aind-ibl-ephys-alignment-preprocessing
19
+ publish_to_pypi: false
20
+ python_package_import_name: aind_ibl_ephys_alignment_preprocessing
21
+ python_version: '3.11'
22
+ target_python_version: '3.13'
23
+ workflow_source: AllenNeuralDynamics/galen-uv-workflows
24
+ workflow_version: v2
@@ -0,0 +1,38 @@
1
+ ---
2
+ name: Bug report
3
+ about: Create a report to help us improve
4
+ title: ''
5
+ labels: ''
6
+ assignees: ''
7
+
8
+ ---
9
+
10
+ **Describe the bug**
11
+ A clear and concise description of what the bug is.
12
+
13
+ **To Reproduce**
14
+ Steps to reproduce the behavior:
15
+ 1. Go to '...'
16
+ 2. Click on '....'
17
+ 3. Scroll down to '....'
18
+ 4. See error
19
+
20
+ **Expected behavior**
21
+ A clear and concise description of what you expected to happen.
22
+
23
+ **Screenshots**
24
+ If applicable, add screenshots to help explain your problem.
25
+
26
+ **Desktop (please complete the following information):**
27
+ - OS: [e.g. iOS]
28
+ - Browser [e.g. chrome, safari]
29
+ - Version [e.g. 22]
30
+
31
+ **Smartphone (please complete the following information):**
32
+ - Device: [e.g. iPhone6]
33
+ - OS: [e.g. iOS8.1]
34
+ - Browser [e.g. stock browser, safari]
35
+ - Version [e.g. 22]
36
+
37
+ **Additional context**
38
+ Add any other context about the problem here.
@@ -0,0 +1,20 @@
1
+ ---
2
+ name: Feature request
3
+ about: Suggest an idea for this project
4
+ title: ''
5
+ labels: ''
6
+ assignees: ''
7
+
8
+ ---
9
+
10
+ **Is your feature request related to a problem? Please describe.**
11
+ A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
12
+
13
+ **Describe the solution you'd like**
14
+ A clear and concise description of what you want to happen.
15
+
16
+ **Describe alternatives you've considered**
17
+ A clear and concise description of any alternative solutions or features you've considered.
18
+
19
+ **Additional context**
20
+ Add any other context or screenshots about the feature request here.
@@ -0,0 +1,27 @@
1
+ ---
2
+ name: User story
3
+ about: This template provides a basic structure for user story issues.
4
+ title: ''
5
+ labels: ''
6
+ assignees: ''
7
+
8
+ ---
9
+
10
+ # User story
11
+ As a ..., I want to ..., so I can ...
12
+
13
+ *Ideally, this is in the issue title, but if not, you can put it here. If so, delete this section.*
14
+
15
+ # Acceptance criteria
16
+ - [ ] This is something that can be verified to show that this user story is satisfied.
17
+
18
+ # Sprint Ready Checklist
19
+ - [ ] 1. Acceptance criteria defined
20
+ - [ ] 2. Team understands acceptance criteria
21
+ - [ ] 3. Team has defined solution / steps to satisfy acceptance criteria
22
+ - [ ] 4. Acceptance criteria is verifiable / testable
23
+ - [ ] 5. External / 3rd Party dependencies identified
24
+ - [ ] 6. Ticket is prioritized and sized
25
+
26
+ # Notes
27
+ *Add any helpful notes here.*
@@ -0,0 +1,19 @@
1
+ # To get started with Dependabot version updates, you'll need to specify which
2
+ # package ecosystems to update and where the package manifests are located.
3
+ # Please see the documentation for all configuration options:
4
+ # https://docs.github.com/code-security/dependabot/dependabot-version-updates/configuration-options-for-the-dependabot.yml-file
5
+
6
+ version: 2
7
+ updates:
8
+ # Enable version updates for GitHub Actions
9
+ - package-ecosystem: "github-actions"
10
+ # Workflow files stored in the default location of `.github/workflows`
11
+ # You don't need to specify `/.github/workflows` for `directory`. You can use `directory: "/"`.
12
+ directory: "/"
13
+ schedule:
14
+ interval: "weekly"
15
+ # Enable version updates for pip
16
+ - package-ecosystem: "pip"
17
+ directory: "/"
18
+ schedule:
19
+ interval: "weekly"
@@ -0,0 +1,33 @@
1
+ name: Bump Version
2
+
3
+ on:
4
+ workflow_run:
5
+ workflows: ["CI"]
6
+ branches: [ main ]
7
+ types: [ completed ]
8
+ workflow_dispatch:
9
+
10
+ permissions:
11
+ contents: write # needed to push commits/tags
12
+ id-token: write # needed if your reusable workflow exchanges OIDC tokens
13
+
14
+ concurrency:
15
+ group: bump-${{ github.workflow }}-${{ github.event.workflow_run.head_branch || github.ref }}
16
+ cancel-in-progress: true
17
+
18
+ jobs:
19
+ bump:
20
+ # Only run when:
21
+ # • a CI run just succeeded (and the head commit message doesn't start with 'bump:')
22
+ # • OR this is a manual dispatch
23
+ if: >
24
+ (github.event_name == 'workflow_run' &&
25
+ github.event.workflow_run.conclusion == 'success' &&
26
+ !startsWith(github.event.workflow_run.head_commit.message, 'bump:')) ||
27
+ (github.event_name == 'workflow_dispatch' &&
28
+ github.ref == 'refs/heads/main')
29
+ uses: AllenNeuralDynamics/galen-uv-workflows/.github/workflows/bump-version.yml@v2
30
+ with:
31
+ default-branch: main
32
+ secrets:
33
+ repo-token: ${{ secrets.SERVICE_TOKEN }}
@@ -0,0 +1,38 @@
1
+ name: CI
2
+
3
+ on:
4
+ workflow_dispatch:
5
+ push:
6
+ branches: [ main ]
7
+ pull_request:
8
+ branches: [ main ]
9
+ types: [opened, synchronize, reopened, ready_for_review]
10
+
11
+ permissions:
12
+ contents: read
13
+ pull-requests: read
14
+
15
+ concurrency:
16
+ group: ${{ github.workflow }}-${{ github.head_ref || github.ref }}
17
+ cancel-in-progress: true
18
+
19
+ jobs:
20
+ run-ci:
21
+ strategy:
22
+ matrix:
23
+ os: [ubuntu-latest]
24
+ python-version: ["3.11", "3.13"]
25
+
26
+ if: >
27
+ (github.event_name != 'pull_request' || github.event.pull_request.draft == false) &&
28
+ github.actor != 'github-actions[bot]' &&
29
+ !(github.event_name == 'push' && startsWith(github.event.head_commit.message, 'bump:'))
30
+
31
+ uses: AllenNeuralDynamics/galen-uv-workflows/.github/workflows/ci.yml@v2
32
+ with:
33
+ os: ${{ matrix.os }}
34
+ python-version: ${{ matrix.python-version }}
35
+ package-name: aind_ibl_ephys_alignment_preprocessing
36
+ run-mypy: true
37
+ secrets:
38
+ repo-token: ${{ secrets.GITHUB_TOKEN }}
@@ -0,0 +1,18 @@
1
+ name: docs (CI)
2
+
3
+ on:
4
+ pull_request:
5
+ branches: [ main ]
6
+ workflow_dispatch:
7
+
8
+ jobs:
9
+ docs:
10
+ uses: AllenNeuralDynamics/galen-uv-workflows/.github/workflows/_docs-ci-reusable.yml@v2
11
+ with:
12
+ python-version: '3.13'
13
+ install-extras: '--group docs'
14
+ docs-path: 'docs/source'
15
+ output-dir: 'docs/build/html'
16
+ fail-on-warnings: true
17
+ linkcheck: false # flip to true if you want it on PRs
18
+ run-apidoc: false # set true if you generate pages each build
@@ -0,0 +1,25 @@
1
+ name: "Release"
2
+
3
+ on:
4
+ push:
5
+ tags:
6
+ - 'v[0-9]*' # semver tags
7
+ workflow_dispatch:
8
+
9
+ permissions:
10
+ contents: write # create release + upload assets
11
+
12
+ concurrency:
13
+ group: release
14
+ cancel-in-progress: false # let releases finish
15
+
16
+ jobs:
17
+ run-release:
18
+ uses: AllenNeuralDynamics/galen-uv-workflows/.github/workflows/publish.yml@v2
19
+ with:
20
+ tag-name: ${{ github.ref_name }}
21
+ python-version: "3.13"
22
+ publish-to-pypi: true
23
+ secrets:
24
+ repo-token: ${{ secrets.GITHUB_TOKEN }}
25
+ pypi-token: ${{ secrets.AIND_PYPI_TOKEN }}
@@ -0,0 +1,145 @@
1
+ # Byte-compiled / optimized / DLL files
2
+ __pycache__/
3
+ *.py[cod]
4
+ *$py.class
5
+
6
+ # C extensions
7
+ *.so
8
+
9
+ # Distribution / packaging
10
+ .Python
11
+ build/
12
+ develop-eggs/
13
+ dist/
14
+ downloads/
15
+ eggs/
16
+ .eggs/
17
+ lib/
18
+ lib64/
19
+ parts/
20
+ sdist/
21
+ var/
22
+ wheels/
23
+ pip-wheel-metadata/
24
+ share/python-wheels/
25
+ *.egg-info/
26
+ .installed.cfg
27
+ *.egg
28
+ MANIFEST
29
+
30
+ # PyInstaller
31
+ # Usually these files are written by a python script from a template
32
+ # before PyInstaller builds the exe, so as to inject date/other infos into it.
33
+ *.manifest
34
+ *.spec
35
+
36
+ # Installer logs
37
+ pip-log.txt
38
+ pip-delete-this-directory.txt
39
+
40
+ # Unit test / coverage reports
41
+ htmlcov/
42
+ .tox/
43
+ .nox/
44
+ .coverage
45
+ .coverage.*
46
+ .cache
47
+ nosetests.xml
48
+ coverage.xml
49
+ *.cover
50
+ *.py,cover
51
+ .hypothesis/
52
+ .pytest_cache/
53
+
54
+ # Translations
55
+ *.mo
56
+ *.pot
57
+
58
+ # Django stuff:
59
+ *.log
60
+ local_settings.py
61
+ db.sqlite3
62
+ db.sqlite3-journal
63
+
64
+ # Flask stuff:
65
+ instance/
66
+ .webassets-cache
67
+
68
+ # Scrapy stuff:
69
+ .scrapy
70
+
71
+ # Sphinx documentation
72
+ docs/build/
73
+
74
+ # PyBuilder
75
+ target/
76
+
77
+ # Jupyter Notebook
78
+ .ipynb_checkpoints
79
+
80
+ # IPython
81
+ profile_default/
82
+ ipython_config.py
83
+
84
+ # pyenv
85
+ # .python-version
86
+
87
+ # pipenv
88
+ # According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
89
+ # However, in case of collaboration, if having platform-specific dependencies or dependencies
90
+ # having no cross-platform support, pipenv may install dependencies that don't work, or not
91
+ # install all needed dependencies.
92
+ #Pipfile.lock
93
+
94
+ # PEP 582; used by e.g. github.com/David-OConnor/pyflow
95
+ __pypackages__/
96
+
97
+ # Celery stuff
98
+ celerybeat-schedule
99
+ celerybeat.pid
100
+
101
+ # SageMath parsed files
102
+ *.sage.py
103
+
104
+ # Environments
105
+ .env
106
+ .venv
107
+ env/
108
+ venv/
109
+ ENV/
110
+ env.bak/
111
+ venv.bak/
112
+
113
+ # Spyder project settings
114
+ .spyderproject
115
+ .spyproject
116
+
117
+ # Rope project settings
118
+ .ropeproject
119
+
120
+ # mkdocs documentation
121
+ /site
122
+
123
+ # mypy
124
+ .mypy_cache/
125
+ .dmypy.json
126
+ dmypy.json
127
+
128
+ # Pyre type checker
129
+ .pyre/
130
+
131
+ # PyCharm
132
+ # JetBrains specific template is maintained in a separate JetBrains.gitignore that can
133
+ # be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
134
+ # and can be added to the global gitignore or merged into this file. For a more nuclear
135
+ # option (not recommended) you can uncomment the following to ignore the entire idea folder.
136
+ .idea/
137
+
138
+ # MacOs
139
+ **/.DS_Store
140
+
141
+ # VSCode
142
+ .vscode/
143
+
144
+ # Claude
145
+ .claude/
@@ -0,0 +1,26 @@
1
+ # .readthedocs.yaml
2
+ version: 2
3
+
4
+ # RTD will run `sphinx-build` for you using this conf.py
5
+ sphinx:
6
+ configuration: docs/source/conf.py
7
+
8
+ build:
9
+ os: ubuntu-24.04
10
+ tools:
11
+ python: "3.13"
12
+
13
+ jobs:
14
+ # Install uv once at the OS level, before creating the venv
15
+ pre_create_environment:
16
+ - asdf plugin add uv
17
+ - asdf install uv latest
18
+ - asdf global uv latest
19
+
20
+ # Create the RTD virtualenv using uv so RTD will use it for the build
21
+ create_environment:
22
+ - uv venv "$READTHEDOCS_VIRTUALENV_PATH"
23
+
24
+ # Install your docs deps from pyproject (respects uv.lock if present)
25
+ install:
26
+ - UV_PROJECT_ENVIRONMENT="$READTHEDOCS_VIRTUALENV_PATH" uv sync --frozen --group docs
@@ -0,0 +1,18 @@
1
+ # Changelog
2
+
3
+ All notable changes to this project will be documented in this file.
4
+
5
+ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
6
+ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
7
+
8
+ ## v0.1.1 (2026-03-24)
9
+
10
+ ### Fix
11
+
12
+ - publish to pypi, use published aind-ephys-ibl-gui-conversion
13
+
14
+ ## v0.1.0 (2026-03-23)
15
+
16
+ ### Fix
17
+
18
+ - Add Manifest (#1)
@@ -0,0 +1,22 @@
1
+ MIT License
2
+
3
+ Copyright (c) 2026 Allen Institute for Neural Dynamics
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in all
13
+ copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ SOFTWARE.
22
+
@@ -0,0 +1,87 @@
1
+ Metadata-Version: 2.4
2
+ Name: aind-ibl-ephys-alignment-preprocessing
3
+ Version: 0.1.1
4
+ Summary: Library to prepare histology and ephys for the IBL ephys alignment GUI
5
+ Project-URL: Repository, https://github.com/AllenNeuralDynamics/aind-ibl-ephys-alignment-preprocessing/
6
+ Project-URL: Issues, https://github.com/AllenNeuralDynamics/aind-ibl-ephys-alignment-preprocessing/issues
7
+ Project-URL: Changelog, https://github.com/AllenNeuralDynamics/aind-ibl-ephys-alignment-preprocessing/blob/main/CHANGELOG.md
8
+ Author: Allen Institute for Neural Dynamics
9
+ Author-email: Galen Lynch <galen@galenlynch.com>
10
+ License-Expression: MIT
11
+ License-File: LICENSE
12
+ Classifier: Programming Language :: Python :: 3
13
+ Requires-Python: >=3.11
14
+ Requires-Dist: aind-anatomical-utils>=0.4
15
+ Requires-Dist: aind-ephys-ibl-gui-conversion>=0.2
16
+ Requires-Dist: aind-registration-utils>=0.4
17
+ Requires-Dist: aind-s3-cache>=0.1
18
+ Requires-Dist: aind-zarr-utils>=0.11.2
19
+ Requires-Dist: antspyx>=0.3.0
20
+ Requires-Dist: filelock
21
+ Requires-Dist: iblatlas>=0.4.0
22
+ Requires-Dist: numpy>=1.21.0
23
+ Requires-Dist: pandas>=1.3.0
24
+ Requires-Dist: pydantic>=2
25
+ Requires-Dist: simpleitk
26
+ Description-Content-Type: text/markdown
27
+
28
+ # AIND IBL Ephys Alignment Preprocessing
29
+
30
+ ![CI](https://github.com/AllenNeuralDynamics/aind-ibl-ephys-alignment-preprocessing/actions/workflows/ci-call.yml/badge.svg)
31
+ [![PyPI - Version](https://img.shields.io/pypi/v/aind-ibl-ephys-alignment-preprocessing)](https://pypi.org/project/aind-ibl-ephys-alignment-preprocessing/)
32
+ [![semantic-release: angular](https://img.shields.io/badge/semantic--release-angular-e10079?logo=semantic-release)](https://github.com/semantic-release/semantic-release)
33
+ [![License](https://img.shields.io/badge/license-MIT-brightgreen)](LICENSE)
34
+ [![ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)
35
+ [![uv](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/uv/main/assets/badge/v0.json)](https://github.com/astral-sh/uv)
36
+ [![Copier](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/copier-org/copier/master/img/badge/badge-grayscale-inverted-border.json)](https://github.com/copier-org/copier)
37
+ Library to prepare histology and ephys for the IBL ephys alignment GUI
38
+
39
+ ## Installation
40
+
41
+ If you choose to clone the repository, you can install the package by running the following command from the root directory of the repository:
42
+
43
+ ```bash
44
+ pip install .
45
+ ```
46
+
47
+ Otherwise, you can use pip:
48
+
49
+ ```bash
50
+ pip install aind-ibl-ephys-alignment-preprocessing
51
+ ```
52
+
53
+
54
+
55
+ To develop the code, run:
56
+ ```bash
57
+ uv sync
58
+ ```
59
+
60
+ ## Development
61
+
62
+ Please test your changes using the full linting and testing suite:
63
+
64
+ ```bash
65
+ ./scripts/run_linters_and_checks.sh -c
66
+ ```
67
+
68
+ Or run individual commands:
69
+ ```bash
70
+ uv run --frozen ruff format # Code formatting
71
+ uv run --frozen ruff check # Linting
72
+ uv run --frozen mypy # Type checking
73
+ uv run --frozen interrogate -v # Documentation coverage
74
+ uv run --frozen codespell --check-filenames # Spell checking
75
+ uv run --frozen pytest --cov aind_ibl_ephys_alignment_preprocessing # Tests with coverage
76
+ ```
77
+
78
+
79
+ ### Documentation
80
+ ```bash
81
+ sphinx-build -b html docs/source/ docs/build/html
82
+ ```
83
+
84
+
85
+ ## License
86
+
87
+ This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
@@ -0,0 +1,60 @@
1
+ # AIND IBL Ephys Alignment Preprocessing
2
+
3
+ ![CI](https://github.com/AllenNeuralDynamics/aind-ibl-ephys-alignment-preprocessing/actions/workflows/ci-call.yml/badge.svg)
4
+ [![PyPI - Version](https://img.shields.io/pypi/v/aind-ibl-ephys-alignment-preprocessing)](https://pypi.org/project/aind-ibl-ephys-alignment-preprocessing/)
5
+ [![semantic-release: angular](https://img.shields.io/badge/semantic--release-angular-e10079?logo=semantic-release)](https://github.com/semantic-release/semantic-release)
6
+ [![License](https://img.shields.io/badge/license-MIT-brightgreen)](LICENSE)
7
+ [![ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)
8
+ [![uv](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/uv/main/assets/badge/v0.json)](https://github.com/astral-sh/uv)
9
+ [![Copier](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/copier-org/copier/master/img/badge/badge-grayscale-inverted-border.json)](https://github.com/copier-org/copier)
10
+ Library to prepare histology and ephys for the IBL ephys alignment GUI
11
+
12
+ ## Installation
13
+
14
+ If you choose to clone the repository, you can install the package by running the following command from the root directory of the repository:
15
+
16
+ ```bash
17
+ pip install .
18
+ ```
19
+
20
+ Otherwise, you can use pip:
21
+
22
+ ```bash
23
+ pip install aind-ibl-ephys-alignment-preprocessing
24
+ ```
25
+
26
+
27
+
28
+ To develop the code, run:
29
+ ```bash
30
+ uv sync
31
+ ```
32
+
33
+ ## Development
34
+
35
+ Please test your changes using the full linting and testing suite:
36
+
37
+ ```bash
38
+ ./scripts/run_linters_and_checks.sh -c
39
+ ```
40
+
41
+ Or run individual commands:
42
+ ```bash
43
+ uv run --frozen ruff format # Code formatting
44
+ uv run --frozen ruff check # Linting
45
+ uv run --frozen mypy # Type checking
46
+ uv run --frozen interrogate -v # Documentation coverage
47
+ uv run --frozen codespell --check-filenames # Spell checking
48
+ uv run --frozen pytest --cov aind_ibl_ephys_alignment_preprocessing # Tests with coverage
49
+ ```
50
+
51
+
52
+ ### Documentation
53
+ ```bash
54
+ sphinx-build -b html docs/source/ docs/build/html
55
+ ```
56
+
57
+
58
+ ## License
59
+
60
+ This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.