Skip to content

Commit 5ef2f4d

Browse files
committed
TESTING.md: Add it
1 parent 5586abe commit 5ef2f4d

File tree

1 file changed

+29
-0
lines changed

1 file changed

+29
-0
lines changed

TESTING.md

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
# Testing
2+
3+
The tests in the `tests` folder use pytest and can be run locally as:
4+
5+
```
6+
SKIP_LIMS=true TEST_INHOUSE=false pytest
7+
```
8+
9+
This does not assume that you have access to AllenInstitute internal resources like LIMS or network shares.
10+
11+
## Strategy for adopting newer NWB schema versions
12+
13+
The upstream source of NWB files for ipfx is [MIES](https://github.com/AllenInstitute/MIES) and
14+
[IPNWB](https://github.com/AllenInstitute/IPNWB). We are at the moment using fixed versions of nwb-schema for
15+
IPNWB and pynwb for ipfx. This is done in order to reduce maintenance and friction between the two.
16+
17+
Steps for upgrading:
18+
19+
- Choose a pynwb/nwb-schema version you want to adopt
20+
- Raise pynwb version in `requirements.txt`
21+
- Check if all tests still pass. In the past this always required patching the latest
22+
pynwb version, bringing that patch upstream and waiting for a new release.
23+
- Fix pynwb deprecations where appropriate
24+
- Upgrade the nwb-schema version used in IPNWB as documented there
25+
- Re-export the files `Vip-IRES-Cre;Ai14(IVSCC)-226110.03.01.pxp` and
26+
`Vip-IRES-Cre;Ai14(IVSCC)-236654.04.02.pxp` using the IPNWB/MIES version with the new nwb-schema to NWBv2
27+
- Add the files to `tests/data` and extend `testdata` in `tests/test_run_feature_vector.py` with them
28+
- Check if the tests still pass
29+
- Propose a PR

0 commit comments

Comments
 (0)