Ready for v2.2 release

README.rst

@@ -109,28 +109,44 @@ Below are the high-level tools currently available:
 
             from pylinac import tg51, trs398
 
-            tg51_6x = tg51.TG51Photon(temp=TEMP, press=PRESS, model=CHAMBER,
-                                      n_dw=ND_w, p_elec=P_ELEC,
-                                      measured_pdd=66.4, lead_foil=None,
-                                      clinical_pdd=66.5, energy=ENERGY,
-                                      volt_high=-300, volt_low=-150,
-                                      m_raw=(25.65, 25.66, 25.65),
-                                      m_opp=(25.64, 25.65, 25.65),
-                                      m_low=(25.64, 25.63, 25.63),
-                                      mu=MU, tissue_correction=1.0)
+            ENERGY = 6
+            TEMP = 22.1
+            PRESS = tg51.mmHg2kPa(755.0)
+            CHAMBER = '30013'  # PTW
+            P_ELEC = 1.000
+            ND_w = 5.443  # Gy/nC
+            MU = 200
+            CLINICAL_PDD = 66.5
+
+            tg51_6x = tg51.TG51Photon(
+                unit='TrueBeam1',
+                chamber=CHAMBER,
+                temp=TEMP, press=PRESS,
+                n_dw=ND_w, p_elec=P_ELEC,
+                measured_pdd10=66.4, lead_foil=None,
+                clinical_pdd10=66.5, energy=ENERGY,
+                voltage_reference=-300, voltage_reduced=-150,
+                m_reference=(25.65, 25.66, 25.65),
+                m_opposite=(25.64, 25.65, 25.65),
+                m_reduced=(25.64, 25.63, 25.63),
+                mu=MU, tissue_correction=1.0
+            )
 
             # Done!
             print(tg51_6x.dose_mu_dmax)
 
             # examine other parameters
-            tg51_6x.pddx
-            tg51_6x.kq
-            tg51_6x.p_ion
+            print(tg51_6x.pddx)
+            print(tg51_6x.kq)
+            print(tg51_6x.p_ion)
 
             # change readings if you adjust output
-            tg51_6x.m_raw = (25.44, 25.44, 25.43)
+            tg51_6x.m_reference_adjusted = (25.44, 25.44, 25.43)
             # print new dose value
-            print(tg51_6x.dose_mu_dmax)
+            print(tg51_6x.dose_mu_dmax_adjusted)
+
+            # generate a PDF for record-keeping
+            tg51_6x.publish_pdf('TB1 6MV TG-51.pdf', notes=['My notes', 'I used Pylinac to do this; so easy!'], open_file=False)
 
             # TRS-398 is very similar and just as easy!
 

docs/source/changelog.rst

@@ -9,7 +9,7 @@ V 2.2.0
 General
 ^^^^^^^
 
-* Typing has been added to almost every function and class in pylinac.
+* `#131 <https://github.com/jrkerns/pylinac/issues/131>`_ Typing has been added to almost every function and class in pylinac.
 * F-strings have been incorporated. This bumps the minimum version for Python to 3.6.
 * The ``publish_pdf`` method of every module has had its signature changed. Before, not all the signatures matched
   and only included a few parameters like author and unit name. This has been changed to
@@ -20,6 +20,8 @@ General
 * A TRS-398 calibration module has been created :ref:`trs398`.
 * The default colormap for arrays is now Viridis, the matplotlib default.
 * A contributer's guide has been added: :ref:`contributer_guide`.
+* `#141 <https://github.com/jrkerns/pylinac/issues/141>`_ The Pylinac logo has been included in the package so that PDFs can be generated without needing www access.
+* A new dependency has been added: `argue <https://pypi.org/project/argue/>` which handles input parameters.
 
 
 Flatness & Symmetry
@@ -32,7 +34,7 @@ VMAT
 ^^^^
 
 * The overall simplicity of use has been increased by automating & removing several parameters.
-* The ``VMAT`` class has been split into two classes: :class:`~pylinac.vmat.DRGS` and :class:`~pylinac.vmat.DRMLC`. Although there are now two classes
+* `#128 <https://github.com/jrkerns/pylinac/issues/128>`_ The ``VMAT`` class has been split into two classes: :class:`~pylinac.vmat.DRGS` and :class:`~pylinac.vmat.DRMLC`. Although there are now two classes
   instead of one, the overall simplicity has been increased, such as the following:
 
   * The ``test`` parameter in ``analyze()`` is no longer required and has been removed.
@@ -48,7 +50,7 @@ VMAT
 TG-51/Calibration
 ^^^^^^^^^^^^^^^^^
 
-* The TG-51 module has been refactored to add a ``TG51ElectronLegacy`` and ``TG51ElectronModern`` calibration class.
+* `#129 <https://github.com/jrkerns/pylinac/issues/129>`_ The TG-51 module has been refactored to add a ``TG51ElectronLegacy`` and ``TG51ElectronModern`` calibration class.
   The Legacy class uses the classic TG-51 values that require a kecal value and a Pgradient measurement. The Modern
   class uses the equations from Muir & Rogers 2014 to calculate kQ that updates and incorporates the Pgradient and
   kecal values. While not strictly TG-51, these values are very likely to be incorporated into the next TG-51 addendum
@@ -62,7 +64,7 @@ TG-51/Calibration
   This can be used in either TG-51 or TRS-398 to get TPR without actually needing to measure it.
 * Defaults were removed from most functions to avoid possible miscalibration/miscalculation.
 * Most parameters were changed to be keyword only. This will prevent accidental miscalculations from simple positional arguments.
-* A TRS-398 module has been added. There are two main classes: ``TRS398Photon`` and ``TRS398Electron``.
+* `#127 <https://github.com/jrkerns/pylinac/issues/127>`_ A TRS-398 module has been added. There are two main classes: ``TRS398Photon`` and ``TRS398Electron``.
 
 Bug Fixes
 ^^^^^^^^^