@jtgtools/xbeam 0.0.1

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 JTG Tools
+
+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

@@ -0,0 +1,64 @@
+# xbeam
+
+A fast Euler-Bernoulli beam finite element solver in TypeScript with chart-ready output.
+
+## Features
+
+- 2-node Hermite beam elements
+- distributed loads, point loads, and applied moments
+- simply supported, cantilever, fixed, and propped support conditions
+- full stiffness assembly with banded storage
+- Cholesky solve with buffered reuse for speed
+- support reaction and equilibrium checks
+- deflection, moment, and shear diagram sampling
+- demo page with Chart.js visualization
+
+## Install
+
+```bash
+npm install
+npm run build
+```
+
+## Scripts
+
+- `npm test` — run tests with Vitest
+- `npm run demo` — build and serve demo UI on http://localhost:3000
+- `npm run bench` — run benchmark suite
+
+## Usage
+
+```ts
+import { analyzeBeam, analyzeBeamChartReady } from '@jtgtools/xbeam';
+
+const beam = {
+  length: 5,
+  modulusOfElasticity: 200e9,
+  momentOfInertia: 1e-6,
+  supports: [{ kind: 'PINNED', position: 0 }, { kind: 'ROLLER', position: 5 }],
+  pointLoads: [],
+  distributedLoads: [{ startMagnitude: -1000, endMagnitude: -1000, startPosition: 0, endPosition: 5 }],
+  appliedMoments: []
+};
+
+const results = analyzeBeam(beam);
+// results.deflections, results.rotations, results.reactions...
+
+const { results: chartResults, diagrams } = analyzeBeamChartReady(beam);
+// diagrams.deflection, diagrams.moment, diagrams.shear
+```
+
+## Project structure
+
+- `src/` — TypeScript source
+- `tests/` — unit and regression tests
+- `demo/` — pictorial demo page
+- `dist/` — generated build output
+
+## TypeScript
+
+This project uses strict TS typings. If the compiler reports `Support kind` type errors in tests, ensure support objects are defined with literal `as const` or typed as `Support`.
+
+## License
+
+MIT