Skip to content

Commit aaaf35b

Browse files
committed
Update docs
1 parent 1f11e01 commit aaaf35b

File tree

3 files changed

+46
-25
lines changed

3 files changed

+46
-25
lines changed

CHANGELOG.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,9 @@
22

33
All notable changes to the "protein-viewer" extension will be documented in this file.
44

5+
### 0.0.5
6+
* Adds ability to launch a viewer from a selection of multiple supported files.
7+
58
## 0.0.4
69
* Adds support to open folders from explorer
710

README.md

Lines changed: 39 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,32 +1,35 @@
1-
# VSCoding-Sequence
1+
# VSCoding-Sequence :dna: :test_tube::microscope:
22

33
<img src="img/logo.png" alt="drawing" width="200"/>
44

5-
VSCoding Sequence allows for visualisation of protein structures in the editor, courtesy of the fantastic [Mol*](https://molstar.org/)
65

6+
[![Version](https://vsmarketplacebadge.apphb.com/version/ArianJamasb.protein-viewer.svg?color=blue&style=?style=for-the-badge&logo=visual-studio-code)](https://marketplace.visualstudio.com/items?itemName=ArianJamasb.protein-viewer)
7+
[![vscode last updated](https://img.shields.io/visual-studio-marketplace/last-updated/ArianJamasb.protein-viewer)](https://marketplace.visualstudio.com/items?itemName=ArianJamasb.protein-viewer)
8+
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
79

8-
[Viewer Docs](https://molstar.org/viewer-docs/) | [Mol* Docs](https://molstar.org/docs/)
10+
[![vscode downloads](https://img.shields.io/visual-studio-marketplace/i/ArianJamasb.protein-viewer)](https://marketplace.visualstudio.com/items?itemName=ArianJamasb.protein-viewer) [![Downloads](https://vsmarketplacebadge.apphb.com/downloads/ArianJamasb.protein-viewer.svg?color=orange)](https://marketplace.visualstudio.com/items?itemName=ArianJamasb.protein-viewer)
11+
[![Trending-Weekly](https://vsmarketplacebadge.apphb.com/trending-weekly/ArianJamasb.protein-viewer.svg?logo=tinder&logoColor=white&label=trending%20weekly)](https://marketplace.visualstudio.com/items?itemName=ArianJamasb.protein-viewer) [![Trending-Monthly](https://vsmarketplacebadge.apphb.com/trending-monthly/ArianJamasb.protein-viewer.svg?logo=tinder&logoColor=white&label=monthly)](https://marketplace.visualstudio.com/items?itemName=ArianJamasb.protein-viewer)
912

10-
## Features
11-
### Loading a Structure from the PDB
1213

13-
![Usage gif](img/usage.gif)
14+
VSCoding Sequence allows for visualisation of protein structures and molecular data in the editor, courtesy of the fantastic [Mol*](https://molstar.org/)
1415

15-
Simply call the `Start Protein Viewer command`, enter a PDB accession code & away you go!
1616

17-
### Loading a Local File
17+
:books: [Viewer Docs](https://molstar.org/viewer-docs/) | [Mol* Docs](https://molstar.org/docs/)
1818

19-
![Local file usage gif](img/local_file.gif)
19+
## :package: Features
20+
### :inbox_tray: Loading a Protein Structure from the [PDB](https://www.rcsb.org/)
2021

21-
Right-click on the `.pdb` file in the file editor and select `Launch Protein Viewer from File`
22+
![Usage gif](img/usage.gif)
2223

23-
### Loading a Local Folder
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!
2425

25-
![Local folder usage gif](img/local_folder.gif)
26+
### :spiral_calendar: Loading Local File(s)
2627

27-
Right-click on the folder in the file explorer and select `Launch Protein Viewer from Folder`
28+
![Local file usage gif](img/local_file.gif)
2829

29-
**Supported Formats**
30+
Right-click on the file or selection of files in the file editor and select `Launch Protein Viewer from File(s)`
31+
32+
**:white_check_mark: Supported Formats**
3033

3134
* `.pdb`
3235
* `.pdbqt`
@@ -38,9 +41,14 @@ Right-click on the folder in the file explorer and select `Launch Protein Viewer
3841
* `.mol2`
3942
* `.sdf`
4043

41-
## Usage
42-
*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 and Dr. Shuchismita Dutta.*
43-
### Interface
44+
### :open_file_folder: Loading a Local Folder
45+
![Local folder usage gif](img/local_folder.gif)
46+
47+
Right-click on the folder in the file explorer and select `Launch Protein Viewer from Folder`
48+
49+
## :gear: Usage
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.*
51+
### :earth_americas: Interface
4452
![Viewer Layout](https://molstar.org/viewer-docs/img/generalinterface3.png)
4553

4654
**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.
@@ -71,7 +79,7 @@ Right-click on the folder in the file explorer and select `Launch Protein Viewer
7179

7280
**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.
7381

74-
### Mouse Controls
82+
### :mouse: Mouse Controls
7583
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:
7684

7785
* **Rotate**: click the left mouse button and move. Alternatively, use the Shift button + left mouse button and drag to rotate the canvas.
@@ -87,14 +95,24 @@ As you interact with the structure using the mouse, Mol* contains two modes for
8795
* **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.
8896
* **[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.
8997

90-
## Community
98+
## :magnet: Installation
99+
* The extension can be downloaded/installed from the [VSCode marketplace](https://marketplace.visualstudio.com/items?itemName=ArianJamasb.protein-viewer)
100+
101+
* Altenatively, enter `⌘ + ⇧ + x` in VSCode and search for `Protein Viewer`
102+
103+
104+
## :mailbox_with_mail: Community
91105
### Support
92106
Need help? Please [open an issue](https://github.com/a-r-j/vscoding-sequence/issues/new/choose) for support.
93107

94108
### Discussion
95109
Find me on twitter: [@arian_jamasb](https://twitter.com/arian_jamasb) or drop me an email: [[email protected]](mailto:[email protected])
96110

97-
## Change log
111+
## :tornado: Change log
112+
113+
### 0.0.5
114+
* Adds ability to launch a viewer from a selection of multiple supported files.
115+
98116

99117
### 0.0.4
100118
* Adds support to open folders from explorer
@@ -125,7 +143,7 @@ Adds support for molecules:
125143

126144
Initial release!
127145

128-
## Reference
146+
## :books: Reference
129147

130148
If this extension proves useful, you should cite the developers of Mol*
131149

package.json

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@
4646
],
4747
"activationEvents": [
4848
"onCommand:protein-viewer.start",
49-
"onCommand:protein-viewer.activateFromFile",
49+
"onCommand:protein-viewer.activateFromFiles",
5050
"onCommand:protein-viewer.activateFromFolder"
5151
],
5252
"main": "./out/extension.js",
@@ -57,8 +57,8 @@
5757
"title": "Start Protein Viewer"
5858
},
5959
{
60-
"command": "protein-viewer.activateFromFile",
61-
"title": "Launch Protein Viewer from File"
60+
"command": "protein-viewer.activateFromFiles",
61+
"title": "Launch Protein Viewer from File(s)"
6262
},
6363
{
6464
"command": "protein-viewer.activateFromFolder",
@@ -69,7 +69,7 @@
6969
"explorer/context": [
7070
{
7171
"when": "resourceExtname == .pdb || resourceExtname == .PDB || resourceExtname == .mol2 || resourceExtname == .MOL2 || resourceExtname == .sdf || resourceExtname == .SDF || resourceExtname == .mmCIF || resourceExtname == .mmcif || resourceExtname == .Mol || resourceExtname == .mol || resourceExtname == .MOL || resourceExtname == .xyz || resourceExtname == .XYZ || resourceExtname == .ent || resourceExtname == .ENT || resourceExtname == .pdbqt || resourceExtname == .PDBQT || resourceExtname == .cif || resourceExtname == .CIF || resourceExtname == .mcif || resourceExtname == .MCIF || resourceExtname == .gro || resourceExtname == .GRO",
72-
"command": "protein-viewer.activateFromFile",
72+
"command": "protein-viewer.activateFromFiles",
7373
"group": "navigation"
7474
},
7575
{

0 commit comments

Comments
 (0)