Skip to content

Commit 57a03e6

Browse files
committed
Merge branch 'spikesorting-populator-v1' of https://github.com/LorenFrankLab/spyglass into spikesorting-populator-v1
2 parents 2362489 + 47d98b2 commit 57a03e6

File tree

15 files changed

+704
-441
lines changed

15 files changed

+704
-441
lines changed

.github/codecov.yml

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
coverage:
2+
status:
3+
project:
4+
default:
5+
target: 68%
6+
patch:
7+
default:
8+
enabled: false

.github/pull_request_template.md

Lines changed: 8 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -14,13 +14,12 @@ This PR.
1414
# Checklist:
1515

1616
<!--
17-
For items below with choices, select one (e.g., yes, no)
18-
and check the box to indicate that a choice was selected.
19-
If not applicable, check the box and add `N/A` after the box.
17+
For items below with `if`, please mark those that do not apply with N/A
18+
2019
For example:
21-
- [X] This has a choice: no
22-
- [X] N/A. If choice, other item.
23-
This comment may be deleted on submission.
20+
- [X] N/A. If this PR X, related item.
21+
- [X] If this PR Y, other item.
22+
- [X] I have updated the `CHANGELOG.md` ...
2423
2524
Alter notes example:
2625
```python
@@ -29,10 +28,8 @@ Table.alter() # Comment regarding the change
2928
```
3029
-->
3130

32-
- [ ] This PR should be accompanied by a release: (yes/no/unsure)
33-
- [ ] If release, I have updated the `CITATION.cff`
34-
- [ ] This PR makes edits to table definitions: (yes/no)
35-
- [ ] If table edits, I have included an `alter` snippet for release notes.
31+
- [ ] If this PR should be accompanied by a release, I have updated the `CITATION.cff`
32+
- [ ] If this PR edits table definitions, I have included an `alter` snippet for release notes.
3633
- [ ] If this PR makes changes to position, I ran the relevant tests locally.
34+
- [ ] If this PR makes user-facing changes, I have added/edited docs/notebooks to reflect the changes
3735
- [ ] I have updated the `CHANGELOG.md` with PR number and description.
38-
- [ ] I have added/edited docs/notebooks to reflect the changes

.github/workflows/lint.yml

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,10 @@
11
name: Lint
2+
permissions:
3+
contents: read
24

35
on:
46
push:
5-
branches:
7+
branches:
68
- '!documentation'
79
pull_request:
810

CHANGELOG.md

Lines changed: 23 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
# Change Log
22

3-
<!--
4-
## [0.5.6] (Unreleased) - WHEN UNCOMMENTING, ADD LINK AT BOTTOM
3+
## [0.5.6] (Unreleased)
54

65
### Release Notes
76

@@ -12,15 +11,32 @@ When altering tables, import all foreign key references.
1211
#
1312
```
1413

14+
### Documentation
15+
16+
- Delete extra pyscripts that were renamed # 1363
17+
- Add note on fetching changes to setup notebook #1371
18+
1519
### Infrastructure
1620

17-
- Thing
21+
- Set default codecov threshold for test fail, disable patch check #1370, #1372
22+
- Simplify PR template #1370
1823

19-
### Pipelines
24+
### Behavior
2025

21-
- Common
22-
- Thing
23-
-->
26+
- Add methods for calling moseq visualization functions #1374
27+
28+
### Decoding
29+
30+
- Ensure results directory is created if it doesn't exist #1362
31+
32+
### Position
33+
34+
- Ensure video files are properly added to `DLCProject` #1367
35+
- DLC parameter handling improvements and default value corrections #1379
36+
37+
### Spikesorting
38+
39+
- Implement short-transaction `SpikeSortingRecording.make` for v0 #1338
2440

2541
## [0.5.5] (Aug 6, 2025)
2642

notebooks/00_Setup.ipynb

Lines changed: 17 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -245,7 +245,23 @@
245245
"`pip install spyglass-neuro`, but downloading from GitHub will also download\n",
246246
"other files, like this tutorial.\n",
247247
"2. Developers who wish to work on the code base may want to do an editable\n",
248-
"install from within their conda environment: `pip install -e /path/to/spyglass/`\n"
248+
"install from within their conda environment: `pip install -e /path/to/spyglass/`\n",
249+
"\n",
250+
"### Staying up to date \n",
251+
"\n",
252+
"To get the latest updates and bugfixes between releases, you should occasionally\n",
253+
"navigate to your spyglass directory and run ...\n",
254+
"\n",
255+
"```bash\n",
256+
"cd /your/project/directory/spyglass/\n",
257+
"git pull # update files from GitHub\n",
258+
"pip install . -U # update install from this directory\n",
259+
"```\n",
260+
"\n",
261+
"Adding `--no-deps` to this last install command will skip over dependency checks,\n",
262+
"for a faster first pass.\n",
263+
"\n",
264+
"If you encounter issues, please try updating first."
249265
]
250266
},
251267
{

notebooks/60_MoSeq.ipynb

Lines changed: 415 additions & 362 deletions
Large diffs are not rendered by default.

notebooks/py_scripts/00_Setup.py

Lines changed: 16 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
# extension: .py
66
# format_name: light
77
# format_version: '1.5'
8-
# jupytext_version: 1.16.7
8+
# jupytext_version: 1.14.5
99
# kernelspec:
1010
# display_name: spyglass
1111
# language: python
@@ -223,6 +223,21 @@
223223
# 2. Developers who wish to work on the code base may want to do an editable
224224
# install from within their conda environment: `pip install -e /path/to/spyglass/`
225225
#
226+
# ### Staying up to date
227+
#
228+
# To get the latest updates and bugfixes between releases, you should occasionally
229+
# navigate to your spyglass directory and run ...
230+
#
231+
# ```bash
232+
# # cd /your/project/directory/spyglass/
233+
# git pull # update files from GitHub
234+
# pip install . -U # update install from this directory
235+
# ```
236+
#
237+
# Adding `--no-deps` to this last install command will skip over dependency checks,
238+
# for a faster first pass.
239+
#
240+
# If you encounter issues, please try updating first.
226241

227242
# ### Optional Dependencies
228243
#

0 commit comments

Comments
 (0)