Skip to content

Commit

Permalink
README: add version 1.0.0 warning
Browse files Browse the repository at this point in the history
  • Loading branch information
schlegelp committed Nov 11, 2021
1 parent 281a8d3 commit c1d4e77
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 2 deletions.
5 changes: 4 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,15 @@

<img src="https://github.com/navis-org/navis/raw/master/docs/_static/favicon.png" height="60">


NAVis is a Python 3 (3.7 or later) library for **N**euron **A**nalysis and **Vis**ualization.

## Documentation
NAVis is on [ReadTheDocs](http://navis.readthedocs.io/ "NAVis ReadTheDocs").

Version `1.0.0` comes with some breaking changes! Please check out the
[changelog](https://navis.readthedocs.io/en/latest/source/whats_new.html) for a
list of relevant changes.

## Features
* work in Jupyter or terminal
* support for various neuron types: **skeletons**, **meshes**, **dotprops**, **voxels**
Expand Down
4 changes: 3 additions & 1 deletion docs/source/whats_new.rst
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,8 @@ repository.
-
* - dev
- In development
* - 1.0.0
- 11/11/21
- - :class:`~navis.NeuronList`:
- :meth:`~navis.NeuronList.apply` now allows omitting failures (see ``omit_failures`` parameter)
- :class:`~navis.VoxelNeuron`:
Expand Down Expand Up @@ -56,7 +58,7 @@ repository.
- new `k3d <https://k3d-jupyter.org>`_ backend for plotting in Jupyter environments: try ``navis.plot3d(x, backend='k3d')``
- new parameter for :func:`~navis.plot2d` and :func:`~navis.plot3d`: use ``clusters=[0, 0, 0, 1, 1, ...]`` to assigns
clusters and have them automatically coloured accordingly
- :func:`~navis.plot2d` now allows ``radius=True`` parameter
- :func:`~navis.plot2d` now allows ``radius=True`` parameter
- renamed functions to make it clear they are only for ``TreeNeurons``:
- ``smooth_neuron`` -> :func:`~navis.smooth_skeleton`
- ``reroot_neuron`` -> :func:`~navis.reroot_skeleton`
Expand Down

0 comments on commit c1d4e77

Please sign in to comment.