matsci-parse 0.6.0 → 0.7.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (3) hide show
  1. package/README.md +49 -1
  2. package/dist/main.js +455 -397
  3. package/package.json +2 -2
package/README.md CHANGED
@@ -1 +1,49 @@
1
- A library to unify and interconvert between common material science files types.
1
+ # matsci-parse
2
+
3
+ A TypeScript-based library and web toolset for parsing, transforming, and analyzing atomistic materials science data, including crystal structures, symmetry data, and common simulation file formats.
4
+
5
+ This project is written to be functional, allowing tree-shakability.
6
+
7
+ ---
8
+
9
+ ### Project overview
10
+
11
+ #### `io/`
12
+
13
+ Parsers and data models for multiple file formats:
14
+
15
+ - CIF
16
+ - VASP (POSCAR, CHGCAR)
17
+ - Quantum ESPRESSO (pw)
18
+ - Gaussian cube files
19
+ - XYZ
20
+ - XSF
21
+ - AiiDA structure objects
22
+ - Generic crystal and molecular structures
23
+
24
+ #### `math/`
25
+
26
+ Linear algebra and crystallographic geometry utilities:
27
+
28
+ - Matrix operations
29
+ - Coordinate transformations
30
+ - Lattice calculations
31
+
32
+ #### `symmetry/`
33
+
34
+ Symmetry and reciprocal space tools:
35
+
36
+ - Space group data and operations (using moyo-wasm)
37
+
38
+ #### `units/`
39
+
40
+ Unit systems and conversions:
41
+
42
+ - Length units
43
+ - Energy units
44
+ - Angle units
45
+ - General conversion utilities
46
+
47
+ ---
48
+
49
+ ### A frontend demo of some of the utilities possible is available (`webapp/`)