@niivue/niivue 0.23.0 → 0.24.1

package/README.md

@@ -8,6 +8,14 @@ The NiiVue package is intented to be used by individuals developing interactive
 
 [click here to go to the docs web page](https://niivue.github.io/niivue/devdocs/)
 
+### Install NiiVue using npm
+
+Installs without the bloat of the development dependencies or testing frameworks
+
+```
+npm install --only=prod @niivue/niivue
+```
+
 # Active Projects
 
 [See our active projects here](https://github.com/orgs/niivue/projects)
@@ -38,7 +46,7 @@ We host many NiiVue examples via github pages. These are updated and deployed au
 
 ## existing html page
 ```html
-<script src="https://unpkg.com/@niivue/niivue@0.23.0/dist/niivue.umd.js"></script>
+<script src="https://unpkg.com/@niivue/niivue@0.24.0/dist/niivue.umd.js"></script>
 
 <canvas id="gl" height=480 width=640></canvas>
 
@@ -47,11 +55,6 @@ We host many NiiVue examples via github pages. These are updated and deployed au
     // first object in array is background image
       {
         url: "./some_image.nii.gz",
-        volume: {hdr: null, img: null},
-        name: "some_image",
-        colorMap: "gray",
-        opacity: 1,
-        visible: true,
       }
    ]
 
@@ -84,10 +87,6 @@ export default {
       volumeList: [
         {
           url: "./mni152.nii.gz",
-          volume: {hdr: null, img: null},
-          colorMap: "gray",
-          opacity: 1,
-          visible: true,
         }
       ]
 
@@ -125,10 +124,6 @@ const NiiVue = ({ imageUrl }) => {
     const volumeList = [
       {
         url: imageUrl,
-        volume: { hdr: null, img: null },
-        colorMap: 'gray',
-        opacity: 1,
-        visible: true,
       },
     ]
     const nv = new Niivue()
@@ -168,10 +163,6 @@ export class NiivueViewComponent implements OnInit {
     const volumeList = [
     {
       url,
-      volume: { hdr: null, img: null },
-      colorMap: 'gray',
-      opacity: 1,
-      visible: true,
     },
   ]
     const niivue = new Niivue();
@@ -185,7 +176,7 @@ export class NiivueViewComponent implements OnInit {
 # Core Libraries
 
 - [shader.js source](https://github.com/Twinklebear/webgl-util)
-- [GIFTI-Reader-JS source](https://github.com/rii-mango/GIFTI-Reader-JS)
+- [Daikon](https://github.com/rii-mango/Daikon)
 - [NIFTI-Reader-JS source](https://github.com/rii-mango/NIFTI-Reader-JS)
 - [glMatrix](https://glmatrix.net/)
 
@@ -199,9 +190,9 @@ export class NiivueViewComponent implements OnInit {
 NiiVue can open several formats popular with brain imaging:
 
  - Voxel-based formats: [NIfTI](https://brainder.org/2012/09/23/the-nifti-file-format/), [NRRD](http://teem.sourceforge.net/nrrd/format.html), [MRtrix MIF](https://mrtrix.readthedocs.io/en/latest/getting_started/image_data.html#mrtrix-image-formats), [AFNI HEAD/BRIK](https://afni.nimh.nih.gov/pub/dist/doc/program_help/README.attributes.html), [MGH/MGZ](https://surfer.nmr.mgh.harvard.edu/fswiki/FsTutorial/MghFormat), [ITK MHD](https://itk.org/Wiki/ITK/MetaIO/Documentation#Reading_a_Brick-of-Bytes_.28an_N-Dimensional_volume_in_a_single_file.29), [ECAT7](https://github.com/openneuropet/PET2BIDS/tree/28aae3fab22309047d36d867c624cd629c921ca6/ecat_validation/ecat_info).
- - Mesh-based formats: [GIfTI](https://www.nitrc.org/projects/gifti/), [BrainSuite DFS](http://brainsuite.org/formats/dfs/), [BrainVoyager SRF](https://support.brainvoyager.com/brainvoyager/automation-development/84-file-formats/344-users-guide-2-3-the-format-of-srf-files), [FreeSurfer](http://www.grahamwideman.com/gw/brain/fs/surfacefileformats.htm), [MZ3](https://github.com/neurolabusc/surf-ice/tree/master/mz3), [OFF](https://en.wikipedia.org/wiki/OFF_(file_format)), [Wavefront OBJ](https://brainder.org/tag/obj/), [STL](https://medium.com/3d-printing-stories/why-stl-format-is-bad-fea9ecf5e45), [Legacy VTK](https://vtk.org/wp-content/uploads/2015/04/file-formats.pdf).
- - Mesh overlay formats: GIfTI, MZ3, STC, FreeSurfer (CURV/ANNOT)
- - Tractography formats: [TCK](https://mrtrix.readthedocs.io/en/latest/getting_started/image_data.html#tracks-file-format-tck), [TRK](http://trackvis.org/docs/?subsect=fileformat), [TRX](https://github.com/frheault/tractography_file_format), VTK
+ - Mesh-based formats: [GIfTI](https://www.nitrc.org/projects/gifti/), [ASC](http://www.grahamwideman.com/gw/brain/fs/surfacefileformats.htm), [BrainSuite DFS](http://brainsuite.org/formats/dfs/), [PLY](https://en.wikipedia.org/wiki/PLY_(file_format)), [BrainNet NV](https://www.nitrc.org/projects/bnv/), [BrainVoyager SRF](https://support.brainvoyager.com/brainvoyager/automation-development/84-file-formats/344-users-guide-2-3-the-format-of-srf-files), [FreeSurfer](http://www.grahamwideman.com/gw/brain/fs/surfacefileformats.htm), [MZ3](https://github.com/neurolabusc/surf-ice/tree/master/mz3), [OFF](https://en.wikipedia.org/wiki/OFF_(file_format)), [Wavefront OBJ](https://brainder.org/tag/obj/), [STL](https://medium.com/3d-printing-stories/why-stl-format-is-bad-fea9ecf5e45), [Legacy VTK](https://vtk.org/wp-content/uploads/2015/04/file-formats.pdf), [X3D](https://3dprint.nih.gov/).
+ - Mesh overlay formats: [GIfTI](https://www.nitrc.org/projects/gifti/), [CIfTI-2](https://balsa.wustl.edu/about/fileTypes), [MZ3](https://github.com/neurolabusc/surf-ice/tree/master/mz3), [SMP](https://support.brainvoyager.com/brainvoyager/automation-development/84-file-formats/40-the-format-of-smp-files), STC, FreeSurfer (CURV/ANNOT)
+ - Tractography formats: [TCK](https://mrtrix.readthedocs.io/en/latest/getting_started/image_data.html#tracks-file-format-tck), [TRK](http://trackvis.org/docs/?subsect=fileformat), [TRX](https://github.com/frheault/tractography_file_format), VTK, AFNI .niml.tract
 
 # Alternatives