|
15 | 15 | }, |
16 | 16 | { |
17 | 17 | "cell_type": "markdown", |
18 | | - "metadata": {}, |
| 18 | + "metadata": { |
| 19 | + "collapsed": true |
| 20 | + }, |
19 | 21 | "source": [ |
20 | 22 | "<h2>1. Installation</h2>\n", |
21 | | - "NeuroM is supported for Linux and OS X. Windows users are advised to use [VirtualBox](https://www.virtualbox.org/)\n", |
| 23 | + "[NeuroM](http://neurom.readthedocs.io/en/latest/index.html) is supported for Linux and OS X. Windows users are advised to use [VirtualBox](https://www.virtualbox.org/)\n", |
22 | 24 | "\n", |
23 | 25 | "It is assumed that the following packages are installed on your system:\n", |
24 | 26 | "\n", |
25 | | - "* Python 2.7\n", |
26 | | - "* numpy >= 1.8.0\n", |
27 | | - "* scipy >= 0.13.3\n", |
28 | | - "* h5py >= 2.2.1 (optional)\n", |
29 | | - "* matplotlib >= 1.3.1\n", |
| 27 | + "* Python >= 2.7\n", |
| 28 | + "* pip >= 8.1.0\n", |
30 | 29 | "* ipython\n", |
31 | | - "* pip\n", |
32 | 30 | "* virtualenv\n", |
33 | | - "* git\n", |
34 | 31 | "\n", |
35 | 32 | "These are available as packages in most Linux distributions. For OS X, please refer to [MacPorts](http://www.macports.org/) if you don’t already use a different package manager.\n", |
36 | 33 | "\n", |
| 34 | + "The following packages will be installed automatically with NeuroM if not pre-installed in your system.\n", |
| 35 | + "* numpy >= 1.8.0\n", |
| 36 | + "* scipy >= 0.17.0\n", |
| 37 | + "* h5py >= 2.2.1 (optional)\n", |
| 38 | + "* matplotlib >= 1.3.1\n", |
| 39 | + "* pyyaml >= 3.10\n", |
| 40 | + "\n", |
| 41 | + "\n", |
37 | 42 | "<h3> 1.1 Virtualenv set-up </h3>\n", |
38 | 43 | "\n", |
39 | 44 | "<code>\n", |
|
63 | 68 | "\n", |
64 | 69 | "<h3>2.1 Check the validity of a morphology file </h3>\n", |
65 | 70 | "\n", |
66 | | - "The application \"morph_check\" allows you to apply semantic checks to a morphology file before loading it into NeuroM.\n", |
| 71 | + "The application [morph_check](http://neurom.readthedocs.io/en/latest/morph_check.html) allows you to apply semantic checks to a morphology file before loading it into NeuroM.\n", |
67 | 72 | "\n", |
68 | 73 | "<code>\n", |
69 | | - "(nrm)$ morph_check -h # shows help for the script to check a morphology\n", |
| 74 | + "(nrm)$ morph_check -h # shows help for morphology checking script\n", |
70 | 75 | "</code>\n", |
71 | 76 | "\n", |
72 | 77 | "Try it yourself! You can go to [NeuroMorpho](http://neuromorpho.org) to download a neuronal morphology and perform the semantic checks.\n", |
73 | 78 | "\n", |
74 | 79 | "<code>\n", |
75 | | - "(nrm)$ morph_check path/to/file/filename\n", |
| 80 | + "(nrm)$ morph_check path/to/files/filename\n", |
76 | 81 | "<code>\n", |
77 | 82 | "\n", |
78 | 83 | "<h3>2.2 Extract basic morphometrics of a sample morphology </h3>\n", |
79 | 84 | "\n", |
80 | | - "Let's start by running an example of basic measurement extraction:\n", |
| 85 | + "The application [morph_stats](http://neurom.readthedocs.io/en/latest/morph_stats.html) extracts various morphometrics for one or many morphologies.\n", |
| 86 | + "Its contents can be easily configured via a configuration file, as shown in the [online documentation](http://neurom.readthedocs.io/en/latest/morph_stats.html)\n", |
81 | 87 | "\n", |
82 | 88 | "<code>\n", |
83 | | - "(nrm)$ cd NeuroM\n", |
84 | | - "(nrm)$ ./examples/get_features.py\n", |
| 89 | + "(nrm)$ morph_stats -h # shows help for the morphometrics extraction script\n", |
| 90 | + "(nrm)$ morph_stats path/to/files/filename # analyze single morphology file\n", |
| 91 | + "(nrm)$ morph_stats path/to/files # analyze many morphology files\n", |
85 | 92 | "</code>\n", |
86 | 93 | "\n", |
87 | 94 | "<h3>2.3 Basic morphometrics with the neurom and neurom.viewer modules</h3>\n", |
|
0 commit comments