Skip to content

Commit ce7a1de

Browse files
authored
0.1.0 (#19)
* add support for .cif .CIF .MMCIF .mmCIF #16 * add ESMFold Support * add version string * update changelog * update readme * add fix to ensure extensions are lowercase
1 parent c087141 commit ce7a1de

File tree

7 files changed

+7528
-7
lines changed

7 files changed

+7528
-7
lines changed

README.md

Lines changed: 26 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2,21 +2,19 @@
22

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

5-
65
[![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)
76
[![vscode last updated](https://img.shields.io/visual-studio-marketplace/last-updated/ArianJamasb.protein-viewer)](https://marketplace.visualstudio.com/items?itemName=ArianJamasb.protein-viewer)
87
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
98

109
[![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)
1110
[![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)
1211

13-
1412
VSCoding Sequence allows for visualisation of protein structures and molecular data in the editor, courtesy of the fantastic [Mol*](https://molstar.org/)
1513

16-
1714
📚 [Viewer Docs](https://molstar.org/viewer-docs/) | [Mol* Docs](https://molstar.org/docs/)
1815

1916
## 📦 Features
17+
2018
### 📥 Loading a Protein Structure from the [PDB](https://www.rcsb.org/) or [AlphaFoldDB](https://alphafold.ebi.ac.uk/)
2119

2220
![Usage gif](img/usage.gif)
@@ -42,20 +40,23 @@ Right-click on the file or selection of files in the file editor and select `Lau
4240
* `.sdf`
4341

4442
### 📂 Loading a Local Folder
43+
4544
![Local folder usage gif](img/local_folder.gif)
4645

4746
Right-click on the folder in the file explorer and select `Launch Protein Viewer from Folder`
4847

4948
## ⚙️ Usage
49+
5050
*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+
5152
### 🌎 Interface
53+
5254
![Viewer Layout](https://molstar.org/viewer-docs/img/generalinterface3.png)
5355

5456
**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.
5557

5658
**Toggle Menu**: This menu provides users quick access to some commonly used operations for the 3D canvas. It is located towards the right side of the 3D canvas and has the following functions.
5759

58-
5960
| Function | Description | Icon |
6061
|---|---|---|
6162
|Reset Camera | Centers and resets the view of the structure on the 3D canvas | ![Rest Camera Icon](https://molstar.org/viewer-docs/img/resetcameraicon.png) |
@@ -68,6 +69,7 @@ Right-click on the folder in the file explorer and select `Launch Protein Viewer
6869
**[Sequence Panel](https://molstar.org/viewer-docs/navigating-by-sequence/#sequence-panel)**: This menu displays the polymer sequences of macromolecules (proteins and nucleic acids) present in the uploaded PDB structures. In addition, it provides quick access to any small molecular ligands or entities present in the structure(s). It is located at the top of the screen above the 3D Canvas.
6970

7071
**[Controls Panel](https://molstar.org/viewer-docs/managing-the-display/#controls-panel)**: This menu has the following panels for structure manipulation. It is located at the right side of the screen.
72+
7173
* [Structure](https://molstar.org/viewer-docs/managing-the-display/#structure-panel)
7274
* [Measurements](https://molstar.org/viewer-docs/managing-the-display/#measurements-panel)
7375
* [Components](https://molstar.org/viewer-docs/managing-the-display/#components-panel)
@@ -80,6 +82,7 @@ Right-click on the folder in the file explorer and select `Launch Protein Viewer
8082
**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.
8183

8284
### 🐭 Mouse Controls
85+
8386
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:
8487

8588
* **Rotate**: click the left mouse button and move. Alternatively, use the Shift button + left mouse button and drag to rotate the canvas.
@@ -96,46 +99,63 @@ As you interact with the structure using the mouse, Mol* contains two modes for
9699
* **[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.
97100

98101
## 🧲 Installation
102+
99103
* The extension can be downloaded/installed from the [VSCode marketplace](https://marketplace.visualstudio.com/items?itemName=ArianJamasb.protein-viewer)
100104

101105
* Altenatively, enter `⌘ + ⇧ + x` in VSCode and search for `Protein Viewer`
102106

103-
104107
## 📬 Community
108+
105109
### Support
110+
106111
Need help? Please [open an issue](https://github.com/a-r-j/vscoding-sequence/issues/new/choose) for support.
107112

108113
### Discussion
114+
109115
Find me on twitter: [@arian_jamasb](https://twitter.com/arian_jamasb) or drop me an email: [[email protected]](mailto:[email protected])
110116

111117
## 🌪️ Change log
112118

119+
### 0.1.0
120+
121+
Adds support for folding sequences via ESMFold
122+
Bumps Mol* to 3.23.0
123+
113124
### 0.0.8
125+
114126
Adds support for Mol* 3.0.2 to enable viewing of AF2 structures.
115127

116128
### 0.0.7
129+
117130
README Fixes.
131+
118132
### 0.0.6
133+
119134
Fixes README emoji shortcodes
135+
120136
### 0.0.5
121-
* Adds ability to launch a viewer from a selection of multiple supported files.
122137

138+
* Adds ability to launch a viewer from a selection of multiple supported files.
123139

124140
### 0.0.4
141+
125142
* Adds support to open folders from explorer
126143

127144
### 0.0.3
145+
128146
* Update docs & package metadata
129147
* Fixes issue that viewer would autorefresh and lose state when switching between views.
130148

131149
Adds support for additional filetypes:
150+
132151
* `.pdbqt`
133152
* `.mmcif`
134153
* `.gro`
135154
* `.xyz`
136155
* `.cif`
137156

138157
Adds support for molecules:
158+
139159
* `.mol`
140160
* `.mol2`
141161
* `.sdf`

src/panels/ProteinViewerPanel.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -177,7 +177,7 @@ export class ProteinViewerPanel {
177177
const cssUri = webview.asWebviewUri(vscode.Uri.joinPath(extensionUri, 'node_modules', 'molstar', 'build/viewer', 'molstar.css'));
178178
const jsUri = webview.asWebviewUri(vscode.Uri.joinPath(extensionUri, 'node_modules', 'molstar', 'build/viewer', 'molstar.js'));
179179
const pdbContents = clickedFiles.map((clickedFile) => webview.asWebviewUri(clickedFile));
180-
const extensions = clickedFiles.map((clickedFile) => clickedFile.path.split('.').pop());
180+
const extensions = clickedFiles.map((clickedFile) => clickedFile.path.split('.').pop()?.toLocaleLowerCase());
181181
let loadCommands: String[] = [];
182182
for (let i = 0; i < pdbContents.length; i++) {
183183
const pdbContent = pdbContents[i];

0 commit comments

Comments
 (0)