Skip to content

Commit

Permalink
Adding planned tutorial page
Browse files Browse the repository at this point in the history
  • Loading branch information
dbirman committed Sep 11, 2023
1 parent 8063915 commit c5c5556
Show file tree
Hide file tree
Showing 3 changed files with 45 additions and 43 deletions.
1 change: 1 addition & 0 deletions source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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


Expand Down
44 changes: 1 addition & 43 deletions source/urchin/installation_and_use.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

<!-- In the application settings (which are open by default) you can "explode" the brain using the slider option. You can explode all areas, or just the cortex and hippocampus "vertically" sort of like a nested doll. You can also switch from exploding all areas to just the left side, as well as set the colors to the defaults on the right side of the brain. -->

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 ([email protected]) and I can generate a DOI.
There is no citation for Urchin right now, we'll create one soon.
43 changes: 43 additions & 0 deletions source/urchin/tutorial.md
Original file line number Diff line number Diff line change
@@ -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

<!-- In the application settings (which are open by default) you can "explode" the brain using the slider option. You can explode all areas, or just the cortex and hippocampus "vertically" sort of like a nested doll. You can also switch from exploding all areas to just the left side, as well as set the colors to the defaults on the right side of the brain. -->

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.

0 comments on commit c5c5556

Please sign in to comment.