NGLViewer 开源项目教程

1. 项目目录结构及介绍

NGLViewer 项目的目录结构如下：

ngl/
├── build/
├── docs/
├── examples/
├── src/
├── test/
├── .gitignore
├── LICENSE
├── package.json
├── README.md
└── webpack.config.js

目录介绍

• build/: 存放构建生成的文件，通常是编译后的代码或打包后的文件。
• docs/: 存放项目的文档，包括用户手册、API 文档等。
• examples/: 存放项目的示例代码，帮助用户理解如何使用 NGLViewer。
• src/: 存放项目的源代码，包括核心功能和模块。
• test/: 存放项目的测试代码，用于确保代码的正确性和稳定性。
• .gitignore: Git 的忽略文件，指定哪些文件或目录不需要被版本控制。
• LICENSE: 项目的开源许可证，说明项目的使用条款。
• package.json: 项目的配置文件，包含项目的依赖、脚本等信息。
• README.md: 项目的介绍文件，通常包含项目的概述、安装方法、使用说明等。
• webpack.config.js: Webpack 的配置文件，用于项目的构建和打包。

2. 项目启动文件介绍

NGLViewer 的启动文件通常位于 src/ 目录下，具体文件可能包括 index.js 或 main.js。以下是一个典型的启动文件示例：

// src/index.js
import NGL from 'ngl';

// 创建一个 NGL 视图
const stage = new NGL.Stage('viewport');

// 加载一个分子结构文件
stage.loadFile('rcsb://1crn').then(function (o) {
    o.addRepresentation('cartoon');
    o.autoView();
});

启动文件功能

• 导入 NGL 模块: 使用 import NGL from 'ngl'; 导入 NGL 模块。
• 创建 NGL 视图: 使用 new NGL.Stage('viewport'); 创建一个 NGL 视图，'viewport' 是 HTML 中用于显示 NGL 视图的元素 ID。
• 加载分子结构文件: 使用 stage.loadFile('rcsb://1crn') 加载一个分子结构文件，并添加表示形式（如 cartoon）。

3. 项目配置文件介绍

NGLViewer 的配置文件主要包括 package.json 和 webpack.config.js。

package.json

package.json 是 Node.js 项目的配置文件，包含项目的元数据和依赖信息。以下是部分关键配置项：

{
  "name": "ngl",
  "version": "2.0.0",
  "description": "NGL - Molecular Graphics for the Web",
  "main": "src/index.js",
  "scripts": {
    "start": "webpack-dev-server --config webpack.config.js --mode development",
    "build": "webpack --config webpack.config.js --mode production"
  },
  "dependencies": {
    "three": "^0.127.0"
  },
  "devDependencies": {
    "webpack": "^5.0.0",
    "webpack-dev-server": "^4.0.0"
  }
}

配置项介绍

• name: 项目的名称。
• version: 项目的版本号。
• description: 项目的描述。
• main: 项目的入口文件，通常是启动文件。
• scripts: 定义项目的脚本命令，如 start 和 build。
• dependencies: 项目的生产环境依赖。
• devDependencies: 项目的开发环境依赖。

webpack.config.js

webpack.config.js 是 Webpack 的配置文件，用于项目的构建和打包。以下是部分关键配置项：

const path = require('path');

module.exports = {
  entry: './src/index.js',
  output: {
    filename: 'bundle.js',
    path: path.resolve(__dirname, 'dist')
  },
  module: {
    rules: [
      {
        test: /\.js$/,
        exclude: /node_modules/,
        use: {
          loader: 'babel-loader'
        }
      }
    ]
  },
  devServer: {
    contentBase: './dist'
  }
};

配置项介绍

• entry: 指定项目的入口文件。
• output: 指定打包后的输出文件名和路径。
• module: 定义模块的加载规则，如使用 Babel 加载 JavaScript 文件。
• devServer: 配置开发服务器，指定静态文件的根目录。

通过以上配置，NGLViewer 项目可以顺利启动和构建，用户可以根据需要进行定制和扩展。