Metadata-Version: 2.2
Name: samu
Version: 0.1.0
Summary: A simple coplanar electrical channel crosstalk extractor for Samuel.
Author-email: Diogo Andre <ddias@tudelft.nl>
Project-URL: Homepage, https://github.com/das-dias/samu
Project-URL: Repository, https://github.com/das-dias/samu.git
Requires-Python: >=3.7
Description-Content-Type: text/markdown
Requires-Dist: docopt
Requires-Dist: numpy
Requires-Dist: scipy
Requires-Dist: pydantic
Requires-Dist: pydantic_yaml
Requires-Dist: matplotlib
Requires-Dist: rich
Requires-Dist: pyyaml
Requires-Dist: pyspice
Requires-Dist: ruff

# Sam

`A simple coplanar metal stripline electrical cross-talk 2.5D extractor.`

# Install

### Using `pip`

```sh 
$pip install sampex
```
### Binaries:

There are two available binaries that you can directly download from this repo:

1. samwin - Windows .exe executable.

2. samnix - .nix systems executable. 

# Usage

The tool requires two input YAML files:

```sh
sam example_setup.yml -g
```

The input setup file contains a description of the dielectric emersing the coplanar metal strips and the geometry of the setup:

```yaml
#example_setup.yml

materials:
  poliomide:
    material_type: dielectric
    rel_permittivity: 3.3
    rel_permeability: 1.0

  copper:
    material_type: metal
    resistivity: 1.68e-8 # Ohm.m

geometry:
  units: micro
  metal_width: 3.0
  metal_thickness: 0.5
  separation: 1.0
  strip_length: 3e4 # 3 cm
```

The `-g`flag enables visualization of the geometry and the crosstalk results using a GUI.

# Contribute

If you want to submit changes, keep it simple. 
Avoid unnecessary comments in the middle of the code - it speaks for itself.
