Development for RF Touchstone

Setup Node.js environment

Download and install Node.js from the official website

Check the current version of Node.js

node -v

Enable corepack

This is a one-time setup per computer. It activates the built-in managers so you don't need to use npm install -g yarn anymore.

corepack enable

Install newest version of yarn

yarn set version stable

Check the current version of yarn

yarn -v

Install packages

yarn install

Upgrade packages (Optional/Maintenance)

yarn upgrade-interactive

Setup Python environment

Create and Use Virtual Environments

Install uv

uv is a fast Python package installer and virtual environment manager. You can install uv by running the following command:

# On macOS and Linux
curl -LsSf https://astral.sh/uv/install.sh | sh

# On Windows
powershell -ExecutionPolicy ByPass -c "irm https://astral.sh/uv/install.ps1 | iex"

Add the uv executable to your system's PATH (Linux)

Source the appropriate environment file for your shell:

# On Bash, Zsh, or Sh:
source $HOME/.local/bin/env
# On Fish:
source $HOME/.local/bin/env.fish

You may need to restart your shell or open a new terminal session for the changes to take effect.

Check uv version

uv --version

Create and Use Virtual Environments with uv

Create a new virtual environment:

uv venv .venv

Activate the virtual environment

# On Windows:
.venv\Scripts\activate
# On MacOS/Linux:
source .venv/bin/activate

To confirm the virtual environment is activated, check the location of your Python interpreter:

# On Windows:
where python
# On MacOS/Linux:
which python

Check python version

python --version

Install packages using uv

Install packages using a requirements file:

uv pip install -r requirements.txt

Check packages available for update

uv pip list --outdated

Upgrade packages

uv pip install -r requirements.txt --upgrade

Deactivate a virtual environment

# On Windows:
.venv\Scripts\deactivate
# On MacOS/Linux:
deactivate

Development

Lint with ESLint

yarn lint

Format with Prettier

yarn format

Unit test with Vitest

Comparative Testing with scikit-rf

Our comprehensive test suite includes comparative tests that validate our library's results against scikit-rf. This ensures our parsing, unit scaling, and matrix manipulation logic remains consistent with industry-standard tools. To run these tests, you must have the Python environment correctly configured.

Interactive development

Runs the tests in interactive watch mode:

yarn test:watch

Command line

yarn test:unit

Check test coverage

yarn test:coverage

All tests

Convenient command includes: lint, format, unit:test, test:coverage, build, and generate API docs

yarn test

Compile, build and minify for production

yarn build

Documentation (using VitePress and TypeDoc)

Generate API documentation from TSDoc comments

This command uses TypeDoc to parse TSDoc comments in the TypeScript source files and generates markdown files in the docs/api directory.

yarn docs:md

Start local development server for documentation

This command starts the VitePress development server. You can view your documentation site locally, usually at http://localhost:5173.

yarn docs:dev

Build documentation for deployment

This command builds the static HTML, CSS, and JavaScript files for the documentation site. The output will be in the docs/.vitepress/dist directory.

yarn docs:build

Preview the built documentation locally

After building the documentation, this command allows you to preview the production build locally before deploying it.

yarn docs:preview