superstar54 / weas

WEAS is JavaScript library to visualize and manipulate the atomic structures directly in the web browser.

Home Page:https://weas.readthedocs.io/en/latest/index.html

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Web Environment For Atomic Structure (WEAS)

npm version Docs status Unit test

The WEAS package is a JavaScript library designed to visualize and edit atomic structures (molecule, crystal, nanoparticle) in the web environments.

Features:

  • Model: space-filling, ball-stick, polyhedral.
  • Supported File types: CIF, XYZ, cube.
  • Edit structure: move, rotate, delete, and replace atoms.
  • Support periodic boundary conditions.
  • Animation (view and edit).
  • Volumetric data (isosurface).
  • Vector fields, e.g., magnetic moment.

Here are some demo pages:

How to use

Please visit: WEAS Documentation

How to run a demo locally

Clone the repository,

npm install
npm start

Then go to the demo site.

Test

npm install
npm test

End-to-end test

Use playwright for the e2e test.

For the first time, one needs to install the dependence.

npx playwright install

Then run

npm run build
npx playwright test

Run the test with the title

npx playwright test -g "Animation"

If the snapshots need to be updated:

npx playwright test --update-snapshots

Contact

About

WEAS is JavaScript library to visualize and manipulate the atomic structures directly in the web browser.

https://weas.readthedocs.io/en/latest/index.html

License:MIT License


Languages

Language:JavaScript 94.9%Language:HTML 4.7%Language:CSS 0.4%