Merge pull request #220 from analogdevicesinc/tfcollins/pre-rel

Add nox release session

Author: tfcollins

doc/source/index.md

@@ -1,6 +1,6 @@
 # pyadi-jif: Python interface for the ADI JESD Interface Framework
 
-This project tries to simplify JESD204 configuration exploration and validation for ADI JESD based converters and clock chips with different FPGA vendors.
+**pyadi-jif** is a Python modeling and configuration tool that simplifies JESD204 interface setup for Analog Devices converters, clock chips, and FPGAs. It can automatically solve for valid clock divider settings and JESD204 link parameters at both the individual component level and across a complete system.
 
 ```{image} _static/logos/PyADI-JIF_logo_w_cropped.png?://
 :class: only-dark
@@ -53,6 +53,63 @@ This project tries to simplify JESD204 configuration exploration and validation
 :width: 75%
 ```
 
+## What is pyadi-jif?
+
+JESD204 is a high-speed serial interface standard used to connect data converters (ADCs and DACs) to FPGAs. Configuring a JESD204 system requires coordinating clock frequencies, lane rates, and link parameters across multiple chips simultaneously — a process that is error-prone when done manually.
+
+**pyadi-jif** models the constraints of each component (converter, clock chip, FPGA transceiver) and uses a constraint solver to automatically find valid configurations. It supports both:
+
+- **Component-level** use: configure a single clock chip or verify an existing setup in isolation.
+- **System-level** use: solve for a complete, consistent configuration across converter + clock + FPGA together.
+
+## Key Features
+
+- Automatic constraint solving for JESD204B/C clock and link parameters
+- Models for ADI converters (ADCs, DACs, MxFEs), clock chips (HMC7044, AD9523-1, AD9545), and FPGA transceivers (Xilinx, Intel)
+- Interactive web-based **JIF Tools Explorer** (`jiftools`) for graphical configuration and exploration
+- MCP server for AI assistant integration
+- Clock tree and system block diagram generation
+
+## Quick Start
+
+Install with pip and launch the interactive tools:
+
+```bash
+pip install 'pyadi-jif[cplex,tools,draw]'
+jiftools
+```
+
+Or use the Python API directly:
+
+```python
+import adijif
+
+# System-level: solve converter + clock + FPGA together
+sys = adijif.system("ad9680", "ad9523_1", "xilinx", vcxo=125e6)
+sys.converter.sample_clock = 1e9
+sys.converter.decimation = 1
+sys.converter.L = 4
+sys.converter.M = 2
+sys.converter.N = 14
+sys.converter.Np = 16
+sys.converter.K = 32
+sys.converter.F = 1
+sys.fpga.setup_by_dev_kit_name("zc706")
+config = sys.solve()
+```
+
+See [Installation](install.md) for full setup instructions, and [Usage Flows](flow.md) for detailed examples.
+
+## Interactive Tools
+
+The **JIF Tools Explorer** (`jiftools`) is a Streamlit web application with three tools:
+
+- **JESD204 Mode Selector** — browse and filter valid JESD204 modes for a given converter and sample rate
+- **Clock Configurator** — configure ADI clock chips to generate required output clocks
+- **System Configurator** — end-to-end configuration of converter + clock chip + FPGA
+
+See the [Quick Start Guide](tools_quickstart.md) and [full tools documentation](tools.md).
+
 ```{toctree}
 :maxdepth: 1
 :caption: Contents:

noxfile.py

@@ -294,6 +294,57 @@ def release(session: Session) -> None:
     session.run("uv", "build")
 
 
+@nox.session(python=main_python, venv_backend="none")
+def create_release(session: Session) -> None:
+    """Bump version, commit, tag, and push. Usage: nox -s create_release -- [patch|minor|major]"""
+    import re
+
+    bump_type = (session.posargs or ["patch"])[0]
+    if bump_type not in ("patch", "minor", "major"):
+        session.error(f"Invalid bump type '{bump_type}'. Use patch, minor, or major.")
+
+    with open("pyproject.toml") as f:
+        toml_content = f.read()
+
+    match = re.search(r'^version = "(\d+)\.(\d+)\.(\d+)"', toml_content, re.MULTILINE)
+    if not match:
+        session.error("Could not find version in pyproject.toml")
+
+    major, minor, patch = int(match.group(1)), int(match.group(2)), int(match.group(3))
+
+    if bump_type == "major":
+        major, minor, patch = major + 1, 0, 0
+    elif bump_type == "minor":
+        minor, patch = minor + 1, 0
+    else:
+        patch += 1
+
+    old_version = f"{match.group(1)}.{match.group(2)}.{match.group(3)}"
+    new_version = f"{major}.{minor}.{patch}"
+    print(f"Bumping {bump_type}: {old_version} -> {new_version}")
+
+    with open("pyproject.toml", "w") as f:
+        f.write(toml_content.replace(f'version = "{old_version}"', f'version = "{new_version}"', 1))
+
+    with open("adijif/__init__.py") as f:
+        init_content = f.read()
+    with open("adijif/__init__.py", "w") as f:
+        f.write(init_content.replace(f'__version__ = "{old_version}"', f'__version__ = "{new_version}"', 1))
+
+    with open("setup.cfg") as f:
+        cfg_content = f.read()
+    with open("setup.cfg", "w") as f:
+        f.write(cfg_content.replace(f"current_version = {old_version}", f"current_version = {new_version}", 1))
+
+    tag = f"v{new_version}"
+    session.run("git", "add", "pyproject.toml", "adijif/__init__.py", "setup.cfg", external=True)
+    session.run("git", "commit", "-m", f"Bump version: {old_version} -> {new_version}", external=True)
+    session.run("git", "tag", tag, external=True)
+    session.run("git", "push", external=True)
+    session.run("git", "push", "--tags", external=True)
+    print(f"Released {tag}")
+
+
 @nox.session(python=main_python)
 def teste2e(session: Session) -> None:
     """Run E2E tests with Playwright."""

setup.cfg

@@ -3,9 +3,9 @@ current_version = 0.1.4
 commit = True
 tag = True
 
-[bumpversion:file:setup.py]
-search = version='{current_version}'
-replace = version='{new_version}'
+[bumpversion:file:pyproject.toml]
+search = version = "{current_version}"
+replace = version = "{new_version}"
 
 [bumpversion:file:adijif/__init__.py]
 search = __version__ = '{current_version}'