Skip to content

Commit

Permalink
Update README.md (#23)
Browse files Browse the repository at this point in the history
* Update README.md

update links to video of MINI2P 2023

* Readme typos

* Incorrect list indicies
* Incorrect pdf links
* Incorrectly inlined video

---------

Co-authored-by: Simon Ball <48679510+simon-ball@users.noreply.github.com>
  • Loading branch information
marinesrj and simon-ball authored Aug 3, 2023
1 parent 4534f66 commit 4218136
Showing 1 changed file with 10 additions and 10 deletions.
20 changes: 10 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,25 +20,28 @@ MINI2P_toolbox includes the codes, softwares, 3D models, protocols, and etc. for
[Protocols overview](https://github.com/kavli-ntnu/MINI2P_toolbox/blob/main/Protocols/Protocols%20Overview%20.pdf) including video-tutorial links.
[Contact Information](https://github.com/kavli-ntnu/MINI2P_toolbox/blob/main/Protocols/Company%20contact%20information.pdf) for custom-made products.

a) [P1–Shopping and Machining list](https://github.com/kavli-ntnu/MINI2P_toolbox/blob/main/Protocols/P1%20-%20Shopping%20%20Machining%20List%20.pdf). This document lists each essential component with the supplier, the product name, the model (or item reference) and its approximate price in Euro. 2D Drawings and 3D models of most components are available [here](https://github.com/kavli-ntnu/MINI2P_toolbox/tree/main/Hardware) .
a) [P1–Shopping and Machining list](https://github.com/kavli-ntnu/MINI2P_toolbox/blob/main/Protocols/P1%20-%20Shopping%20Machining%20List%202023%20.pdf). This document lists each essential component with the supplier, the product name, the model (or item reference) and its approximate price in Euro. 2D Drawings and 3D models of most components are available [here](https://github.com/kavli-ntnu/MINI2P_toolbox/tree/main/Hardware) .

b) [P2-System building protocol](https://github.com/kavli-ntnu/MINI2P_toolbox/blob/main/Protocols/P2%20-%20System%20building%20protocol%20.pdf). This protocol includes all steps to assemble a MINI2P system. Each Protocol starts with a short-list of main reagents and tools needed, followed by an overview schematic of the module, and a table with the main products.
b) [P2-System building protocol](https://github.com/kavli-ntnu/MINI2P_toolbox/blob/main/Protocols/P2%20-%20System%20building%20protocol%202023%20.pdf). This protocol includes all steps to assemble a MINI2P system. Each Protocol starts with a short-list of main reagents and tools needed, followed by an overview schematic of the module, and a table with the main products.
HC-920 assembly building and laser coupling video tutorial can be found on the [link](https://www.youtube.com/watch?v=HjAtoPbDu8E).

[![HC-920 Fiber Assembly & Integration tutorial video](http://img.youtube.com/vi/vo_EgYPYI24/2.jpg)](https://www.youtube.com/watch?v=vo_EgYPYI24&list=PLonWNO9SywvJXpIgQEp6jQMSh_jrn_jPU&index=4&t=457s)

c) [P3–Miniscope assembly protocol](https://github.com/kavli-ntnu/MINI2P_toolbox/blob/main/Protocols/P3%20-%20Miniscope%20assembly%20protocol%20.pdf). How to assemble a MINI2P 2022 microscope is described. [MINI2P 2022 assembly tutorial](https://youtu.be/2B0UnX2e5S8)
[![Assembly tutorial video](http://img.youtube.com/vi/2B0UnX2e5S8/2.jpg)](http://www.youtube.com/watch?v=2B0UnX2e5S8 "Assembly tutorial video")
c) [P3–MINI2P 2023 miniscope assembly protocol](https://github.com/kavli-ntnu/MINI2P_toolbox/blob/main/Protocols/P3%20-%20MINI2P%202023%20assembly%20protocol%20.pdf). How to assemble a MINI2P 2022 microscope is described.

d) [GFB Assembly Protocol](https://github.com/kavli-ntnu/MINI2P_toolbox/blob/main/Protocols/GFB%20Assembly%20Protocol%20.pdf). This document describes the protocol for assembling the GRIN-end fiber bundle (GFB), which replaces the tapered fiber bundle (TFB) as the main fiber collecting and relaying the emission signal to the detection module. [GFB assembly video](https://youtu.be/XaWfBdRKIho)
[![Assembly tutorial video](http://img.youtube.com/vi/wqhDkIUZHgM/1.jpg)](https://www.youtube.com/watch?v=wqhDkIUZHgM&list=PLonWNO9SywvJXpIgQEp6jQMSh_jrn_jPU&index=2&t=10s](https://youtu.be/wqhDkIUZHgM))

d) [System operate instruction](https://github.com/kavli-ntnu/MINI2P_toolbox/blob/main/Protocols/P4%20-%20System%20operate%20instruction%20.pdf). This document describes the protocol for installation, laser calibration and start imaging.

e) [GFB Assembly Protocol](https://github.com/kavli-ntnu/MINI2P_toolbox/blob/main/Protocols/GFB%20Assembly%20Protocol%20.pdf). This document describes the protocol for assembling the GRIN-end fiber bundle (GFB), which replaces the tapered fiber bundle (TFB) as the main fiber collecting and relaying the emission signal to the detection module. [GFB assembly video](https://youtu.be/XaWfBdRKIho)

[![GFB video-tutorial](http://img.youtube.com/vi/XaWfBdRKIho/1.jpg)](https://www.youtube.com/watch?v=XaWfBdRKIho&list=PLonWNO9SywvJXpIgQEp6jQMSh_jrn_jPU&index=1&t=191s)

e) [MEMS wires and mirror protocol](https://github.com/kavli-ntnu/MINI2P_toolbox/blob/main/Protocols/MEMS%20wires%20and%20mirror%20protocol%20.pdf). How to assemble MEMS wires and solder MEMS flex cable. [MEMS flex cable soldering](https://youtu.be/ghV1DY1aKAA)
f) [MEMS wires and mirror protocol](https://github.com/kavli-ntnu/MINI2P_toolbox/blob/main/Protocols/MEMS%20wires%20and%20mirror%20protocol%20.pdf). How to assemble MEMS wires and solder MEMS flex cable. [MEMS flex cable soldering](https://youtu.be/ghV1DY1aKAA)

[![MEMS mirror flex cable video tutorial](http://img.youtube.com/vi/ghV1DY1aKAA/1.jpg)](https://www.youtube.com/watch?v=ghV1DY1aKAA&list=PLonWNO9SywvJXpIgQEp6jQMSh_jrn_jPU)

f) These and other video-tutorials can be found on link:
g) These and other video-tutorials can be found on link:
[MINI2P video tutorial package](https://youtube.com/playlist?list=PLonWNO9SywvJXpIgQEp6jQMSh_jrn_jPU)

4) [Software](Software)
Expand Down Expand Up @@ -75,9 +78,6 @@ MINI2P_toolbox includes the codes, softwares, 3D models, protocols, and etc. for
More details in [Documents](https://github.com/kavli-ntnu/MINI2P_toolbox/blob/main/Documents/StitchingChecker.mlapp.md)
![image](Analysis/Applications/StitchingChecker/StitchingChecker%20operation_overview.gif)

d) [DistortionCleaner.mlapp](Analysis/Applications/DistortionCleaner): an application to eliminate the scanning distortion of MINI2P imaging, calibrate FOV and pixel size, and generate transform matrix. This program works similar to the ScanImage plugin “MINI2P distortion detecotion", but can work without installing Scanimage. Note that since the release of MINI2P SI Device in March, 2022, this function is not in use or maintenance any more. Users can still install and try it but we will not provide any support or bug-fix. More details in [Documents](Documents/DistortionCleaner.mlapp.md)
![image](https://user-images.githubusercontent.com/43905023/127650948-b8ef7cc8-8c40-49b2-b374-dba90cc2844a.png)

6) [Documents](Documents)

a) [Requirements](Documents/requirements.md): A list of the non-optical components necessary to build and use a MINI2P system, including licensed software requirements.
Expand Down

0 comments on commit 4218136

Please sign in to comment.