Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

📚 Improve uv migration docs #124

Merged
merged 1 commit into from
Aug 22, 2024
Merged

📚 Improve uv migration docs #124

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 5 additions & 17 deletions docs/examples/07_full_flow_demo_electronic_photonic/07_full_flow_demo_electronic_photonic.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,30 +8,23 @@

# ## 1a. Configuring our `piel` Project

# You can install `piel` directly via `pip`, or use the provided `poetry` lockfile-controlled environment directly from `git`.
# You can install `piel` directly via `pip`, or use the provided `uv` lockfile-controlled environment directly from `git`.
#

# All the imports we will need throughout this flows.

# +
# We begin by importing a parametric circuit from `gdsfactory`:
import jax.numpy as jnp
import hdl21 as h
import gdsfactory as gf
import numpy as np
import pandas as pd
import piel
import sax
import sys

from piel.models.physical.photonic import (
mzi2x2_2x2_phase_shifter,
component_lattice_generic,
)

from piel.integration.amaranth_openlane import (
layout_truth_table_through_openlane,
)

# -

Expand Down Expand Up @@ -83,8 +76,6 @@


def create_switch_fabric():
from gdsfactory.generic_tech import get_generic_pdk

PDK = get_generic_pdk()
PDK.activate()
# CURRENT TODO: Create a basic chain fabric and verify the logic is implemented properly with binary inputs.
Expand Down Expand Up @@ -115,9 +106,9 @@ def create_switch_fabric():
type="optical_logic_verification"
)
# A specific custom addition to our application:
optical_logic_verification_models[
"straight_heater_metal_undercut_length200"
] = optical_logic_verification_models["straight_heater_metal_undercut"]
optical_logic_verification_models["straight_heater_metal_undercut_length200"] = (
optical_logic_verification_models["straight_heater_metal_undercut"]
)

# Now, we need to compute our transmission information accordingly for a given set of optical inputs:

Expand Down Expand Up @@ -544,7 +535,6 @@ def create_switch_fabric():
# ## 4b. Composing and Equivalent-Circuit Modelling

# +
from gdsfactory.generic_tech import get_generic_pdk

our_resistive_heater_netlist = straight_heater_metal_simple().get_netlist(
allow_multiple=True, exclude_port_types="optical"
Expand All @@ -571,9 +561,7 @@ class TransientTb:
rise=10 * h.prefix.m,
fall=10 * h.prefix.m,
width=75 * h.prefix.m,
)(
n=VSS
) # A configured voltage pulse source
)(n=VSS) # A configured voltage pulse source

# Our component under test
dut = example_straight_resistor()
Expand Down
7 changes: 3 additions & 4 deletions docs/sections/environment/installation.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,11 +49,11 @@ Once you have a copy of the source, you can install it with:

$ pip install -e .

You can install our exact supported dependencies in a poetry-managed environment by:
You can install our exact supported dependencies in a `uv`-managed environment by:

.. code:: console

$ poetry install
$ uv pip install piel

Developer’s Requirements
~~~~~~~~~~~~~~~~~~~~~~~~
Expand All @@ -64,8 +64,7 @@ documentation, and full environment:
.. code:: bash

mamba install pandoc
mamba install jupyterlab jupytext
poetry install -E dev
uv pip install -e .[dev]


Usage
Expand Down
Loading