bravais 0.0.0-stage → 0.1.1

package/CHANGELOG.md

@@ -0,0 +1,31 @@
+# Changelog
+
+## 0.1.1 - 2026-10-16
+
+- The TrackballControls addon is bundled, so the module imports only `three`
+  itself. A consumer without a bundler maps one module instead of two, and an
+  Electron app packaged with electron-builder, which drops every dependency's
+  `examples` folder, no longer loses the addon.
+
+## 0.1.0 - 2026-10-15
+
+First public release.
+
+- Reads CIFs, applying the file's operator loop or the space-group operations
+  from moyo when the loop is missing.
+- `symmetryDataset(structure)`: moyo's analysis of the atoms, with the
+  standard space group and its Hall setting, Wyckoff letters, site
+  symmetries, and the structure in the standard cell.
+- `typesetSymbol(symbol)`: a Hermann-Mauguin symbol as textbooks print it,
+  Fm3̅m and P2₁/c, from the ASCII forms of moyo, spglib and CIF files.
+- A rhombohedral symbol without `:H` or `:R` is read in the setting the
+  listed atoms fit, or the cell shape selects. A file whose atoms are listed
+  already expanded but do not close under its operations is refused instead
+  of being drawn wrong.
+- Expands the structure, repeats boundary sites as image atoms, and finds
+  bonds with VESTA's cutoff table.
+- Renders with three.js: ray-cast atoms, closed bond tubes, occupancy pies on
+  shared sites, the cell frame, depth fading, and a trackball with inertia.
+- A session element palette kept distinct in OKLab, an element legend, an a,
+  b, c axes gizmo whose letters turn white over the arrows, layered viewers
+  with transferable view states, and a shared thumbnail renderer.

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Jiacheng Wang
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,3 +1,47 @@
-# Temporary Holding Version
+# bravais
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+[![npm](https://img.shields.io/npm/v/bravais)](https://www.npmjs.com/package/bravais)
+[![CI](https://github.com/jcwang587/bravais/actions/workflows/ci.yml/badge.svg)](https://github.com/jcwang587/bravais/actions/workflows/ci.yml)
+
+A minimal crystal structure viewer for the web.
+
+## Install
+
+```sh
+npm install bravais three
+```
+
+## Use
+
+```js
+import { buildScene, createViewer, expandStructure, readCif } from "bravais";
+
+const scene = buildScene(expandStructure(await readCif(cifText)));
+createViewer(document.getElementById("viewer")).setLayers([{ scene }]);
+```
+
+## Built with
+
+- [three.js](https://threejs.org/): rendering, as a peer dependency.
+- [moyo](https://github.com/spglib/moyo): space-group
+  operations, bundled as WebAssembly.
+- [VESTA](https://jp-minerals.org/vesta/en/): the bond cutoffs, the element
+  colours, used here in Pretty Lattice's softened version, and the
+  occupancy pies.
+- [pymatgen](https://github.com/materialsproject/pymatgen): the copy of
+  VESTA's cutoff table this package ships.
+- OKLab: Björn Ottosson's public-domain colour formulas. They supply no
+  colours: they measure how alike two colours look, and move an element's
+  colour only when it would clash with one already on screen.
+
+Thanks to Feitong Song's
+[Pretty Lattice](https://github.com/songfeitong/pretty-lattice), which this
+viewer follows in its lighting and materials, depth fading, trackball feel,
+axes gizmo, legend swatch, standard view and softened element colours.
+
+The code was written by Claude Code, under the author's direction and review.
+
+## License
+
+[MIT](LICENSE). Notices for the bundled third-party material are in
+[THIRD_PARTY_NOTICES.md](THIRD_PARTY_NOTICES.md).

package/THIRD_PARTY_NOTICES.md

@@ -0,0 +1,51 @@
+# Third-party notices
+
+bravais is MIT licensed (see [LICENSE](LICENSE)). It ships material from the
+three MIT-licensed projects below, bundled into `dist/bravais.js`. Each is
+reproduced with its copyright notice, and the MIT permission notice at the
+end applies to all three.
+
+## moyo
+
+The space-group operations and the symmetry analysis come from the
+WebAssembly build of [moyo](https://github.com/spglib/moyo), used under its
+MIT licence.
+
+Copyright (c) 2023 Kohei Shinohara
+
+## pymatgen
+
+The bond cutoff table (`src/data/vesta-cutoffs.json`) is copied from
+[pymatgen](https://github.com/materialsproject/pymatgen)'s
+`vesta_cutoffs.yaml`. The values originate in VESTA (K. Momma and F. Izumi).
+
+Copyright (c) 2011-2012 MIT & The Regents of the University of California,
+through Lawrence Berkeley National Laboratory
+
+## Pretty Lattice
+
+The element colour table (`src/data/element-colors.json`) is
+[Pretty Lattice](https://github.com/songfeitong/pretty-lattice)'s softened
+version of VESTA's element colours.
+
+Copyright (c) 2026 Feitong Song
+
+## MIT permission notice
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.