Skip to content

Commit

Permalink
docs: update index and changelog
Browse files Browse the repository at this point in the history
  • Loading branch information
schlegelp committed Oct 17, 2024
1 parent 07b39b5 commit d6b3f01
Show file tree
Hide file tree
Showing 2 changed files with 34 additions and 1 deletion.
32 changes: 32 additions & 0 deletions docs/changelog.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,38 @@ pip uninstall navis -y
pip install git+https://github.com/navis-org/navis@master
```

## Version `1.9.0` { data-toc-label="1.9.0" }
_Date: 17/10/24_

This version brings a shiny new interface to the [H01 human cortex](https://h01-release.storage.googleapis.com/landing.html) dataset
and various other quality of life improvements.

##### Breaking
- The default for `radius` ([`navis.plot2d`][] and [`navis.plot3d`][]) was changed to `False` (from `"auto"`) to avoid running into issues
when visualizing large numbers of skeletons while using the defaults

##### Additions
- New interface to the [H01](https://h01-release.storage.googleapis.com/landing.html) dataset by Jinhan Choi and Jakob Troidl (Lichtman lab); see the new tutorial for details

##### Improvements
- I/O:
- [`read_nrrd`][navis.read_nrrd], [`read_tiff`][navis.read_tiff] and [`read_mesh`][navis.read_mesh] now use the same backend as e.g. [`read_swc`][navis.read_swc] which enables some niceties such as reading directly from URLs and archives, parallel processing, etc
- all `read_*` functions now have an `error` parameter that can be used to skip errors
- Image data:
- new function: [`navis.thin_voxels`][] can be used to thin images and `VoxelNeurons` to single-pixel width (see also below)
- new `thin` parameter for [`read_nrrd`][navis.read_nrrd], [`read_tiff`][navis.read_tiff]
- [`TreeNeurons`][navis.TreeNeuron]:
- skeletons can now be initialized from a `(vertices, edges)` tuple (see also [`navis.edges2neuron`])
- new property: `TreeNeuron.vertices` gives read-only to node (vertex) coordinates
- [`VoxelNeurons`][navis.VoxelNeuron]:
- New properties: `VoxelNeuron.nnz` and `VoxelNeuron.density`
- [`navis.drop_fluff`][] and [`navis.neuron2nx`][] now also works with [`Dotprops`][navis.Dotprops]

**Full Changelog**: [v1.8.0...v1.9.0](https://github.com/navis-org/navis/compare/v1.8.0...v1.9.0)

##### Experimental
- setting `navis.config.add_units=True` (default is `False`) will add units to certain neuron properties such as `.cable_length` to make them human-readable

## Version `1.8.0` { data-toc-label="1.8.0" }
_Date: 22/09/24_

Expand Down
3 changes: 2 additions & 1 deletion docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -90,7 +90,8 @@ morphology. It stands on the shoulders of the excellent

Load neurons straight from Allen's
[MICrONS](generated/gallery/4_remote/tutorial_remote_02_microns) datasets,
[neuromorpho](http://neuromorpho.org), [neuPrint](generated/gallery/4_remote/tutorial_remote_00_neuprint)
[neuromorpho](http://neuromorpho.org), [neuPrint](generated/gallery/4_remote/tutorial_remote_00_neuprint),
the [H01 dataset](generated/gallery/4_remote/tutorial_remote_04_h01)
or any NeuroGlancer source.

- :material-connection:{ .lg .middle } __Interfaces__
Expand Down

0 comments on commit d6b3f01

Please sign in to comment.