You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+14-14Lines changed: 14 additions & 14 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,4 +1,4 @@
1
-
# VSCoding-Sequence :dna::test_tube::microscope:
1
+
# VSCoding-Sequence 🧬 🧪 🔬
2
2
3
3
<imgsrc="img/logo.png"alt="drawing"width="200"/>
4
4
@@ -14,22 +14,22 @@
14
14
VSCoding Sequence allows for visualisation of protein structures and molecular data in the editor, courtesy of the fantastic [Mol*](https://molstar.org/)
### :inbox_tray: Loading a Protein Structure from the [PDB](https://www.rcsb.org/)
19
+
## 📦 Features
20
+
### 📥 Loading a Protein Structure from the [PDB](https://www.rcsb.org/)
21
21
22
22

23
23
24
24
Open the command palette (`⌘ + ⇧ + p`) and simply call the `Start Protein Viewer` command, enter a [PDB accession code](https://www.rcsb.org/) & away you go!
25
25
26
-
### :spiral_calendar: Loading Local File(s)
26
+
### 🗓️ Loading Local File(s)
27
27
28
28

29
29
30
30
Right-click on the file or selection of files in the file editor and select `Launch Protein Viewer from File(s)`
31
31
32
-
**:white_check_mark: Supported Formats**
32
+
**✅ Supported Formats**
33
33
34
34
*`.pdb`
35
35
*`.pdbqt`
@@ -41,14 +41,14 @@ Right-click on the file or selection of files in the file editor and select `Lau
41
41
*`.mol2`
42
42
*`.sdf`
43
43
44
-
### :open_file_folder: Loading a Local Folder
44
+
### 📂 Loading a Local Folder
45
45

46
46
47
47
Right-click on the folder in the file explorer and select `Launch Protein Viewer from Folder`
48
48
49
-
## :gear: Usage
49
+
## ⚙️ Usage
50
50
*The below is taken from the [Mol\* viewer docs](https://molstar.org/viewer-docs/) which is based on the [RCSB PDB mol* documentation](https://www.rcsb.org/3d-view/molstar/help/getting-started) thanks to the generosity of [RCSB PDB](https://www.rcsb.org/) and Dr. Shuchismita Dutta.*
**3D Canvas**: This is the space where a PDB structure is displayed for manipulation in three dimensions (3D). It is located on the left side of the screen.
@@ -79,7 +79,7 @@ Right-click on the folder in the file explorer and select `Launch Protein Viewer
79
79
80
80
**Log Panel**: This panel shows various logs containing information about actions taken while viewing the structure. This is located at the bottom of the screen below the 3D Canvas.
81
81
82
-
### :mouse: Mouse Controls
82
+
### 🐭 Mouse Controls
83
83
All the interactions with the molecule(s) uploaded in Mol* require using mouse controls (in the 3D canvas). These controls allow the user to manipulate the view of structures via a variety of functions such as rotating, translating, zooming, and clipping the structures. When not specified, a “click” refers to pressing the left mouse button or tapping a single finger on a touchscreen. If an action is available for the right mouse button, it can also be completed by using the Control button + left mouse button. The general mouse controls are listed below:
84
84
85
85
***Rotate**: click the left mouse button and move. Alternatively, use the Shift button + left mouse button and drag to rotate the canvas.
@@ -95,20 +95,20 @@ As you interact with the structure using the mouse, Mol* contains two modes for
95
95
***Default Mode**: A click on a residue (or any object in 3D) will focus on it. The focused residue and its surroundings (residues and ligands) will be displayed in a ball & stick representation. All local non-covalent interactions will be shown. To hide the surroundings, click on the target residue again.
96
96
***[Selection Mode](https://molstar.org/viewer-docs/making-selections/#selection-mode)**: A click on a residue (or any object in 3D) will select it. What exactly will be selected depends on the value of the [Picking Level](https://molstar.org/viewer-docs/making-selections/#picking-level). Selected parts of the structure will appear with a bright green tint in the 3D canvas and in the [Sequence Panel](https://molstar.org/viewer-docs/navigating-by-sequence/#sequence-panel). When selecting polymers with the Picking Level set to “residue,” holding the Shift key while clicking will extend the selection along the polymer from the last clicked residue on. Clicking on any point in the 3D canvas that has no atom will clear the selection.
97
97
98
-
## :magnet: Installation
98
+
## 🧲 Installation
99
99
* The extension can be downloaded/installed from the [VSCode marketplace](https://marketplace.visualstudio.com/items?itemName=ArianJamasb.protein-viewer)
100
100
101
101
* Altenatively, enter `⌘ + ⇧ + x` in VSCode and search for `Protein Viewer`
102
102
103
103
104
-
## :mailbox_with_mail: Community
104
+
## 📬 Community
105
105
### Support
106
106
Need help? Please [open an issue](https://github.com/a-r-j/vscoding-sequence/issues/new/choose) for support.
107
107
108
108
### Discussion
109
109
Find me on twitter: [@arian_jamasb](https://twitter.com/arian_jamasb) or drop me an email: [[email protected]](mailto:[email protected])
110
110
111
-
## :tornado: Change log
111
+
## 🌪️ Change log
112
112
113
113
### 0.0.5
114
114
* Adds ability to launch a viewer from a selection of multiple supported files.
@@ -143,7 +143,7 @@ Adds support for molecules:
143
143
144
144
Initial release!
145
145
146
-
## :books: Reference
146
+
## 📚 Reference
147
147
148
148
If this extension proves useful, you should cite the developers of Mol*
0 commit comments