https://github.com/ma-laforge/cmdimcircuits.jl
Parametric analysis/visualization of model/measurement/simulation results
https://github.com/ma-laforge/cmdimcircuits.jl
analog-design bode-plot circuit-analysis continuous-time eda eye-diagrams frequency-domain network-analysis parametric-analysis psf-data pvt-sweeps scientific-computing signal-processing smith-chart spice-data visualization
Last synced: 3 months ago
JSON representation
Parametric analysis/visualization of model/measurement/simulation results
- Host: GitHub
- URL: https://github.com/ma-laforge/cmdimcircuits.jl
- Owner: ma-laforge
- License: mit
- Created: 2020-07-20T15:13:37.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2023-07-02T16:52:17.000Z (almost 2 years ago)
- Last Synced: 2025-02-21T00:35:09.748Z (3 months ago)
- Topics: analog-design, bode-plot, circuit-analysis, continuous-time, eda, eye-diagrams, frequency-domain, network-analysis, parametric-analysis, psf-data, pvt-sweeps, scientific-computing, signal-processing, smith-chart, spice-data, visualization
- Language: Julia
- Homepage: https://ma-laforge.github.io/
- Size: 249 KB
- Stars: 8
- Watchers: 3
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[GallerySProc]:
[GalleryInspectDR]:
[MDDatasetsJL]:
[CMDimDataJL]:
[CMDimDataJL_ImpBk]:
[InspectDRJL]:
# CMDimCircuits.jl: Process measurement/simulation results from parametric analyses
**Galleries:** [:art: ./sample/SignalProcessing][GallerySProc] / [:art: InspectDR.jl package][GalleryInspectDR]
â ***"Focus on the analysis itself, not on data manipulation"***
[](https://github.com/ma-laforge/CMDimCircuits.jl/actions?query=workflow%3ACI)
| 
| 
|
| :---: | :---: |
| 
|
| :---: |
## Table of contents
1. [Description](#Description)
1. [Features/Highlights](#Highlights)
1. [Installation](#Installation)
1. [Activating the "C-Data" environment](#ActivatingCData)
1. [Sample usage](#SampleUsage)
1. Programming interface
1. [`CMDimCircuits.EDAData`: Accessing EDA data files](doc/EDAData.md)
1. [`CMDimCircuits.CircuitAnalysis`: Circuit Analysis Tools](doc/CircuitAnalysis.md)
1. [`CMDimCircuits.NetwAnalysis`: Network Analysis Tools](doc/NetwAnalysis.md)
1. [`CMDimCircuits.SignalProcessing`: {TâF}-Domain Analysis Tools](doc/SignalProcessing.md)
1. [Known limitations](#KnownLimitations)
1. [TODO](TODO.md)
`CMDimCircuits.jl` provides an *environment* (a set of tools) to efficiently
post-process and analyze results from circuit measurement & simulation:
- `[MDDatasets.jl][MDDatasetsJL]`: Easily handle "parametric analysis" data using a simple, multi-dimensional container, and provide `struct DataF1` to represent `{x,y}` vectors as a continuous function of 1 argument: `y=f(x)`.
- `[CMDimData.jl][CMDimDataJL]/EasyPlot`: Easily plot "parametric analysis" data using a backend of your choosing.
- `[CMDimData.jl][CMDimDataJL]/EasyData`: Easily *save* "parametric analysis" data to a single .hdf5 file.
- Various EDA file readers/writers.
More specifically, the goal is to provide an analysis framework leading to
minimal code, written in a *natural*, and *readable* fashion. The following
describes a typical workflow enabled by this package:
1. Read in complex multi-dimensional input data from measurement/simulation results.
1. Treat transient datasets as continuous-time (automatically interpolate when time steps are mismatched).
1. Perform the same operation on all parametric sweeps (usually) without having to write explicit loops.
1. Quickly generate plots that shed light on the studied phenomenon.
1. Select from a multitude of plotting backends (possibly at a later date).
1. Save both data & plot configuration to a single .hdf5 file.
1. Reload plot & data for further investigation at a later time.
- Support for popular EDA file formats: (.tr0, .psf, .sNp).
- Plot the results of multi-dimensional parametric analyses with a single command.
- Support for multiple plotting backends ([see CMDimData.jl for more details][CMDimDataJL]).
- Generate eye diagrams (even for backends without native support).
- Generate Smith Plots ([InspectDR backend only][InspectDRJL]).
- Read/write plots to .hdf5 files.
`CMDimCircuits.jl` is registered with Julia's **General** registry.
It can be installed using Julia's built-in package manager:
```julia
julia> ]
pkg> add CMDimCircuits
pkg> add CMDimData
pkg> add MDDatasets
```
Note that `CMDimData.jl` & `MDDatasets.jl` will automatically be installed alongside `CMDimCircuits.jl`. However, `add`-ing them explicitly gives code from the active project/environment direct access to their corresponding features.
Moreover, it is highly suggested to install `InspectDR.jl`. It is the most tested integration for plotting at the moment:
```julia
julia> ]
pkg> add InspectDR
```
## Activating the "C-Data" environment
The "C-Data" environment provides a collection of tools to generate/process
parametric analysis data & better visualize (see) mathematical relationships
buried within. To activate C-Data, you must call the `@using_CData` macro:
```julia
using CMDimCircuits
CMDimCircuits.@using_CData
```
Note that `CMDimCircuits.@using_CData` imports the following modules to your scope:
```julia
using MDDatasets
using CMDimData
using CMDimData.EasyPlot
using CMDimCircuits.CircuitAnalysis
using CMDimCircuits.NetwAnalysis
using CMDimCircuits.SignalProcessing
using CMDimCircuits.EDAData
```
Note that no plotting backend was imported. You must therefore "import" your
preferred plotting library using the procedure
[described here][CMDimDataJL_ImpBk].
## Sample usage
Examples of how to use `CMDimCircuits.jl` are provided in the [sample/](sample) subdirectory.
A few examples are organized by module:
- Use of `CMDimCircuits.NetwAnalysis`: [sample/NetwAnalysis/](sample/NetwAnalysis)
- Use of `CMDimCircuits.SignalProcessing`: [sample/SignalProcessing/](sample/SignalProcessing)
**Galleries:** [:art: ./sample/SignalProcessing][GallerySProc] (might be out of date).
### Tip: Querying available method signatures
In Julia, a good way to see the methods available for a particular function is to run:
```julia
julia> methods([FUNCTION_NAME])
```
Given the multitude of optional/keyword agruments in some functions, it is
currently best to take a look at the samples provided [above](#SampleUsage).
### [TODO](TODO.md)
### Compatibility
Extensive compatibility testing of the CMDimCircuits.jl package has not been
performed. It has been tested in the following environment(s):
- Windows 10 / Linux / Julia-1.3.1
## Disclaimer
The CMDimCircuits.jl package is not yet mature. Expect significant changes.