paramrf 0.18.2__tar.gz → 0.18.3__tar.gz

{paramrf-0.18.2/paramrf.egg-info → paramrf-0.18.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: paramrf
-Version: 0.18.2
+Version: 0.18.3
 Summary: Parametric radio frequency modeling, optimization and sampling
 Author-email: Gary Allen <gvcallen@gmail.com>
 Project-URL: homepage, https://github.com/gvcallen/paramrf
@@ -91,11 +91,10 @@ The example below shows how to define and optimize a simple RLC model to satisfy
 .. code-block:: python
 
   import pmrf as prf
-  from pmrf.parameters import Scaled
   from pmrf.models import Resistor, Inductor, Capacitor
   
   freq = prf.Frequency(1, 10, 101, 'GHz')
-  rlc_model = Resistor(50) ** Inductor(Scaled(1.0, 1e-9)) ** Capacitor(Scaled(1.0, 1e-12))
+  rlc_model = Resistor(50) ** Inductor(prf.Scaled(1.0, 1e-9)) ** Capacitor(prf.Scaled(1.0, 1e-12))
   
   opt_freq = prf.Frequency(4, 6, 101, 'GHz')
   goal = prf.evaluators.Goal('s11_db', '<', -20)

{paramrf-0.18.2 → paramrf-0.18.3}/README.rst

@@ -52,11 +52,10 @@ The example below shows how to define and optimize a simple RLC model to satisfy
 .. code-block:: python
 
   import pmrf as prf
-  from pmrf.parameters import Scaled
   from pmrf.models import Resistor, Inductor, Capacitor
   
   freq = prf.Frequency(1, 10, 101, 'GHz')
-  rlc_model = Resistor(50) ** Inductor(Scaled(1.0, 1e-9)) ** Capacitor(Scaled(1.0, 1e-12))
+  rlc_model = Resistor(50) ** Inductor(prf.Scaled(1.0, 1e-9)) ** Capacitor(prf.Scaled(1.0, 1e-12))
   
   opt_freq = prf.Frequency(4, 6, 101, 'GHz')
   goal = prf.evaluators.Goal('s11_db', '<', -20)

{paramrf-0.18.2 → paramrf-0.18.3}/docs/api/index.rst

@@ -23,6 +23,13 @@ Core
    pmrf.Frequency
    pmrf.Param
    pmrf.param
+   pmrf.as_param
+   pmrf.Free
+   pmrf.Fixed
+   pmrf.Scaled
+   pmrf.Bounded
+   pmrf.Constrained
+   pmrf.Random
 
 Modules
 -------------

{paramrf-0.18.2 → paramrf-0.18.3}/docs/core_concepts/model_building.rst

@@ -153,7 +153,6 @@ As a last resort, overriding ``__init__`` is still possible, but ``super().__ini
 .. code-block:: python
 
   import pmrf as prf
-  from pmrf.parameters import Bounded
   from pmrf.models import Capacitor, Inductor, Circuit, Port, Ground
   
   import jax.numpy as jnp
@@ -163,8 +162,8 @@ As a last resort, overriding ``__init__`` is still possible, but ``super().__ini
   
       # To be instantiated in post init
       cap1: Capacitor = prf.field(default=None)
-      cap2: Capacitor = Capacitor(C=Bounded(0.0, 10.0, value=2.0, scale=1e-12))
-      ind: Inductor = Inductor(L=Bounded(0.0, 10.0, value=2.0, scale=1e-12))
+      cap2: Capacitor = Capacitor(C=prf.Bounded(0.0, 10.0, value=2.0, scale=1e-12))
+      ind: Inductor = Inductor(L=prf.Bounded(0.0, 10.0, value=2.0, scale=1e-12))
   
       def __post_init__(self, C1_divided_by_5: float):
           self.cap1 = Capacitor(C1_divided_by_5 * 5.0)

{paramrf-0.18.2 → paramrf-0.18.3}/docs/quickstart.rst

@@ -20,14 +20,13 @@ Models can easily be built using composition with the built in :mod:`pmrf.models
 .. code-block:: python
 
   import pmrf as prf
-  from pmrf.parameters import Scaled
   from pmrf.models import Resistor, Inductor, Capacitor
   
   # Define the frequency band
   freq = prf.Frequency(1, 10, 101, 'GHz')
   
   # Cascade elements using the ** operator
-  rlc_model = Resistor(50) ** Inductor(Scaled(1.0, 1e-9)) ** Capacitor(Scaled(1.0, 1e-12))
+  rlc_model = Resistor(50) ** Inductor(prf.Scaled(1.0, 1e-9)) ** Capacitor(prf.Scaled(1.0, 1e-12))
   
   # Plot the model's S11 parameter
   rlc_model.plot_s_db(freq, m=0, n=0)