rf-touchstone 0.0.0

package/package.json

@@ -0,0 +1,73 @@
+{
+  "name": "rf-touchstone",
+  "private": false,
+  "type": "module",
+  "version": "0.0.0",
+  "description": "A Javascript/TypeScript library for reading, manipulating, and writing Touchstone files (.snp files) used in radio frequency (RF) and microwave engineering.",
+  "main": "dist/Touchstone.cjs.js",
+  "module": "dist/Touchstone.es.js",
+  "types": "dist/touchstone.d.ts",
+  "files": [
+    "dist",
+    "readme.md",
+    "development.md",
+    "LICENSE",
+    "coverage/coverage-badge.svg"
+  ],
+  "license": "MIT",
+  "author": "https://github.com/panz2018",
+  "repository": "https://github.com/panz2018/RF-Touchstone",
+  "keywords": [
+    "rf",
+    "touchstone",
+    "snp",
+    "s1p",
+    "s2p",
+    "s3p",
+    "s4p",
+    "s5p",
+    "s6p",
+    "frequency",
+    "scattering",
+    "matrix"
+  ],
+  "scripts": {
+    "test": "run-p --print-label lint format test:unit test:coverage build docs:md && run-s docs:build",
+    "lint": "eslint . --fix",
+    "format": "prettier --write src/",
+    "test:unit": "vitest run",
+    "test:coverage": "vitest run --coverage && coverage-badges --source coverage/coverage-summary.json --output coverage/coverage-badge.svg",
+    "build": "tsc && vite build && yarn pack",
+    "docs:md": "typedoc --tsconfig tsconfig.json",
+    "docs:dev": "node docs/.vitepress/copy-docs.mjs && vitepress dev docs",
+    "docs:build": "node docs/.vitepress/copy-docs.mjs && vitepress build docs",
+    "docs:preview": "vitepress preview docs"
+  },
+  "dependencies": {
+    "mathjs": "^14.5.0"
+  },
+  "devDependencies": {
+    "@eslint/js": "^9.27.0",
+    "@types/eslint-config-prettier": "^6.11.3",
+    "@types/node": "^22.15.21",
+    "@vitest/coverage-v8": "^3.1.4",
+    "coverage-badges-cli": "^2.1.0",
+    "eslint": "^9.27.0",
+    "eslint-config-prettier": "^10.1.5",
+    "eslint-plugin-prettier": "^5.4.0",
+    "globals": "^16.2.0",
+    "happy-dom": "^17.4.7",
+    "markdown-it-mathjax3": "^4.3.2",
+    "npm-run-all": "^4.1.5",
+    "prettier": "^3.5.3",
+    "rollup-plugin-visualizer": "^5.14.0",
+    "typedoc": "^0.28.4",
+    "typedoc-plugin-markdown": "^4.6.3",
+    "typescript": "^5.8.3",
+    "typescript-eslint": "^8.32.1",
+    "vite": "^6.3.5",
+    "vite-plugin-dts": "^4.5.4",
+    "vitepress": "^1.6.3",
+    "vitest": "^3.1.4"
+  }
+}

package/readme.md

@@ -0,0 +1,73 @@
+# RF-Touchstone
+
+A Javascript/TypeScript library for reading, manipulating, and writing Touchstone files (.snp files) used in radio frequency (RF) and microwave engineering.
+
+[![Tests](https://github.com/panz2018/RF-Touchstone/actions/workflows/Tests.yml/badge.svg)](https://github.com/panz2018/RF-Touchstone/actions/workflows/Tests.yml)
+[![Coverage](coverage/coverage-badge.svg)](coverage/coverage-badge.svg)
+
+## Overview
+
+RF-Touchstone provides a complete solution for working with S-parameters and other network parameters in JavaScript/TypeScript environments. This library allows you to:
+
+- Read and parse Touchstone files (.s1p, .s2p, .s3p, etc.)
+- Manipulate network parameter data
+- Write data back to Touchstone format
+- Convert between different parameter representations (RI, MA, DB)
+
+## What is a Touchstone File?
+
+Touchstone files are an industry-standard ASCII text format for representing network parameters of electrical circuits. Each file contains:
+
+- Comments (lines starting with !)
+- Option line (starts with #) specifying frequency units, parameter type, and data format
+- Network parameter data organized by frequency points
+
+RF-Touchstone currently supports versions 1.0 and 1.1 of the Touchstone specification.
+
+## Key Features
+
+- Full support for Touchstone file format (v1.0 and v1.1)
+- Parameter type support: S, Y, Z, G, H
+- Format conversions: RI (Real/Imaginary), MA (Magnitude/Angle), DB (Decibel/Angle)
+- TypeScript implementation with strong typing
+- Comprehensive test suite
+
+## Installation
+
+```bash
+npm install rf-touchstone
+# or
+yarn add rf-touchstone
+```
+
+## Quick Start
+
+```typescript
+import { Touchstone } from 'rf-touchstone'
+
+// Read a Touchstone file
+const touchstone = new Touchstone()
+touchstone.readContent(fileContent, 2) // 2-port network
+
+// Access data
+const frequencies = touchstone.getFrequencies()
+const sParameters = touchstone.getParameterMatrix()
+
+// Write back to Touchstone format
+const newContent = touchstone.writeContent()
+```
+
+## Documentation
+
+For detailed documentation, please visit:
+
+- [Project Website](https://panz2018.github.io/RF-Touchstone/)
+- [DeepWiki Documentation](https://deepwiki.com/panz2018/RF-Touchstone) - Interactive AI documentation that allows you to converse and ask questions about this repository
+
+## Development
+
+For information on setting up a development environment and contributing to the project, see [development.md](development.md).
+
+## License
+
+This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.