Metadata-Version: 2.1
Name: npc_shields
Version: 0.1.8
Summary: Tools for Neuropixels probe insertion: providing suggested targets, recording actual insertions, storing notes.
Author-email: bjhardcastle <ben.hardcastle@alleninstitute.org>
License: MIT
Project-URL: Repository, https://github.com/AllenInstitute/npc_shields
Project-URL: Issues, https://github.com/AllenInstitute/npc_shields/issues
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: Microsoft :: Windows
Classifier: Operating System :: POSIX :: Linux
Requires-Python: >=3.9
Description-Content-Type: text/markdown
Requires-Dist: ipywidgets>=7
Requires-Dist: npc-session>=0.1.30
Requires-Dist: pydantic>=2.7.1
Requires-Dist: eval-type-backport>=0.2.0

# npc_shields

[![PyPI](https://img.shields.io/pypi/v/npc-shields.svg?label=PyPI&color=blue)](https://pypi.org/project/npc-shields/)
[![Python version](https://img.shields.io/pypi/pyversions/npc-shields)](https://pypi.org/project/npc-shields/)

[![Coverage](https://img.shields.io/codecov/c/github/alleninstitute/npc_shields?logo=codecov)](https://app.codecov.io/github/AllenInstitute/npc_shields)
[![CI/CD](https://img.shields.io/github/actions/workflow/status/alleninstitute/npc_shields/publish.yml?label=CI/CD&logo=github)](https://github.com/alleninstitute/npc_shields/actions/workflows/publish.yml)
[![GitHub issues](https://img.shields.io/github/issues/alleninstitute/npc_shields?logo=github)](https://github.com/alleninstitute/npc_shields/issues)

Tools for Neuropixels probe insertion into SHIELD implants: providing suggested targets, recording actual insertions, storing notes.

## creating new implant drawings
### export 2D view of 3D model
- get a .sldpart CAD model from MPE
- open in Solidworks
- rotate the view to face the top of the implant, matching the view from the rig scope
- Save As -> .dxf
- check "current" view only

### edit 2D drawing for widget
- open a copy of one of the existing .svg drawings in Inkscape/Illustrator, to use the same page size and colors
- add the new .dxf file 
- if the lines are too thick to see any detail, change them to 1pt for now
- resize the new drawing to fill the page, like the existing drawing
- with the two drawings side by side, update the new drawing to match:
  - the outline is fragmented and needs to be joined together so a white fill can be applied
  - holes that have straight edges will need joining to be fill-able
  - circular holes should already be fill-able
  - check the CAD model for probe-letter designations (A1, A2, B1, ...)
- when finished, export as .svg
