From c5c55564502c200f12eb5c81a9d3fff93ab00e52 Mon Sep 17 00:00:00 2001 From: Dan Birman Date: Sun, 10 Sep 2023 18:19:34 -0700 Subject: [PATCH] Adding planned tutorial page --- source/index.rst | 1 + source/urchin/installation_and_use.md | 44 +-------------------------- source/urchin/tutorial.md | 43 ++++++++++++++++++++++++++ 3 files changed, 45 insertions(+), 43 deletions(-) create mode 100644 source/urchin/tutorial.md diff --git a/source/index.rst b/source/index.rst index 8d4bc72..ab26383 100644 --- a/source/index.rst +++ b/source/index.rst @@ -45,6 +45,7 @@ Please see the individual projects for installation instructions and documentati :caption: Urchin urchin/installation_and_use + urchin/tutorial ibl/ibl_tools diff --git a/source/urchin/installation_and_use.md b/source/urchin/installation_and_use.md index 0349477..065f0eb 100644 --- a/source/urchin/installation_and_use.md +++ b/source/urchin/installation_and_use.md @@ -31,48 +31,6 @@ Calling `setup()` opens a web browser and links it to your Python client. Set the parameter `standalone = True` to connect to a standalone Desktop application. You'll need to manually copy the ID that Urchin displays to the Desktop renderer. -## Camera control - -Left click + drag along the Y axis to pitch the brain - -Left click + drag along the X axis to yaw the brain - -Hold shift while left clicking and dragging along the X axis to spin the brain - -Scroll to zoom - -Right click + drag to pan - -Hold [SHIFT] or [CTRL] while moving on any axis to increase or decrease the speed, respectively. - -You can use `urchin.camera.capture_image(filename)` to take screenshots. - -### Grids and Axes - -In orthographic camera mode these will look a bit weird, use the perspective camera. - -Press [G] to bring up a flat grid - -Press [A] to bring up a set of 3D axes (I know... they'll get better eventually) - -### Screenshot mode - -Press [S] to hide the settings menus - -## Settings - - - -When individual brain areas are loaded, e.g. by using `urchin.ccf.load_beryl()`, you can "explode" the brain using the slider option. Options allow you to explode just one side as well as set the default colors on one side of the brain. Additional "explode" axes can be added on request. - -The camera rotation button continuously increments the spin angle to rotate the camera around the current camera target. The speed is controlled by the slider. You can then capture videos using the windows screen capture features [WINDOWS + G]. - -## Rendering - -We're in full beta mode right now -- asking Dan to build you an example is probably the best way to get started. - -You can also browse the [Examples](https://github.com/dbirman/UnityNeuroscience/tree/main/Examples) and [API](file:///C:/proj/VBL/vbl-docs/docs/build/html/_autosummary/unityneuro.render.html#module-unityneuro.render) for inspiration. - ## Citing -If you use this to make figures for a publication you should cite this repo, email me (dbirman@uw.edu) and I can generate a DOI. +There is no citation for Urchin right now, we'll create one soon. diff --git a/source/urchin/tutorial.md b/source/urchin/tutorial.md new file mode 100644 index 0000000..6406687 --- /dev/null +++ b/source/urchin/tutorial.md @@ -0,0 +1,43 @@ +# Tutorial + +## Camera control + +Left click + drag along the Y axis to pitch the brain + +Left click + drag along the X axis to yaw the brain + +Hold shift while left clicking and dragging along the X axis to spin the brain + +Scroll to zoom + +Right click + drag to pan + +Hold [SHIFT] or [CTRL] while moving on any axis to increase or decrease the speed, respectively. + +You can use `urchin.camera.capture_image(filename)` to take screenshots. + +### Grids and Axes + +In orthographic camera mode these will look a bit weird, use the perspective camera. + +Press [G] to bring up a flat grid + +Press [A] to bring up a set of 3D axes (I know... they'll get better eventually) + +### Screenshot mode + +Press [S] to hide the settings menus + +## Settings + + + +When individual brain areas are loaded, e.g. by using `urchin.ccf.load_beryl()`, you can "explode" the brain using the slider option. Options allow you to explode just one side as well as set the default colors on one side of the brain. Additional "explode" axes can be added on request. + +The camera rotation button continuously increments the spin angle to rotate the camera around the current camera target. The speed is controlled by the slider. You can then capture videos using the windows screen capture features [WINDOWS + G]. + +## Rendering + +We're in full beta mode right now -- asking Dan to build you an example is probably the best way to get started. + +You can also browse the [Examples](https://github.com/dbirman/UnityNeuroscience/tree/main/Examples) and [API](file:///C:/proj/VBL/vbl-docs/docs/build/html/_autosummary/unityneuro.render.html#module-unityneuro.render) for inspiration. \ No newline at end of file