Comparing version 0.1.0 to 0.1.2
{ | ||
"name": "nbmolviz3d", | ||
"version": "0.1.0", | ||
"version": "0.1.2", | ||
"description": "3D molecule visualization", | ||
@@ -23,6 +23,8 @@ "main": "dist/bundle.js", | ||
"css-loader": "^0.23.1", | ||
"eslint": "^2.9.0", | ||
"eslint-config-airbnb": "^8.0.0", | ||
"eslint": "^3.5.0", | ||
"eslint-config-airbnb": "^11.1.0", | ||
"eslint-loader": "^1.3.0", | ||
"eslint-plugin-import": "^1.6.1", | ||
"eslint-plugin-import": "^1.14.0", | ||
"eslint-plugin-jsx-a11y": "^2.2.2", | ||
"eslint-plugin-react": "^6.2.0", | ||
"inline-environment-variables-webpack-plugin": "^1.1.0", | ||
@@ -29,0 +31,0 @@ "karma": "^0.13.22", |
# nbmolviz3d | ||
A data-bound 3D molecule visualizer based on [3Dmol.js](http://3dmol.csb.pitt.edu). | ||
<img src="https://raw.githubusercontent.com/Autodesk/nbmolviz3d/master/doc/close_screenshot.png" alt="screen shot" width="400" /> | ||
## Installation | ||
@@ -14,4 +17,3 @@ | ||
const model = new MolWidget3DModel({ | ||
model_data: bipyridineDotSDF, | ||
model_data_format: 'sdf', | ||
model_data: myModelData, | ||
}); | ||
@@ -25,3 +27,3 @@ const view = new MolWidget3DView({ | ||
See example/js/main.js for a working example. | ||
See [example/js/main.js](https://github.com/Autodesk/nbmolviz3d/blob/master/example/js/main.js) for a working example. | ||
@@ -97,19 +99,34 @@ ## API | ||
## Development | ||
A typical development flow might be to run the example while editing the code, where you'll want any changes to be immediately reflected in the example running in the browser. In that case you should run: | ||
## Example | ||
<img src="https://raw.githubusercontent.com/Autodesk/nbmolviz3d/master/doc/example_screenshot.png" alt="screen shot" width="400" /> | ||
An example is included which provides data-bound inputs that you can play with to see how they affect the visualization. To run it, use the command: | ||
npm run example | ||
## Development | ||
Running the example above will also set up a typical development flow, where any changes to the code will be immediately reflected in the browser. | ||
### Development within another project | ||
If you're using this in another project and want to make changes to this repository locally and see them reflected in your other project, first you'll need to do some setup. You can point your other project to use the local copy of molecular-visualization like this: | ||
If you're using this in another project and want to make changes to this repository locally and see them reflected in your other project, first you'll need to do some setup. You can point your other project to use the local copy of nbmolviz3d like this: | ||
cd ~/path/to/molecular-visualization | ||
cd ~/path/to/nbmolviz3d | ||
npm link | ||
cd ~/path/to/other-project | ||
npm link molecular-visualization | ||
npm link nbmolviz3d | ||
See [this great blog post](http://justjs.com/posts/npm-link-developing-your-own-npm-modules-without-tears) for more info on `npm link`. | ||
Once you've linked your other project, you'll need to build molecular-visualization (and likely your other project, too) every time you want your changes to reflect in your other project. You can do this manually with `npm run build`. If you want to rebuild molecular-visualization automatically every time a change is made, run `npm run watch`. | ||
Once you've linked your other project, you'll need to build nbmolviz3d (and likely your other project, too) every time you want your changes to reflect in your other project. You can do this manually with `npm run build`. If you want to rebuild nbmolviz3d automatically every time a change is made, run `npm run watch`. | ||
### Releasing a new version | ||
A new version should be released via npm every time new code is merged to master. Currently, this process is manual and obviously must be done by a collaborator of the npm package. | ||
On master, upgrading the version looks like the following: | ||
npm version patch -m "Upgrade to %s for reasons" | ||
git push origin master | ||
npm publish | ||
## License | ||
@@ -116,0 +133,0 @@ |
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
2438486
63
141
28