From bc45aabe1476959acc46bc17f6df7c45ab075882 Mon Sep 17 00:00:00 2001 From: William Silversmith Date: Tue, 20 Feb 2024 19:47:19 -0500 Subject: [PATCH] docs: add installation instructions --- README.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/README.md b/README.md index 8b84c9b..2304d42 100644 --- a/README.md +++ b/README.md @@ -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.