Skip to content

Commit

Permalink
docs: add installation instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
william-silversmith committed Feb 21, 2024
1 parent dff099d commit bc45aab
Showing 1 changed file with 8 additions and 0 deletions.
8 changes: 8 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,14 @@ image = xs3d.cross_section(
image2d = xs3d.slice(labels, vertex, normal, anisotropy)
```

# Installation

```
pip install xs3d
```

# Cross Section Calculation

When using skeletons (one dimensional stick figure representations) to create electrophysiological compartment simulations of neurons, some additional information is required for accuracy. The caliber of the neurite changes over the length of the cell.

Previously, the radius from the current skeleton vertex to the nearest background voxel was used, but this was often an underestimate as it is sensitive to noise and divots in a shape.
Expand Down

0 comments on commit bc45aab

Please sign in to comment.