Skip to content
This repository was archived by the owner on Feb 26, 2025. It is now read-only.

Commit 04259cf

Browse files
authored
Merge pull request #518 from juanchopanza/notebook-tutorial-summit16
Update jupyter tutorial notebook.
2 parents 6e7af52 + 4ba9d1c commit 04259cf

File tree

1 file changed

+22
-15
lines changed

1 file changed

+22
-15
lines changed

ipynb/tutorial.ipynb

Lines changed: 22 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -15,25 +15,30 @@
1515
},
1616
{
1717
"cell_type": "markdown",
18-
"metadata": {},
18+
"metadata": {
19+
"collapsed": true
20+
},
1921
"source": [
2022
"<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",
2224
"\n",
2325
"It is assumed that the following packages are installed on your system:\n",
2426
"\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",
3029
"* ipython\n",
31-
"* pip\n",
3230
"* virtualenv\n",
33-
"* git\n",
3431
"\n",
3532
"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",
3633
"\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",
3742
"<h3> 1.1 Virtualenv set-up </h3>\n",
3843
"\n",
3944
"<code>\n",
@@ -63,25 +68,27 @@
6368
"\n",
6469
"<h3>2.1 Check the validity of a morphology file </h3>\n",
6570
"\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",
6772
"\n",
6873
"<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",
7075
"</code>\n",
7176
"\n",
7277
"Try it yourself! You can go to [NeuroMorpho](http://neuromorpho.org) to download a neuronal morphology and perform the semantic checks.\n",
7378
"\n",
7479
"<code>\n",
75-
"(nrm)$ morph_check path/to/file/filename\n",
80+
"(nrm)$ morph_check path/to/files/filename\n",
7681
"<code>\n",
7782
"\n",
7883
"<h3>2.2 Extract basic morphometrics of a sample morphology </h3>\n",
7984
"\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",
8187
"\n",
8288
"<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",
8592
"</code>\n",
8693
"\n",
8794
"<h3>2.3 Basic morphometrics with the neurom and neurom.viewer modules</h3>\n",

0 commit comments

Comments
 (0)