Skip to content

Commit

Permalink
docs: add fastcore descriptions
Browse files Browse the repository at this point in the history
  • Loading branch information
schlegelp committed Jul 8, 2024
1 parent bd7f657 commit 4c79f31
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 1 deletion.
1 change: 1 addition & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@ NAVis is on [ReadTheDocs](http://navis.readthedocs.io/ "NAVis ReadTheDocs").
* **render**: use Blender 3D for high quality [visualizations](https://youtu.be/wl3sFG7WQJc)
* **R** neuron libraries: interfaces with [nat](https://github.com/jefferis/nat), [rcatmaid](https://github.com/jefferis/rcatmaid), [elmr](https://github.com/jefferis/elmr) and more
* **import-export**: read/write SWCs, neuroglancer's ["*precomputed*"](https://github.com/google/neuroglancer/tree/master/src/datasource/precomputed) format, NMX/NML, NRRD, mesh-files and more
* **fast**: uses functions compiled in Rust under-the-hood (see [fastcore](https://github.com/schlegelp/fastcore-rs))
* **scalable**: out-of-the-box support for multiprocessing
* **extensible**: build your own package on top of navis - see [pymaid](https://pymaid.readthedocs.io/en/latest/) for example

Expand Down
15 changes: 14 additions & 1 deletion docs/source/install.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
Install
=======

NAVis currently requires Python 3.8 or later. Below instructions assume that
NAVis currently requires Python 3.9 or later. Below instructions assume that
you have already installed Python and its package manager ``pip``.

.. topic:: By the way
Expand Down Expand Up @@ -67,6 +67,19 @@ These extras can be installed directly, or along with navis with
The user-facing extras, the dependencies they install,
and how to install those dependencies directly, are below.

.. _fastcore:

``fastcore``: `navis-fastcore <https://github.com/schlegelp/fastcore-rs>`_
``navis-fastcore`` re-implements a bunch of low-level functions in Rust
and wraps them in Python. ``navis`` will use ``fastcore`` under-the-hood
if it is available. This is a highly recommended extra as it will
speed up certain operations such as geodesic distances, Strahler Index
or pruning by several orders of magnitude.

::

pip3 install navis-fastcore


.. _pykd:

Expand Down

0 comments on commit 4c79f31

Please sign in to comment.