diff --git a/.gitattributes b/.gitattributes new file mode 100644 index 000000000..ec4f6521b --- /dev/null +++ b/.gitattributes @@ -0,0 +1 @@ +pysmurf/_version.py export-subst diff --git a/.gitignore b/.gitignore index 94c4b20a2..8e0444971 100644 --- a/.gitignore +++ b/.gitignore @@ -1,4 +1,25 @@ *.pyc *.py~ *.dat -*.png \ No newline at end of file +*.png + +# Distribution / packaging +.Python +env/ +build/ +develop-eggs/ +dist/ +downloads/ +eggs/ +.eggs/ +lib/ +lib64/ +parts/ +sdist/ +var/ +wheels/ +*.egg-info/ +.installed.cfg +*.egg + +.idea/ \ No newline at end of file diff --git a/.readthedocs.yml b/.readthedocs.yml new file mode 100644 index 000000000..6822acaca --- /dev/null +++ b/.readthedocs.yml @@ -0,0 +1,21 @@ +# .readthedocs.yml +# Read the Docs configuration file +# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details + +# Required +version: 2 + +# Build documentation in the docs/ directory with Sphinx +sphinx: + configuration: docs/conf.py + +# Optionally build your docs in additional formats such as PDF and ePub +formats: all + +# Optionally set the version of Python and requirements required to build your docs +python: + version: 3.7 + install: + - requirements: requirements.txt + - method: pip + path: . diff --git a/LICENSE.txt b/LICENSE.txt new file mode 100644 index 000000000..445d7be95 --- /dev/null +++ b/LICENSE.txt @@ -0,0 +1,40 @@ +Copyright (c) 2019, The Board of Trustees of the Leland Stanford Junior +University, through SLAC National Accelerator Laboratory (subject to receipt +of any required approvals from the U.S. Dept. of Energy). All rights reserved. +Redistribution and use in source and binary forms, with or without +modification, are permitted provided that the following conditions are met: + +(1) Redistributions of source code must retain the above copyright notice, + this list of conditions and the following disclaimer. + +(2) Redistributions in binary form must reproduce the above copyright notice, + this list of conditions and the following disclaimer in the documentation + and/or other materials provided with the distribution. + +(3) Neither the name of the Leland Stanford Junior University, SLAC National + Accelerator Laboratory, U.S. Dept. of Energy nor the names of its + contributors may be used to endorse or promote products derived from this + software without specific prior written permission. + +THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND +ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED +WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE +DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER, THE UNITED STATES GOVERNMENT, +OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, +EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT +OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS +INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN +CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING +IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY +OF SUCH DAMAGE. + +You are under no obligation whatsoever to provide any bug fixes, patches, or +upgrades to the features, functionality or performance of the source code +("Enhancements") to anyone; however, if you choose to make your Enhancements +available either publicly, or directly to SLAC National Accelerator Laboratory, +without imposing a separate written license agreement for such Enhancements, +then you hereby grant the following license: a non-exclusive, royalty-free +perpetual license to install, use, modify, prepare derivative works, incorporate +into other computer software, distribute, and sublicense such Enhancements or +derivative works thereof, in binary and source code form. + diff --git a/MANIFEST.in b/MANIFEST.in new file mode 100644 index 000000000..b915e182e --- /dev/null +++ b/MANIFEST.in @@ -0,0 +1,2 @@ +include versioneer.py +include pysmurf/_version.py diff --git a/README.md b/README.md index b373165f7..1e3ed12a2 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,32 @@ # pysmurf -The python control software for SMuRF. Includes scripts to do low level commands as well as higher level analysis. + +[![Documentation Status](https://readthedocs.org/projects/pysmurf/badge/?version=latest)](https://pysmurf.readthedocs.io/en/latest/?badge=latest) + +The python control software for SMuRF. Includes scripts to do low level +commands as well as higher level analysis. + +## Installation +To install pysmurf clone this repository and install using pip: + +``` +git clone https://github.com/slaclab/pysmurf.git +cd pysmurf/ +pip3 install -r requirements.txt +pip3 install . +``` + +## Documentation +Documentation is built using Sphinx, and follows the +[Google Style Docstrings][1]. To build the documentation first install the +pysmurf package, then run: + +``` +cd docs/ +make html +``` + +Output will be located in `_build/html`. You can view the compiled +documentation by opening `_build/html/index.html` in the browser of your +choice. + +[1]: https://sphinxcontrib-napoleon.readthedocs.io/en/latest/example_google.html diff --git a/__init__.py b/__init__.py deleted file mode 100644 index 80fd2c34e..000000000 --- a/__init__.py +++ /dev/null @@ -1,4 +0,0 @@ -''' -init for root python directory -''' -from .base.smurf_control import SmurfControl diff --git a/base/__init__.py b/base/__init__.py deleted file mode 100644 index 50fbe8477..000000000 --- a/base/__init__.py +++ /dev/null @@ -1,4 +0,0 @@ -''' -init for base -''' -from .base_class import SmurfBase \ No newline at end of file diff --git a/cfg_files/rflab/experiment_rflab_thermal_testing_201907.cfg b/cfg_files/rflab/experiment_rflab_thermal_testing_201907.cfg index 42162d53d..a119c337f 100644 --- a/cfg_files/rflab/experiment_rflab_thermal_testing_201907.cfg +++ b/cfg_files/rflab/experiment_rflab_thermal_testing_201907.cfg @@ -298,6 +298,16 @@ # For Stanford 5-6ghz 528 box in FP29, with a standard (not # modified for high current) RTM "fraction_full_scale": 0.495, + "delta_freq" : { + "0" : 0.02, + "1" : 0.02, + "2" : 0.02, + "3" : 0.02, + "4" : 0.02, + "5" : 0.02, + "6" : 0.02, + "7" : 0.02 + }, "lms_freq": { "0" : 16500, "1" : 16500, @@ -308,16 +318,6 @@ "6" : 16500, "7" : 16500 }, - "delta_freq" : { - "0" : 0.02, - "1" : 0.02, - "2" : 0.02, - "3" : 0.02, - "4" : 0.02, - "5" : 0.02, - "6" : 0.02, - "7" : 0.02 - }, # The fraction of each flux ramp cycle above which we start # applying feedback, within each cycle. Must be >0. If >1, # then You want this to be large enough to mask the transient @@ -346,14 +346,14 @@ "7" : 0.98 }, "gradient_descent_gain": { - "0" : 1e-5, - "1" : 1e-5, - "2" : 1e-5, - "3" : 1e-5, - "4" : 1e-5, - "5" : 1e-5, - "6" : 1e-5, - "7" : 1e-5 + "0" : 1e-4, + "1" : 1e-4, + "2" : 1e-4, + "3" : 1e-4, + "4" : 1e-4, + "5" : 1e-4, + "6" : 1e-4, + "7" : 1e-4 }, "gradient_descent_averages": { "0" : 1, @@ -365,6 +365,66 @@ "6" : 1, "7" : 1 }, + "gradient_descent_converge_hz": { + "0" : 500, + "1" : 500, + "2" : 500, + "3" : 500, + "4" : 500, + "5" : 500, + "6" : 500, + "7" : 500 + }, + "gradient_descent_step_hz": { + "0" : 1000, + "1" : 1000, + "2" : 1000, + "3" : 1000, + "4" : 1000, + "5" : 1000, + "6" : 1000, + "7" : 1000 + }, + "gradient_descent_beta": { + "0" : 0, + "1" : 0, + "2" : 0, + "3" : 0, + "4" : 0, + "5" : 0, + "6" : 0, + "7" : 0 + }, + "gradient_descent_momentum": { + "0" : 1, + "1" : 1, + "2" : 1, + "3" : 1, + "4" : 1, + "5" : 1, + "6" : 1, + "7" : 1 + }, + "eta_scan_del_f": { + "0": 5000, + "1": 5000, + "2": 5000, + "3": 5000, + "4": 5000, + "5": 5000, + "6": 5000, + "7": 5000 + }, + "eta_scan_amplitude":{ + "0" : 12, + "1" : 12, + "2" : 12, + "3" : 12, + "4" : 12, + "5" : 12, + "6" : 12, + "7" : 12 + }, "eta_scan_averages": { "0" : 1, "1" : 1, diff --git a/cfg_files/stanford/README.md b/cfg_files/stanford/README.md new file mode 100644 index 000000000..6036bda40 --- /dev/null +++ b/cfg_files/stanford/README.md @@ -0,0 +1,69 @@ +# Stanford pysmurf cfg file index + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
cfg fileDescription
Frankenpolar Run 29 pysmurf configuration files
experiment_fp29_cc02-02_lbOnlyBay0.cfg + For use with cryostat card C02-02. Configures only 4x 500MHz + bands. To be used with single bay fw versions. Assumes only 1x + LB AMC is installed in bay 0. Configures for backplane timing + (timing master must be installed in slot 2 of the same crate). +
experiment_fp29_cc02-02_hbOnlyBay0.cfg + For use with cryostat card C02-02. Configures only 4x 500MHz + bands. To be used with single bay fw versions. Assumes only 1x + HB AMC is installed in bay 0. Configures for backplane timing + (timing master must be installed in slot 2 of the same crate). +
experiment_fp29_cc02-02_fullBand.cfg + For use with cryostat card C02-02. Configures all eight 500MHz + bands. Configures for external (front-panel) 122.88 MHz + reference. +
Frankenpolar Run 30 pysmurf configuration files
experiment_fp30_srv03_rfsoc.cfg + Test cfg used to take noise data with the RFSoC on cold + resonators. +
experiment_fp30_cc02-03_lbOnlyBay0.cfg + For use with cryostat card C02-03. Configures only 4x 500MHz + bands. To be used with single bay fw versions. Assumes only 1x + LB AMC is installed in bay 0. Configures for backplane timing + (timing master must be installed in slot 2 of the same crate). +
+ diff --git a/cfg_files/stanford/smurf-srv10/experiment_fp29_srv10_dspv3_cc02-02.cfg b/cfg_files/stanford/experiment_fp29_cc02-02_fullBand.cfg similarity index 100% rename from cfg_files/stanford/smurf-srv10/experiment_fp29_srv10_dspv3_cc02-02.cfg rename to cfg_files/stanford/experiment_fp29_cc02-02_fullBand.cfg diff --git a/cfg_files/stanford/smurf-srv10/experiment_fp29_srv10_dspv3_cc02-02_hbOnlyBay0.cfg b/cfg_files/stanford/experiment_fp29_cc02-02_hbOnlyBay0.cfg similarity index 100% rename from cfg_files/stanford/smurf-srv10/experiment_fp29_srv10_dspv3_cc02-02_hbOnlyBay0.cfg rename to cfg_files/stanford/experiment_fp29_cc02-02_hbOnlyBay0.cfg diff --git a/cfg_files/stanford/smurf-srv10/experiment_fp29_srv10_dspv3_cc02-02_lbOnlyBay0.cfg b/cfg_files/stanford/experiment_fp29_cc02-02_lbOnlyBay0.cfg similarity index 100% rename from cfg_files/stanford/smurf-srv10/experiment_fp29_srv10_dspv3_cc02-02_lbOnlyBay0.cfg rename to cfg_files/stanford/experiment_fp29_cc02-02_lbOnlyBay0.cfg diff --git a/cfg_files/stanford/smurf-srv03/experiment_fp29_srv03_dspv3_cc02-02_lbOnlyBay0.cfg b/cfg_files/stanford/experiment_fp30_cc02-03_lbOnlyBay0.cfg similarity index 62% rename from cfg_files/stanford/smurf-srv03/experiment_fp29_srv03_dspv3_cc02-02_lbOnlyBay0.cfg rename to cfg_files/stanford/experiment_fp30_cc02-03_lbOnlyBay0.cfg index f815dbf79..8c3ffffbd 100644 --- a/cfg_files/stanford/smurf-srv03/experiment_fp29_srv03_dspv3_cc02-02_lbOnlyBay0.cfg +++ b/cfg_files/stanford/experiment_fp30_cc02-03_lbOnlyBay0.cfg @@ -2,35 +2,54 @@ "epics_root" : "test_epics", "init": { - "bands" : [2,3], "dspEnable": 1, + "band_0" : { + "iq_swap_in" : 0, + "iq_swap_out" : 0, + # Measured for 8234f45 by SWH on 8/1/19 + "refPhaseDelay" : 6, + "refPhaseDelayFine" : 16, + "trigRstDly" : 15, # 0xF + "feedbackEnable": 1, + "feedbackGain" : 256, + "feedbackPolarity" : 1, + "feedbackLimitkHz": 225, + "lmsGain": 6, + "att_uc": 24, + "att_dc": 0, + "amplitude_scale": 12 + }, + + "band_1" : { + "iq_swap_in" : 0, + "iq_swap_out" : 0, + # Measured for 8234f45 by SWH on 8/1/19 + "refPhaseDelay" : 6, + "refPhaseDelayFine" : 19, + "trigRstDly" : 15, # 0xF + "feedbackEnable": 1, + "feedbackGain" : 256, + "feedbackPolarity" : 1, + "feedbackLimitkHz": 225, + "lmsGain": 6, + "att_uc": 24, + "att_dc": 0, + "amplitude_scale": 12 + }, + "band_2" : { "iq_swap_in" : 0, "iq_swap_out" : 0, + # Measured for 8234f45 by SWH on 8/1/19 "refPhaseDelay" : 6, - "refPhaseDelayFine" : 0, - # Matches system latency for LMS feedback (multiplex - # of 52x 9.6MHz ticks) Adjust to match refPhaseDelay*4 - # (e.g. if refPhaseDelay = 6, lmsDelay = 24). Mitch - # is checking this ; might not be refPhaseDelay*4 - - # need to revisit. - "lmsDelay" : 24, - # Adjust trigRstDly such that the ramp resets at the - # flux ramp glitch. Not totally clear at the moment - # what that means. + "refPhaseDelayFine" : 11, "trigRstDly" : 15, # 0xF - "toneScale" : 2, - "analysisScale" : 3, "feedbackEnable": 1, "feedbackGain" : 256, "feedbackPolarity" : 1, - "synthesisScale": 2, "feedbackLimitkHz": 225, - "lmsGain": 7, - "rfEnable": 1, - "bandCenterMHz": 5250, - "data_out_mux" : [6, 7], + "lmsGain": 6, "att_uc": 24, "att_dc": 0, "amplitude_scale": 12 @@ -39,29 +58,15 @@ "band_3" : { "iq_swap_in" : 0, "iq_swap_out" : 0, + # Measured for 8234f45 by SWH on 8/1/19 "refPhaseDelay" : 6, - "refPhaseDelayFine" : 0, - # Matches system latency for LMS feedback (multiplex - # of 52x 9.6MHz ticks) Adjust to match refPhaseDelay*4 - # (e.g. if refPhaseDelay = 6, lmsDelay = 24). Mitch - # is checking this ; might not be refPhaseDelay*4 - - # need to revisit. - "lmsDelay": 24, - # Adjust trigRstDly such that the ramp resets at the - # flux ramp glitch. Not totally clear at the moment - # what that means. + "refPhaseDelayFine" : 16, "trigRstDly" : 15, # 0xF - "toneScale" : 2, - "analysisScale" : 3, "feedbackEnable": 1, "feedbackGain" : 256, "feedbackPolarity" : 1, - "synthesisScale": 2, "feedbackLimitkHz": 225, - "lmsGain": 7, - "rfEnable": 1, - "bandCenterMHz": 5750, - "data_out_mux" : [8, 9], + "lmsGain": 6, "att_uc": 24, "att_dc": 0, "amplitude_scale": 12 @@ -71,21 +76,16 @@ "bad_mask" : { }, -"channel_assignment" : { - "band_2" : "/usr/local/controls/Applications/smurf/pysmurf/pysmurf/scratch/shawn/channel_assignment_b2_teses.txt", - "band_3" : "/usr/local/controls/Applications/smurf/pysmurf/pysmurf/scratch/shawn/channel_assignment_b3.txt" -}, - "amplifier": { - "hemt_Vg" : 0.570, - "bit_to_V_hemt" : 1.92e-6, - "hemt_Id_offset" : 0.12891, + "hemt_Vg" : 0.54, + "bit_to_V_hemt" : 3.8592e-06, + "hemt_Id_offset" : 0.16758, "LNA_Vg" : -0.7575, # 32 if using a C02 cryostat card. Some C01s were # kludged to provide a 50k gate voltage for ASU 50K LNAs # in early testing. For those, use 2. "dac_num_50k" : 32, - "bit_to_V_50k" : 3.88e-6, + "bit_to_V_50k" : 3.8592e-06, "hemt_gate_min_voltage" : -1.0, "hemt_gate_max_voltage" : 1.0 }, @@ -149,21 +149,13 @@ "14" : [29,30] }, -"band_to_chip" : { - "1" : [1, 2, 3, 4], - "2" : [5, 6, 7, 8], - "3" : [9, 10, 11, 12], - "4" : [13, 14, 15, 16] -}, - - "R_sh" : 390e-6, -"bias_line_resistance" : 25479, -"high_low_current_ratio" : 12.50, +"bias_line_resistance" : 15800, +"high_low_current_ratio" : 6.08, "high_current_mode_bool": 0, -"all_bias_groups": [3], +"all_bias_groups": [7], "tune_band" : { "n_samples" : 262144, @@ -173,16 +165,27 @@ "freq_min" : -250000000, # For Stanford 5-6ghz 528 box in FP29, with a standard (not # modified for high current) RTM - "fraction_full_scale": 0.495, + "fraction_full_scale": 0.489, + "reset_rate_khz": 4.0, + "delta_freq": { + "0" : 0.02, + "1" : 0.02, + "2" : 0.02, + "3" : 0.02 + }, "lms_freq": { - "2" : 16500, - "3" : 16500 + "0" : 16500, + "1" : 19945, + "2" : 19986, + "3" : 20218 }, # The fraction of each flux ramp cycle above which we start # applying feedback, within each cycle. Must be >0. If >1, # then You want this to be large enough to mask the transient # which occurs after each flux ramp reset. Must be in [0,1). - "feedback_start_frac" : { + "feedback_start_frac" : { + "0" : 0.05, + "1" : 0.05, "2" : 0.05, "3" : 0.05 }, @@ -190,27 +193,70 @@ # applying feedback, within each cycle. Must be >0. If >1, # then feedback over the entire cycle (after feedbackStart). "feedback_end_frac" : { + "0" : 0.98, + "1" : 0.98, "2" : 0.98, "3" : 0.98 - }, + }, "gradient_descent_gain": { - "2" : 1e-5, - "3" : 1e-5 + "0" : 1e-4, + "1" : 1e-4, + "2" : 1e-4, + "3" : 1e-4 }, "gradient_descent_averages": { - "2" : 10, - "3" : 10 + "0" : 1, + "1" : 1, + "2" : 1, + "3" : 1 }, + "gradient_descent_converge_hz":{ + "0" : 500, + "1" : 500, + "2" : 500, + "3" : 500 + }, + "gradient_descent_step_hz":{ + "0" : 1000, + "1" : 1000, + "2" : 1000, + "3" : 1000 + }, + "gradient_descent_momentum":{ + "0" : 1, + "1" : 1, + "2" : 1, + "3" : 1 + }, + "gradient_descent_beta": { + "0" : 0, + "1" : 0, + "2" : 0, + "3" : 0 + }, + "eta_scan_del_f": { + "0": 5000, + "1": 5000, + "2": 5000, + "3": 5000 + }, + "eta_scan_amplitude":{ + "0" : 12, + "1" : 12, + "2" : 12, + "3" : 12 + }, "eta_scan_averages": { - "2" : 10, - "3" : 10 - }, - "default_tune": "/data/smurf_data/tune/1556941499_tune.npy" + "0" : 1, + "1" : 1, + "2" : 1, + "3" : 1 + } + #"default_tune": "/data/smurf_data/tune/1558666435_tune.npy" }, "flux_ramp" : { "select_ramp" : 1, - "ramp_start_mode" : 0, "num_flux_ramp_counter_bits" : 32 }, @@ -221,9 +267,10 @@ "timing" : { # "ext_ref" : internal oscillator locked to an external # front-panel reference, or unlocked if there is no front - # panel reference. (LmkReg_0x0147 : 0x1A) + # panel reference. (LmkReg_0x0147 : 0x1A). Also sets + # flux_ramp_start_mode=0 # "backplane" : takes timing from timing master through - # backplane. + # backplane. Also sets flux_ramp_start_mode=1. "timing_reference" : "backplane" }, @@ -245,11 +292,12 @@ # versios of the DSPv3 fw. May be different for each band, in # mitch_4_30 the offset for band 2 is -2. Mitch plans to fix # in fw, so this should be unnecessary soon. - "mask_channel_offset" : -2 + "mask_channel_offset" : 0 }, "default_data_dir": "/data/smurf_data", -"smurf_cmd_dir": "/data/smurf_data/smurf_cmd", +# For remote commanding +#"smurf_cmd_dir": "/data/smurf_data/smurf_cmd", "tune_dir" : "/data/smurf_data/tune", "status_dir" : "/data/smurf_data/status" } diff --git a/cfg_files/stanford/smurf-srv03/experiment_fp30_srv03_rfsoc.cfg b/cfg_files/stanford/experiment_fp30_srv03_rfsoc.cfg similarity index 100% rename from cfg_files/stanford/smurf-srv03/experiment_fp30_srv03_rfsoc.cfg rename to cfg_files/stanford/experiment_fp30_srv03_rfsoc.cfg diff --git a/cfg_files/stanford/fp30_smurf_startup.cfg b/cfg_files/stanford/fp30_smurf_startup.cfg new file mode 100644 index 000000000..8d132eedf --- /dev/null +++ b/cfg_files/stanford/fp30_smurf_startup.cfg @@ -0,0 +1,31 @@ +shelfmanager=shm-smrf-sp01 + +set_crate_fans_to_full=true +# COMTEL max fan level is 100, ASIS is 15, ELMA is 15 +## COMTEL in RF lab +max_fan_level=100 +## ELMA in RF lab +#max_fan_level=15 +## ASIS in RF lab +#max_fan_level=15 + +attach_at_end=true +screenshot_signal_analyzer=false +configure_pysmurf=true +reboot=true +using_timing_master=true +run_half_band_test=false +write_config=false +start_atca_monitor=true +# still not completely parallel. Also doesn't work. +parallel_setup=false +cpwd=$PWD + +pysmurf=/home/cryo/docker/pysmurf/dev + +crate_id=3 +slots_in_configure_order=(4) + +pysmurf_init_script=scratch/shawn/scripts/init_stanford.py + +tmux_session_name=smurf \ No newline at end of file diff --git a/cfg_files/stanford/smurf-srv03/README.md b/cfg_files/stanford/smurf-srv03/README.md deleted file mode 100644 index f03dc20b7..000000000 --- a/cfg_files/stanford/smurf-srv03/README.md +++ /dev/null @@ -1,8 +0,0 @@ -# Stanford/smurf-srv03 cfg file index - -| cfg file | Description | -| ------------------------------------------------------------------------------------------ | ------------------------------------------------------ | -| [experiment_fp29_srv03_dspv3_cc02-03.cfg](experiment_fp29_srv03_dspv3_cc02-03.cfg) -| Started 6/20/19 by SWH. LB+HB in a C2 carrier. Created just after 6/9/19 NIST CMB+X-ray deployment to continue testing with carrier C2-01. Configures all eight bands over 4-8 GHz. Configures for cryostat card C02-03. Timing from external reference. | -| [experiment_fp29_srv03_dspv3_cc02-03_lbOnlyBay0.cfg](experiment_fp29_srv03_dspv3_cc02-03_lbOnlyBay0.cfg) -| Started 6/21/10 by SWH. For use with LB AMC in bay 0 of any carrier. Configures only bands 0-3. Configures for cryostat card C02-03. Timing from backplane. | \ No newline at end of file diff --git a/cfg_files/stanford/smurf-srv03/experiment_fp28_srv03.cfg b/cfg_files/stanford/smurf-srv03/experiment_fp28_srv03.cfg deleted file mode 100644 index baba9edf3..000000000 --- a/cfg_files/stanford/smurf-srv03/experiment_fp28_srv03.cfg +++ /dev/null @@ -1,149 +0,0 @@ -{ -"epics_root" : "mitch_epics", -"init": { - "bands" : [1,2,3], - "dspEnable": 1, - - "band_1" : { - "iq_swap_in" : 0, - "iq_swap_out" : 0, - "refPhaseDelay" : 6, - "refPhaseDelayFine" : 0, - "toneScale" : 2, - "analysisScale" : 3, - "feedbackEnable": 1, - "feedbackGain" : 256, - "feedbackPolarity" : 1, - "synthesisScale": 3, - "feedbackLimitkHz": 225, - "lmsGain": 7, - "rfEnable": 1, - "bandCenterMHz": 5250, - "data_out_mux" : [2, 3], - "att_uc": 15, - "att_dc": 0 - }, - - "band_2" : { - "iq_swap_in" : 0, - "iq_swap_out" : 0, - "refPhaseDelay" : 6, - "refPhaseDelayFine" : 0, - "toneScale" : 2, - "analysisScale" : 3, - "feedbackEnable": 1, - "feedbackGain" : 256, - "feedbackPolarity" : 1, - "synthesisScale": 3, - "feedbackLimitkHz": 225, - "lmsGain": 7, - "rfEnable": 1, - "bandCenterMHz": 5250, - "data_out_mux" : [6, 7], - "att_uc": 15, - "att_dc": 0 - }, - - "band_3" : { - "iq_swap_in" : 0, - "iq_swap_out" : 0, - "refPhaseDelay" : 6, - "refPhaseDelayFine" : 0, - "toneScale" : 2, - "analysisScale" : 3, - "feedbackEnable": 1, - "feedbackGain" : 256, - "feedbackPolarity" : 1, - "synthesisScale": 3, - "feedbackLimitkHz": 225, - "lmsGain": 7, - "rfEnable": 1, - "bandCenterMHz": 5750, - "data_out_mux" : [8, 9], - "att_uc": 15, - "att_dc": 0 - } -}, - -"amplifier": { -}, - -"attenuator" : { - "att1" : 0, - "att2" : 1, - "att3" : 2, - "att4" : 3 -}, - -"chip_to_freq" : { - "9" : [4.94150, 5.05], - "10" : [5.05, 5.17550 ], - "11" : [5.20150, 5.28250 ], - "12" : [5.28250, 5.41050 ], - "13" : [5.42050, 5.54550 ], - "14" : [5.55150, 5.67650 ], - "15" : [5.66650, 5.79150 ], - "16" : [5.79050, 5.91550 ] -}, - -"pic_to_bias_group": { - "9" : 8, - "11" : 10, - "13" : 12, - "15" : 14, - "14" : 15, - "12" : 13, - "10" : 11, - "8" : 9, - "7" : 6, - "5" : 4, - "3" : 2, - "1" : 0, - "6" : 7, - "4" : 5, - "2" : 3, - "0" : 1 -}, - -"bias_group_to_pair" : { - "8" : [2,1], - "10": [4,3], - "12": [6,5], - "14": [8,7], - "15": [10,9], - "13": [12,11], - "11": [14,13], - "9": [16,15], - "6": [18,17], - "4": [20,19], - "2": [22,21], - "0": [24,23], - "7": [26,25], - "5": [28,27], - "3": [30,29], - "1": [32,31] -}, - -"band_to_chip" : { - "1" : [1, 2, 3, 4], - "2" : [5, 6, 7, 8], - "3" : [9, 10, 11, 12], - "4" : [13, 14, 15, 16] -}, - - -"tune_band" : { - "n_samples" : 262144, - "grad_cut" : 0.05, - "amp_cut" : 0.25, - "freq_max" : 250000000, - "freq_min" : -250000000 -}, - -"constant" : { - "pa_per_phi0" : 0.000009 -}, - -"default_data_dir": "/data/smurf_data", -"smurf_cmd_dir": "/data/smurf_data/smurf_cmd" -} diff --git a/cfg_files/stanford/smurf-srv03/experiment_fp29_srv03_dspv3_cc01-02_lbOnlyBay0.cfg b/cfg_files/stanford/smurf-srv03/experiment_fp29_srv03_dspv3_cc01-02_lbOnlyBay0.cfg deleted file mode 100644 index dc2dd02bb..000000000 --- a/cfg_files/stanford/smurf-srv03/experiment_fp29_srv03_dspv3_cc01-02_lbOnlyBay0.cfg +++ /dev/null @@ -1,256 +0,0 @@ -{ -"epics_root" : "test_epics", -"init": { - - "bands" : [2,3], - "dspEnable": 1, - - "band_2" : { - "iq_swap_in" : 0, - "iq_swap_out" : 0, - "refPhaseDelay" : 6, - "refPhaseDelayFine" : 0, - # Matches system latency for LMS feedback (multiplex - # of 52x 9.6MHz ticks) Adjust to match refPhaseDelay*4 - # (e.g. if refPhaseDelay = 6, lmsDelay = 24). Mitch - # is checking this ; might not be refPhaseDelay*4 - - # need to revisit. - "lmsDelay" : 24, - # Adjust trigRstDly such that the ramp resets at the - # flux ramp glitch. Not totally clear at the moment - # what that means. - "trigRstDly" : 15, # 0xF - "toneScale" : 2, - "analysisScale" : 3, - "feedbackEnable": 1, - "feedbackGain" : 256, - "feedbackPolarity" : 1, - "synthesisScale": 2, - "feedbackLimitkHz": 225, - "lmsGain": 7, - "rfEnable": 1, - "bandCenterMHz": 5250, - "data_out_mux" : [6, 7], - "att_uc": 24, - "att_dc": 0, - "amplitude_scale": 12 - }, - - "band_3" : { - "iq_swap_in" : 0, - "iq_swap_out" : 0, - "refPhaseDelay" : 6, - "refPhaseDelayFine" : 0, - # Matches system latency for LMS feedback (multiplex - # of 52x 9.6MHz ticks) Adjust to match refPhaseDelay*4 - # (e.g. if refPhaseDelay = 6, lmsDelay = 24). Mitch - # is checking this ; might not be refPhaseDelay*4 - - # need to revisit. - "lmsDelay": 24, - # Adjust trigRstDly such that the ramp resets at the - # flux ramp glitch. Not totally clear at the moment - # what that means. - "trigRstDly" : 15, # 0xF - "toneScale" : 2, - "analysisScale" : 3, - "feedbackEnable": 1, - "feedbackGain" : 256, - "feedbackPolarity" : 1, - "synthesisScale": 2, - "feedbackLimitkHz": 225, - "lmsGain": 7, - "rfEnable": 1, - "bandCenterMHz": 5750, - "data_out_mux" : [8, 9], - "att_uc": 24, - "att_dc": 0, - "amplitude_scale": 12 - } -}, - -"bad_mask" : { -}, - -"channel_assignment" : { - "band_2" : "/usr/local/controls/Applications/smurf/pysmurf/pysmurf/scratch/shawn/channel_assignment_b2_teses.txt", - "band_3" : "/usr/local/controls/Applications/smurf/pysmurf/pysmurf/scratch/shawn/channel_assignment_b3.txt" -}, - -"amplifier": { - "hemt_Vg" : 0.60, - "bit_to_V_hemt" : 1.92e-6, - "hemt_Id_offset" : 1.00546875, - "LNA_Vg" : -0.718, - # 32 if using a C02 cryostat card. Some C01s were - # kludged to provide a 50k gate voltage for ASU 50K LNAs - # in early testing. For those, use 2. - "dac_num_50k" : 2, - "bit_to_V_50k" : 3.88e-6, - "hemt_gate_min_voltage" : -1.0, - "hemt_gate_max_voltage" : 1.0 -}, - -"attenuator" : { - "att1" : 0, - "att2" : 1, - "att3" : 2, - "att4" : 3 -}, - -"chip_to_freq" : { - "9" : [4.94150, 5.05], - "10" : [5.05, 5.17550 ], - "11" : [5.20150, 5.28250 ], - "12" : [5.28250, 5.41050 ], - "13" : [5.42050, 5.54550 ], - "14" : [5.55150, 5.67650 ], - "15" : [5.66650, 5.79150 ], - "16" : [5.79050, 5.91550 ] -}, - -# Set for C01 cryostat card. See -#https://confluence.slac.stanford.edu/display/SMuRF/Cryostat+board -"pic_to_bias_group": { - "9" : 8, - "11" : 10, - "13" : 12, - "15" : 14, - "14" : 15, - "12" : 13, - "10" : 11, - "8" : 9, - "7" : 6, - "5" : 4, - "3" : 2, - "1" : 0, - "6" : 7, - "4" : 5, - "2" : 3, - "0" : 1 -}, - -# Set for C01 cryostat card. See -#https://confluence.slac.stanford.edu/display/SMuRF/Cryostat+board -"bias_group_to_pair" : { - "8" : [2,1], - "10": [4,3], - "12": [6,5], - "14": [8,7], - "15": [10,9], - "13": [12,11], - "11": [14,13], - "9": [16,15], - "6": [18,17], - "4": [20,19], - "2": [22,21], - "0": [24,23], - "7": [26,25], - "5": [28,27], - "3": [30,29], - "1": [32,31] -}, - -"band_to_chip" : { - "1" : [1, 2, 3, 4], - "2" : [5, 6, 7, 8], - "3" : [9, 10, 11, 12], - "4" : [13, 14, 15, 16] -}, - - -"R_sh" : 390e-6, -"bias_line_resistance" : 25479, -"high_low_current_ratio" : 12.50, - -"high_current_mode_bool": 0, - -"all_bias_groups": [3], - -"tune_band" : { - "n_samples" : 262144, - "grad_cut" : 0.05, - "amp_cut" : 0.25, - "freq_max" : 250000000, - "freq_min" : -250000000, - # For Stanford 5-6ghz 528 box in FP29, with a standard (not - # modified for high current) RTM - "fraction_full_scale": 0.495, - "lms_freq": { - "2" : 16500, - "3" : 16500 - }, - # The fraction of each flux ramp cycle above which we start - # applying feedback, within each cycle. Must be >0. If >1, - # then You want this to be large enough to mask the transient - # which occurs after each flux ramp reset. Must be in [0,1). - "feedback_start_frac" : { - "2" : 0.05, - "3" : 0.05 - }, - # The fraction of each flux ramp cycle above which we stop - # applying feedback, within each cycle. Must be >0. If >1, - # then feedback over the entire cycle (after feedbackStart). - "feedback_end_frac" : { - "2" : 0.98, - "3" : 0.98 - }, - "gradient_descent_gain": { - "2" : 1e-5, - "3" : 1e-5 - }, - "gradient_descent_averages": { - "2" : 10, - "3" : 10 - }, - "eta_scan_averages": { - "2" : 10, - "3" : 10 - }, - "default_tune": "/data/smurf_data/tune/1556941499_tune.npy" -}, - -"flux_ramp" : { - "select_ramp" : 1, - "ramp_start_mode" : 0, - "num_flux_ramp_counter_bits" : 32 -}, - -"constant" : { - "pA_per_phi0" : 9e6 -}, - -"timing" : { - # "ext_ref" : internal oscillator locked to an external - # front-panel reference, or unlocked if there is no front - # panel reference. (LmkReg_0x0147 : 0x1A) - # "backplane" : takes timing from timing master through - # backplane. - "timing_reference" : "backplane" -}, - -"fs" : 200.0, - -"smurf_to_mce" : { - "smurf_to_mce_file" : "/data/smurf2mce_config/smurf2mce.cfg", - "mask_file" : "/data/smurf2mce_config/mask.txt", - "receiver_ip" : "tcp://192.168.3.1:3334", - "port_number" : "3334", - "filter_freq" : 63, - "filter_order" : 4, - "filter_gain" : 1.0, - "file_name_extend" : 1, - "data_frames" : 2000000, - "static_mask" : 0, - "num_averages" : 20, - # Kludge to account for offset in gcp channel number in early - # versios of the DSPv3 fw. May be different for each band, in - # mitch_4_30 the offset for band 2 is -2. Mitch plans to fix - # in fw, so this should be unnecessary soon. - "mask_channel_offset" : -2 -}, - -"default_data_dir": "/data/smurf_data", -"smurf_cmd_dir": "/data/smurf_data/smurf_cmd", -"tune_dir" : "/data/smurf_data/tune", -"status_dir" : "/data/smurf_data/status" -} diff --git a/cfg_files/stanford/smurf-srv03/experiment_fp29_srv03_dspv3_cc02-02_hbOnlyBay0.cfg b/cfg_files/stanford/smurf-srv03/experiment_fp29_srv03_dspv3_cc02-02_hbOnlyBay0.cfg deleted file mode 100644 index cb63a5d67..000000000 --- a/cfg_files/stanford/smurf-srv03/experiment_fp29_srv03_dspv3_cc02-02_hbOnlyBay0.cfg +++ /dev/null @@ -1,255 +0,0 @@ -{ -"epics_root" : "test_epics", -"init": { - - "bands" : [2,3], - "dspEnable": 1, - - "band_2" : { - "iq_swap_in" : 0, - "iq_swap_out" : 0, - "refPhaseDelay" : 6, - "refPhaseDelayFine" : 0, - # Matches system latency for LMS feedback (multiplex - # of 52x 9.6MHz ticks) Adjust to match refPhaseDelay*4 - # (e.g. if refPhaseDelay = 6, lmsDelay = 24). Mitch - # is checking this ; might not be refPhaseDelay*4 - - # need to revisit. - "lmsDelay" : 24, - # Adjust trigRstDly such that the ramp resets at the - # flux ramp glitch. Not totally clear at the moment - # what that means. - "trigRstDly" : 15, # 0xF - "toneScale" : 2, - "analysisScale" : 3, - "feedbackEnable": 1, - "feedbackGain" : 256, - "feedbackPolarity" : 1, - "synthesisScale": 2, - "feedbackLimitkHz": 225, - "lmsGain": 7, - "rfEnable": 1, - "bandCenterMHz": 5250, - "data_out_mux" : [6, 7], - "att_uc": 0, - "att_dc": 0, - "amplitude_scale": 11 - }, - - "band_3" : { - "iq_swap_in" : 0, - "iq_swap_out" : 0, - "refPhaseDelay" : 6, - "refPhaseDelayFine" : 0, - # Matches system latency for LMS feedback (multiplex - # of 52x 9.6MHz ticks) Adjust to match refPhaseDelay*4 - # (e.g. if refPhaseDelay = 6, lmsDelay = 24). Mitch - # is checking this ; might not be refPhaseDelay*4 - - # need to revisit. - "lmsDelay": 24, - # Adjust trigRstDly such that the ramp resets at the - # flux ramp glitch. Not totally clear at the moment - # what that means. - "trigRstDly" : 15, # 0xF - "toneScale" : 2, - "analysisScale" : 3, - "feedbackEnable": 1, - "feedbackGain" : 256, - "feedbackPolarity" : 1, - "synthesisScale": 2, - "feedbackLimitkHz": 225, - "lmsGain": 7, - "rfEnable": 1, - "bandCenterMHz": 5750, - "data_out_mux" : [8, 9], - "att_uc": 0, - "att_dc": 0, - "amplitude_scale": 11 - } -}, - -"bad_mask" : { -}, - -"channel_assignment" : { - "band_2" : "/usr/local/controls/Applications/smurf/pysmurf/pysmurf/scratch/shawn/channel_assignment_b2_teses.txt", - "band_3" : "/usr/local/controls/Applications/smurf/pysmurf/pysmurf/scratch/shawn/channel_assignment_b3.txt" -}, - -"amplifier": { - "hemt_Vg" : 0.570, - "bit_to_V_hemt" : 1.92e-6, - "hemt_Id_offset" : 0.12891, - "LNA_Vg" : -0.7575, - # 32 if using a C02 cryostat card. Some C01s were - # kludged to provide a 50k gate voltage for ASU 50K LNAs - # in early testing. For those, use 2. - "dac_num_50k" : 32, - "bit_to_V_50k" : 3.88e-6, - "hemt_gate_min_voltage" : -1.0, - "hemt_gate_max_voltage" : 1.0 -}, - -"attenuator" : { - "att1" : 0, - "att2" : 1, - "att3" : 2, - "att4" : 3 -}, - -"chip_to_freq" : { - "9" : [4.94150, 5.05], - "10" : [5.05, 5.17550 ], - "11" : [5.20150, 5.28250 ], - "12" : [5.28250, 5.41050 ], - "13" : [5.42050, 5.54550 ], - "14" : [5.55150, 5.67650 ], - "15" : [5.66650, 5.79150 ], - "16" : [5.79050, 5.91550 ] -}, - -# Set for C02 cryostat card. See -#https://confluence.slac.stanford.edu/display/SMuRF/Cryostat+board -"pic_to_bias_group": { - "0" : 0, - "1" : 1, - "2" : 2, - "3" : 3, - "4" : 4, - "5" : 5, - "6" : 6, - "7" : 7, - "8" : 8, - "9" : 9, - "10" : 10, - "11" : 11, - "12" : 12, - "13" : 13, - "14" : 14, - "15" : 15 -}, - -# Set for C02 cryostat card. See -#https://confluence.slac.stanford.edu/display/SMuRF/Cryostat+board -"bias_group_to_pair" : { - "0" : [1,2], - "1" : [3,4], - "2" : [5,6], - "3" : [7,8], - "4" : [9,10], - "5" : [11,12], - "6" : [13,14], - "7" : [15,16], - "8" : [17,18], - "9" : [19,20], - "10" : [21,22], - "11" : [23,24], - "12" : [25,26], - "13" : [27,28], - "14" : [29,30] -}, - -"band_to_chip" : { - "1" : [1, 2, 3, 4], - "2" : [5, 6, 7, 8], - "3" : [9, 10, 11, 12], - "4" : [13, 14, 15, 16] -}, - - -"R_sh" : 390e-6, -"bias_line_resistance" : 25479, -"high_low_current_ratio" : 12.50, - -"high_current_mode_bool": 0, - -"all_bias_groups": [3], - -"tune_band" : { - "n_samples" : 262144, - "grad_cut" : 0.05, - "amp_cut" : 0.25, - "freq_max" : 250000000, - "freq_min" : -250000000, - # For Stanford 5-6ghz 528 box in FP29, with a standard (not - # modified for high current) RTM - "fraction_full_scale": 0.65, - "lms_freq": { - "2" : 8520, - "3" : 8520 - }, - # The fraction of each flux ramp cycle above which we start - # applying feedback, within each cycle. Must be >0. If >1, - # then You want this to be large enough to mask the transient - # which occurs after each flux ramp reset. Must be in [0,1). - "feedback_start_frac" : { - "2" : 0.05, - "3" : 0.05 - }, - # The fraction of each flux ramp cycle above which we stop - # applying feedback, within each cycle. Must be >0. If >1, - # then feedback over the entire cycle (after feedbackStart). - "feedback_end_frac" : { - "2" : 0.98, - "3" : 0.98 - }, - "gradient_descent_gain": { - "2" : 1e-5, - "3" : 1e-5 - }, - "gradient_descent_averages": { - "2" : 10, - "3" : 10 - }, - "eta_scan_averages": { - "2" : 10, - "3" : 10 - }, - "default_tune": "/data/smurf_data/tune/1555011900_tune.npy" -}, - -"flux_ramp" : { - "select_ramp" : 1, - "ramp_start_mode" : 0, - "num_flux_ramp_counter_bits" : 32 -}, - -"constant" : { - "pA_per_phi0" : 9e6 -}, - -"timing" : { - # "ext_ref" : internal oscillator locked to an external - # front-panel reference, or unlocked if there is no front - # panel reference. (LmkReg_0x0147 : 0x1A) - # "backplane" : takes timing from timing master through - # backplane. - "timing_reference" : "backplane" -}, - -"fs" : 200.0, - -"smurf_to_mce" : { - "smurf_to_mce_file" : "/data/smurf2mce_config/smurf2mce.cfg", - "mask_file" : "/data/smurf2mce_config/mask.txt", - "receiver_ip" : "tcp://192.168.3.1:3334", - "port_number" : "3334", - "filter_freq" : 63, - "filter_order" : 4, - "filter_gain" : 1.0, - "file_name_extend" : 1, - "data_frames" : 300000, - "static_mask" : 0, - "num_averages" : 20, - # Kludge to account for offset in gcp channel number in early - # versions of the DSPv3 fw. May be different for each band, in - # mitch_4_30 the offset for band 2 is -2. Mitch plans to fix - # in fw, so this should be unnecessary soon. - "mask_channel_offset" : -2 -}, - -"default_data_dir": "/data/smurf_data", -"smurf_cmd_dir": "/data/smurf_data/smurf_cmd", -"tune_dir" : "/data/smurf_data/tune", -"status_dir" : "/data/smurf_data/status" -} diff --git a/cfg_files/stanford/smurf-srv03/experiment_fp29_srv03_dspv3_cc02-03.cfg b/cfg_files/stanford/smurf-srv03/experiment_fp29_srv03_dspv3_cc02-03.cfg deleted file mode 100644 index 6202bc272..000000000 --- a/cfg_files/stanford/smurf-srv03/experiment_fp29_srv03_dspv3_cc02-03.cfg +++ /dev/null @@ -1,426 +0,0 @@ -{ -"epics_root" : "test_epics", -"init": { - - "dspEnable": 1, - - "band_0" : { - "iq_swap_in" : 0, - "iq_swap_out" : 0, - "refPhaseDelay" : 6, - "refPhaseDelayFine" : 0, - # Matches system latency for LMS feedback (multiplex - # of 52x 9.6MHz ticks) Adjust to match refPhaseDelay*4 - # (e.g. if refPhaseDelay = 6, lmsDelay = 24). Mitch - # is checking this ; might not be refPhaseDelay*4 - - # need to revisit. - "lmsDelay" : 24, - # Adjust trigRstDly such that the ramp resets at the - # flux ramp glitch. Not totally clear at the moment - # what that means. - "trigRstDly" : 15, # 0xF - "feedbackEnable": 1, - "feedbackGain" : 256, - "feedbackPolarity" : 1, - "feedbackLimitkHz": 225, - "lmsGain": 7, - "att_uc": 12, - "att_dc": 0, - "amplitude_scale": 12 - }, - - "band_1" : { - "iq_swap_in" : 0, - "iq_swap_out" : 0, - "refPhaseDelay" : 6, - "refPhaseDelayFine" : 0, - # Matches system latency for LMS feedback (multiplex - # of 52x 9.6MHz ticks) Adjust to match refPhaseDelay*4 - # (e.g. if refPhaseDelay = 6, lmsDelay = 24). Mitch - # is checking this ; might not be refPhaseDelay*4 - - # need to revisit. - "lmsDelay": 24, - # Adjust trigRstDly such that the ramp resets at the - # flux ramp glitch. Not totally clear at the moment - # what that means. - "trigRstDly" : 15, # 0xF - "feedbackEnable": 1, - "feedbackGain" : 256, - "feedbackPolarity" : 1, - "feedbackLimitkHz": 225, - "lmsGain": 7, - "att_uc": 12, - "att_dc": 0, - "amplitude_scale": 12 - }, - - "band_2" : { - "iq_swap_in" : 0, - "iq_swap_out" : 0, - "refPhaseDelay" : 6, - "refPhaseDelayFine" : 0, - # Matches system latency for LMS feedback (multiplex - # of 52x 9.6MHz ticks) Adjust to match refPhaseDelay*4 - # (e.g. if refPhaseDelay = 6, lmsDelay = 24). Mitch - # is checking this ; might not be refPhaseDelay*4 - - # need to revisit. - "lmsDelay" : 24, - # Adjust trigRstDly such that the ramp resets at the - # flux ramp glitch. Not totally clear at the moment - # what that means. - "trigRstDly" : 15, # 0xF - "feedbackEnable": 1, - "feedbackGain" : 256, - "feedbackPolarity" : 1, - "feedbackLimitkHz": 225, - "lmsGain": 7, - "att_uc": 12, - "att_dc": 0, - "amplitude_scale": 12 - }, - - "band_3" : { - "iq_swap_in" : 0, - "iq_swap_out" : 0, - "refPhaseDelay" : 6, - "refPhaseDelayFine" : 0, - # Matches system latency for LMS feedback (multiplex - # of 52x 9.6MHz ticks) Adjust to match refPhaseDelay*4 - # (e.g. if refPhaseDelay = 6, lmsDelay = 24). Mitch - # is checking this ; might not be refPhaseDelay*4 - - # need to revisit. - "lmsDelay": 24, - # Adjust trigRstDly such that the ramp resets at the - # flux ramp glitch. Not totally clear at the moment - # what that means. - "trigRstDly" : 15, # 0xF - "feedbackEnable": 1, - "feedbackGain" : 256, - "feedbackPolarity" : 1, - "feedbackLimitkHz": 225, - "lmsGain": 7, - "att_uc": 12, - "att_dc": 0, - "amplitude_scale": 12 - }, - - "band_4" : { - "iq_swap_in" : 0, - "iq_swap_out" : 0, - "refPhaseDelay" : 6, - "refPhaseDelayFine" : 0, - # Matches system latency for LMS feedback (multiplex - # of 52x 9.6MHz ticks) Adjust to match refPhaseDelay*4 - # (e.g. if refPhaseDelay = 6, lmsDelay = 24). Mitch - # is checking this ; might not be refPhaseDelay*4 - - # need to revisit. - "lmsDelay": 24, - # Adjust trigRstDly such that the ramp resets at the - # flux ramp glitch. Not totally clear at the moment - # what that means. - "trigRstDly" : 15, # 0xF - "feedbackEnable": 1, - "feedbackGain" : 256, - "feedbackPolarity" : 1, - "feedbackLimitkHz": 225, - "lmsGain": 7, - "att_uc": 0, - "att_dc": 0, - "amplitude_scale": 12 - }, - - "band_5" : { - "iq_swap_in" : 0, - "iq_swap_out" : 0, - "refPhaseDelay" : 6, - "refPhaseDelayFine" : 0, - # Matches system latency for LMS feedback (multiplex - # of 52x 9.6MHz ticks) Adjust to match refPhaseDelay*4 - # (e.g. if refPhaseDelay = 6, lmsDelay = 24). Mitch - # is checking this ; might not be refPhaseDelay*4 - - # need to revisit. - "lmsDelay": 24, - # Adjust trigRstDly such that the ramp resets at the - # flux ramp glitch. Not totally clear at the moment - # what that means. - "trigRstDly" : 15, # 0xF - "feedbackEnable": 1, - "feedbackGain" : 256, - "feedbackPolarity" : 1, - "feedbackLimitkHz": 225, - "lmsGain": 7, - "att_uc": 0, - "att_dc": 0, - "amplitude_scale": 12 - }, - - "band_6" : { - "iq_swap_in" : 0, - "iq_swap_out" : 0, - "refPhaseDelay" : 6, - "refPhaseDelayFine" : 0, - # Matches system latency for LMS feedback (multiplex - # of 52x 9.6MHz ticks) Adjust to match refPhaseDelay*4 - # (e.g. if refPhaseDelay = 6, lmsDelay = 24). Mitch - # is checking this ; might not be refPhaseDelay*4 - - # need to revisit. - "lmsDelay": 24, - # Adjust trigRstDly such that the ramp resets at the - # flux ramp glitch. Not totally clear at the moment - # what that means. - "trigRstDly" : 15, # 0xF - "feedbackEnable": 1, - "feedbackGain" : 256, - "feedbackPolarity" : 1, - "feedbackLimitkHz": 225, - "lmsGain": 7, - "att_uc": 0, - "att_dc": 0, - "amplitude_scale": 12 - }, - - "band_7" : { - "iq_swap_in" : 0, - "iq_swap_out" : 0, - "refPhaseDelay" : 6, - "refPhaseDelayFine" : 0, - # Matches system latency for LMS feedback (multiplex - # of 52x 9.6MHz ticks) Adjust to match refPhaseDelay*4 - # (e.g. if refPhaseDelay = 6, lmsDelay = 24). Mitch - # is checking this ; might not be refPhaseDelay*4 - - # need to revisit. - "lmsDelay": 24, - # Adjust trigRstDly such that the ramp resets at the - # flux ramp glitch. Not totally clear at the moment - # what that means. - "trigRstDly" : 15, # 0xF - "feedbackEnable": 1, - "feedbackGain" : 256, - "feedbackPolarity" : 1, - "feedbackLimitkHz": 225, - "lmsGain": 7, - "att_uc": 0, - "att_dc": 0, - "amplitude_scale": 12 - } -}, - -"bad_mask" : { -}, - -"amplifier": { - "hemt_Vg" : 0.570, - "bit_to_V_hemt" : 3.8592e-06, - "hemt_Id_offset" : 0.16758, - "LNA_Vg" : -0.7575, - # 32 if using a C02 cryostat card. Some C01s were - # kludged to provide a 50k gate voltage for ASU 50K LNAs - # in early testing. For those, use 2. - "dac_num_50k" : 32, - "bit_to_V_50k" : 3.8592E-06, - "hemt_gate_min_voltage" : -1.0, - "hemt_gate_max_voltage" : 1.0 -}, - -"attenuator" : { - "att1" : 0, - "att2" : 1, - "att3" : 2, - "att4" : 3 -}, - -"chip_to_freq" : { - "9" : [4.94150, 5.05], - "10" : [5.05, 5.17550 ], - "11" : [5.20150, 5.28250 ], - "12" : [5.28250, 5.41050 ], - "13" : [5.42050, 5.54550 ], - "14" : [5.55150, 5.67650 ], - "15" : [5.66650, 5.79150 ], - "16" : [5.79050, 5.91550 ] -}, - -# Set for C02 cryostat card. See -#https://confluence.slac.stanford.edu/display/SMuRF/Cryostat+board -"pic_to_bias_group": { - "0" : 0, - "1" : 1, - "2" : 2, - "3" : 3, - "4" : 4, - "5" : 5, - "6" : 6, - "7" : 7, - "8" : 8, - "9" : 9, - "10" : 10, - "11" : 11, - "12" : 12, - "13" : 13, - "14" : 14, - "15" : 15 -}, - -# Set for C02 cryostat card. See -#https://confluence.slac.stanford.edu/display/SMuRF/Cryostat+board -"bias_group_to_pair" : { - "0" : [1,2], - "1" : [3,4], - "2" : [5,6], - "3" : [7,8], - "4" : [9,10], - "5" : [11,12], - "6" : [13,14], - "7" : [15,16], - "8" : [17,18], - "9" : [19,20], - "10" : [21,22], - "11" : [23,24], - "12" : [25,26], - "13" : [27,28], - "14" : [29,30] -}, - -"R_sh" : 390e-6, -"bias_line_resistance" : 25479, -"high_low_current_ratio" : 12.50, - -"high_current_mode_bool": 0, - -"all_bias_groups": [3], - -"tune_band" : { - "n_samples" : 262144, - "grad_cut" : 0.05, - "amp_cut" : 0.25, - "freq_max" : 250000000, - "freq_min" : -250000000, - # For Stanford 5-6ghz 528 box in FP29, with a standard (not - # modified for high current) RTM - "fraction_full_scale": 0.495, - "delta_freq": { - "0" : 0.02, - "1" : 0.02, - "2" : 0.02, - "3" : 0.02, - "4" : 0.02, - "5" : 0.02, - "6" : 0.02, - "7" : 0.02 - }, - "lms_freq": { - "0" : 16500, - "1" : 16500, - "2" : 16500, - "3" : 16500, - "4" : 16500, - "5" : 16500, - "6" : 16500, - "7" : 16500 - }, - # The fraction of each flux ramp cycle above which we start - # applying feedback, within each cycle. Must be >0. If >1, - # then You want this to be large enough to mask the transient - # which occurs after each flux ramp reset. Must be in [0,1). - "feedback_start_frac" : { - "0" : 0.05, - "1" : 0.05, - "2" : 0.05, - "3" : 0.05, - "4" : 0.05, - "5" : 0.05, - "6" : 0.05, - "7" : 0.05 - }, - # The fraction of each flux ramp cycle above which we stop - # applying feedback, within each cycle. Must be >0. If >1, - # then feedback over the entire cycle (after feedbackStart). - "feedback_end_frac" : { - "0" : 0.98, - "1" : 0.98, - "2" : 0.98, - "3" : 0.98, - "4" : 0.98, - "5" : 0.98, - "6" : 0.98, - "7" : 0.98 - }, - "gradient_descent_gain": { - "0" : 1e-5, - "1" : 1e-5, - "2" : 1e-5, - "3" : 1e-5, - "4" : 1e-5, - "5" : 1e-5, - "6" : 1e-5, - "7" : 1e-5 - }, - "gradient_descent_averages": { - "0" : 10, - "1" : 10, - "2" : 10, - "3" : 10, - "4" : 10, - "5" : 10, - "6" : 10, - "7" : 10 - }, - "eta_scan_averages": { - "0" : 10, - "1" : 10, - "2" : 10, - "3" : 10, - "4" : 10, - "5" : 10, - "6" : 10, - "7" : 10 - } - #"default_tune": "/data/smurf_data/tune/1558666435_tune.npy" -}, - -"flux_ramp" : { - "select_ramp" : 1, - "num_flux_ramp_counter_bits" : 32 -}, - -"constant" : { - "pA_per_phi0" : 9e6 -}, - -"timing" : { - # "ext_ref" : internal oscillator locked to an external - # front-panel reference, or unlocked if there is no front - # panel reference. (LmkReg_0x0147 : 0x1A). Also sets - # flux_ramp_start_mode=0 - # "backplane" : takes timing from timing master through - # backplane. Also sets flux_ramp_start_mode=1. - "timing_reference" : "ext_ref" -}, - -"fs" : 200.0, - -"smurf_to_mce" : { - "smurf_to_mce_file" : "/data/smurf2mce_config/smurf2mce.cfg", - "mask_file" : "/data/smurf2mce_config/mask.txt", - "receiver_ip" : "tcp://192.168.3.1:3334", - "port_number" : "3334", - "filter_freq" : 63, - "filter_order" : 4, - "filter_gain" : 1.0, - "file_name_extend" : 1, - "data_frames" : 300000, - "static_mask" : 0, - "num_averages" : 20, - # Kludge to account for offset in gcp channel number in early - # versios of the DSPv3 fw. May be different for each band, in - # mitch_4_30 the offset for band 2 is -2. Mitch plans to fix - # in fw, so this should be unnecessary soon. - "mask_channel_offset" : -2 -}, - -"default_data_dir": "/data/smurf_data", -# For remote commanding -#"smurf_cmd_dir": "/data/smurf_data/smurf_cmd", -"tune_dir" : "/data/smurf_data/tune", -"status_dir" : "/data/smurf_data/status" -} diff --git a/cfg_files/stanford/smurf-srv03/experiment_fp29_srv03_dspv3_cc02-03_lbOnlyBay0.cfg b/cfg_files/stanford/smurf-srv03/experiment_fp29_srv03_dspv3_cc02-03_lbOnlyBay0.cfg deleted file mode 100644 index 5d5d23b2a..000000000 --- a/cfg_files/stanford/smurf-srv03/experiment_fp29_srv03_dspv3_cc02-03_lbOnlyBay0.cfg +++ /dev/null @@ -1,374 +0,0 @@ -{ -"epics_root" : "test_epics", -"init": { - - "dspEnable": 1, - - "band_0" : { - "iq_swap_in" : 0, - "iq_swap_out" : 0, - #https://confluence.slac.stanford.edu/display/SMuRF/0eea5630 - #"refPhaseDelay" : 6, - #"refPhaseDelayFine" : 9, - #"lmsDelay" : 24, - # Measured for 5ee81820 by SWH on 7/11/19 with C02-01 - # carrier + LB AMC C03-A01-03. - #"refPhaseDelay" : 8, - #"refPhaseDelayFine" : 41, - # Measured for 071150b0 by SWH on 7/3/19 with C02-01 - # carrier + LB AMC C03-A01-03. - #"refPhaseDelay" : 8, - #"refPhaseDelayFine" : 38, - # lmsDelay only gets set from the cfg if it's present - # ; otherwise it gets set to 4*refPhaseDelay. It's - # supposed to be 4*refPhaseDelay, but in fw 071150b0, - # refPhaseDelay is 8, and 4*8=32, which exceeds 31, - # which is the maximum value lmsDelay can be set to in - # 071150b0. - #"lmsDelay" : 31, - # Adjust trigRstDly such that the ramp resets at the - # flux ramp glitch. Not totally clear at the moment - # what that means. - # Measured for a406a45 by SWH on 7/19/19 - #"refPhaseDelay" : 8, - #"refPhaseDelayFine" : 42, - #"lmsDelay" : 31, - # Measured for 081ca90 by SWH on 7/19/19 - "refPhaseDelay" : 6, - "refPhaseDelayFine" : 7, - "lmsDelay" : 24, - "trigRstDly" : 15, # 0xF - "feedbackEnable": 1, - "feedbackGain" : 256, - "feedbackPolarity" : 1, - "feedbackLimitkHz": 225, - "lmsGain": 6, - "att_uc": 24, - "att_dc": 0, - "amplitude_scale": 12 - }, - - "band_1" : { - "iq_swap_in" : 0, - "iq_swap_out" : 0, - #https://confluence.slac.stanford.edu/display/SMuRF/0eea5630 - #"refPhaseDelay" : 6, - #"refPhaseDelayFine" : 5, - #"lmsDelay" : 24, - # Measured for 5ee81820 by SWH on 7/11/19 with C02-01 - # carrier + LB AMC C03-A01-03. - #"refPhaseDelay" : 8, - #"refPhaseDelayFine" : 41, - # Measured for 071150b0 by SWH on 7/3/19 with C02-01 - # carrier + LB AMC C03-A01-03. - #"refPhaseDelay" : 8, - #"refPhaseDelayFine" : 39, - # lmsDelay only gets set from the cfg if it's present - # ; otherwise it gets set to 4*refPhaseDelay. It's - # supposed to be 4*refPhaseDelay, but in fw 071150b0, - # refPhaseDelay is 8, and 4*8=32, which exceeds 31, - # which is the maximum value lmsDelay can be set to in - # 071150b0. - #"lmsDelay" : 31, - # Adjust trigRstDly such that the ramp resets at the - # flux ramp glitch. Not totally clear at the moment - # what that means. - # Measured for a406a45 by SWH on 7/19/19 - #"refPhaseDelay" : 8, - #"refPhaseDelayFine" : 44, - #"lmsDelay" : 31, - # Measured for 081ca90 by SWH on 7/19/19 - "refPhaseDelay" : 6, - "refPhaseDelayFine" : 15, - "lmsDelay" : 24, - "trigRstDly" : 15, # 0xF - "feedbackEnable": 1, - "feedbackGain" : 256, - "feedbackPolarity" : 1, - "feedbackLimitkHz": 225, - "lmsGain": 6, - "att_uc": 24, - "att_dc": 0, - "amplitude_scale": 12 - }, - - "band_2" : { - "iq_swap_in" : 0, - "iq_swap_out" : 0, - #https://confluence.slac.stanford.edu/display/SMuRF/0eea5630 - #"refPhaseDelay" : 6, - #"refPhaseDelayFine" : 8, - #"lmsDelay" : 24, - # Measured for 5ee81820 by SWH on 7/11/19 with C02-01 - # carrier + LB AMC C03-A01-03. - #"refPhaseDelay" : 8, - #"refPhaseDelayFine" : 44, - # Measured for 071150b0 by SWH on 7/3/19 with C02-01 - # carrier + LB AMC C03-A01-03. - #"refPhaseDelay" : 8, - #"refPhaseDelayFine" : 43, - # lmsDelay only gets set from the cfg if it's present - # ; otherwise it gets set to 4*refPhaseDelay. It's - # supposed to be 4*refPhaseDelay, but in fw 071150b0, - # refPhaseDelay is 8, and 4*8=32, which exceeds 31, - # which is the maximum value lmsDelay can be set to in - # 071150b0. - #"lmsDelay" : 31, - # Adjust trigRstDly such that the ramp resets at the - # flux ramp glitch. Not totally clear at the moment - # what that means. - # Measured for a406a45 by SWH on 7/19/19 - #"refPhaseDelay" : 8, - #"refPhaseDelayFine" : 49, - #"lmsDelay" : 31, - # Measured for 081ca90 by SWH on 7/19/19 - "refPhaseDelay" : 6, - "refPhaseDelayFine" : 4, - "lmsDelay" : 24, - "trigRstDly" : 15, # 0xF - "feedbackEnable": 1, - "feedbackGain" : 256, - "feedbackPolarity" : 1, - "feedbackLimitkHz": 225, - "lmsGain": 6, - "att_uc": 24, - "att_dc": 0, - "amplitude_scale": 12 - }, - - "band_3" : { - "iq_swap_in" : 0, - "iq_swap_out" : 0, - #https://confluence.slac.stanford.edu/display/SMuRF/0eea5630 - #"refPhaseDelay" : 6, - #"refPhaseDelayFine" : 10, - #"lmsDelay" : 24, - # Measured for 5ee81820 by SWH on 7/11/19 with C02-01 - # carrier + LB AMC C03-A01-03. - #"refPhaseDelay" : 8, - #"refPhaseDelayFine" : 47, - # Measured for 071150b0 by SWH on 7/3/19 with C02-01 - # carrier + LB AMC C03-A01-03. - #"refPhaseDelay" : 8, - #"refPhaseDelayFine" : 39, - # lmsDelay only gets set from the cfg if it's present - # ; otherwise it gets set to 4*refPhaseDelay. It's - # supposed to be 4*refPhaseDelay, but in fw 071150b0, - # refPhaseDelay is 8, and 4*8=32, which exceeds 31, - # which is the maximum value lmsDelay can be set to in - # 071150b0. - #"lmsDelay" : 31, - # Adjust trigRstDly such that the ramp resets at the - # flux ramp glitch. Not totally clear at the moment - # what that means. - # Measured for a406a45 by SWH on 7/19/19 - #"refPhaseDelay" : 8, - #"refPhaseDelayFine" : 50, - #"lmsDelay" : 31, - # Measured for 081ca90 by SWH on 7/19/19 - "refPhaseDelay" : 6, - "refPhaseDelayFine" : 17, - "lmsDelay" : 24, - "trigRstDly" : 15, # 0xF - "feedbackEnable": 1, - "feedbackGain" : 256, - "feedbackPolarity" : 1, - "feedbackLimitkHz": 225, - "lmsGain": 6, - "att_uc": 24, - "att_dc": 0, - "amplitude_scale": 12 - } -}, - -"bad_mask" : { -}, - -"amplifier": { - "hemt_Vg" : 0.570, - "bit_to_V_hemt" : 3.8592e-06, - "hemt_Id_offset" : 0.16758, - "LNA_Vg" : -0.7575, - # 32 if using a C02 cryostat card. Some C01s were - # kludged to provide a 50k gate voltage for ASU 50K LNAs - # in early testing. For those, use 2. - "dac_num_50k" : 32, - "bit_to_V_50k" : 3.8592e-06, - "hemt_gate_min_voltage" : -1.0, - "hemt_gate_max_voltage" : 1.0 -}, - -"attenuator" : { - "att1" : 0, - "att2" : 1, - "att3" : 2, - "att4" : 3 -}, - -"chip_to_freq" : { - "9" : [4.94150, 5.05], - "10" : [5.05, 5.17550 ], - "11" : [5.20150, 5.28250 ], - "12" : [5.28250, 5.41050 ], - "13" : [5.42050, 5.54550 ], - "14" : [5.55150, 5.67650 ], - "15" : [5.66650, 5.79150 ], - "16" : [5.79050, 5.91550 ] -}, - -# Set for C02 cryostat card. See -#https://confluence.slac.stanford.edu/display/SMuRF/Cryostat+board -"pic_to_bias_group": { - "0" : 0, - "1" : 1, - "2" : 2, - "3" : 3, - "4" : 4, - "5" : 5, - "6" : 6, - "7" : 7, - "8" : 8, - "9" : 9, - "10" : 10, - "11" : 11, - "12" : 12, - "13" : 13, - "14" : 14, - "15" : 15 -}, - -# Set for C02 cryostat card. See -#https://confluence.slac.stanford.edu/display/SMuRF/Cryostat+board -"bias_group_to_pair" : { - "0" : [1,2], - "1" : [3,4], - "2" : [5,6], - "3" : [7,8], - "4" : [9,10], - "5" : [11,12], - "6" : [13,14], - "7" : [15,16], - "8" : [17,18], - "9" : [19,20], - "10" : [21,22], - "11" : [23,24], - "12" : [25,26], - "13" : [27,28], - "14" : [29,30] -}, - -"R_sh" : 390e-6, -"bias_line_resistance" : 25479, -"high_low_current_ratio" : 12.50, - -"high_current_mode_bool": 0, - -"all_bias_groups": [3], - -"tune_band" : { - "n_samples" : 262144, - "grad_cut" : 0.05, - "amp_cut" : 0.25, - "freq_max" : 250000000, - "freq_min" : -250000000, - # For Stanford 5-6ghz 528 box in FP29, with a standard (not - # modified for high current) RTM - "fraction_full_scale": 0.489, - "delta_freq": { - "0" : 0.02, - "1" : 0.02, - "2" : 0.02, - "3" : 0.02 - }, - "lms_freq": { - "0" : 16500, - "1" : 19945, - "2" : 19986, - "3" : 20218 - }, - # The fraction of each flux ramp cycle above which we start - # applying feedback, within each cycle. Must be >0. If >1, - # then You want this to be large enough to mask the transient - # which occurs after each flux ramp reset. Must be in [0,1). - "feedback_start_frac" : { - "0" : 0.05, - "1" : 0.05, - "2" : 0.05, - "3" : 0.05 - }, - # The fraction of each flux ramp cycle above which we stop - # applying feedback, within each cycle. Must be >0. If >1, - # then feedback over the entire cycle (after feedbackStart). - "feedback_end_frac" : { - "0" : 0.98, - "1" : 0.98, - "2" : 0.98, - "3" : 0.98 - }, - "gradient_descent_gain": { - "0" : 1e-5, - "1" : 1e-5, - "2" : 1e-5, - "3" : 1e-5 - }, - "gradient_descent_averages": { - "0" : 10, - "1" : 10, - "2" : 10, - "3" : 10 - }, - "eta_scan_averages": { - "0" : 10, - "1" : 10, - "2" : 10, - "3" : 10 - } - #"default_tune": "/data/smurf_data/tune/1558666435_tune.npy" -}, - -"flux_ramp" : { - "select_ramp" : 1, - "num_flux_ramp_counter_bits" : 32 -}, - -"constant" : { - "pA_per_phi0" : 9e6 -}, - -"timing" : { - # "ext_ref" : internal oscillator locked to an external - # front-panel reference, or unlocked if there is no front - # panel reference. (LmkReg_0x0147 : 0x1A). Also sets - # flux_ramp_start_mode=0 - # "backplane" : takes timing from timing master through - # backplane. Also sets flux_ramp_start_mode=1. - "timing_reference" : "backplane" -}, - -"fs" : 200.0, - -"smurf_to_mce" : { - "smurf_to_mce_file" : "/data/smurf2mce_config/smurf2mce.cfg", - "mask_file" : "/data/smurf2mce_config/mask.txt", - "receiver_ip" : "tcp://192.168.3.1:3334", - "port_number" : "3334", - "filter_freq" : 63, - "filter_order" : 4, - "filter_gain" : 1.0, - "file_name_extend" : 1, - "data_frames" : 300000, - "static_mask" : 0, - "num_averages" : 20, - # Kludge to account for offset in gcp channel number in early - # versios of the DSPv3 fw. May be different for each band, in - # mitch_4_30 the offset for band 2 is -2. Mitch plans to fix - # in fw, so this should be unnecessary soon. - "mask_channel_offset" : 0 -}, - -"default_data_dir": "/data/smurf_data", -# For remote commanding -#"smurf_cmd_dir": "/data/smurf_data/smurf_cmd", -"tune_dir" : "/data/smurf_data/tune", -"status_dir" : "/data/smurf_data/status" -} diff --git a/cfg_files/stanford/smurf-srv03/experiment_fp29_srv03_dspv3_noExtRef_hbOnlyBay0.cfg b/cfg_files/stanford/smurf-srv03/experiment_fp29_srv03_dspv3_noExtRef_hbOnlyBay0.cfg deleted file mode 100644 index 17ed40fa4..000000000 --- a/cfg_files/stanford/smurf-srv03/experiment_fp29_srv03_dspv3_noExtRef_hbOnlyBay0.cfg +++ /dev/null @@ -1,256 +0,0 @@ -{ -"epics_root" : "test_epics", -"init": { - - "bands" : [2,3], - "dspEnable": 1, - - "band_2" : { - "iq_swap_in" : 0, - "iq_swap_out" : 0, - "refPhaseDelay" : 6, - "refPhaseDelayFine" : 0, - # Matches system latency for LMS feedback (multiplex - # of 52x 9.6MHz ticks) Adjust to match refPhaseDelay*4 - # (e.g. if refPhaseDelay = 6, lmsDelay = 24). Mitch - # is checking this ; might not be refPhaseDelay*4 - - # need to revisit. - "lmsDelay" : 24, - # Adjust trigRstDly such that the ramp resets at the - # flux ramp glitch. Not totally clear at the moment - # what that means. - "trigRstDly" : 15, # 0xF - "toneScale" : 2, - "analysisScale" : 3, - "feedbackEnable": 1, - "feedbackGain" : 256, - "feedbackPolarity" : 1, - "synthesisScale": 2, - "feedbackLimitkHz": 225, - "lmsGain": 7, - "rfEnable": 1, - "bandCenterMHz": 5250, - "data_out_mux" : [6, 7], - "att_uc": 0, - "att_dc": 0, - "amplitude_scale": 12 - }, - - "band_3" : { - "iq_swap_in" : 0, - "iq_swap_out" : 0, - "refPhaseDelay" : 6, - "refPhaseDelayFine" : 0, - # Matches system latency for LMS feedback (multiplex - # of 52x 9.6MHz ticks) Adjust to match refPhaseDelay*4 - # (e.g. if refPhaseDelay = 6, lmsDelay = 24). Mitch - # is checking this ; might not be refPhaseDelay*4 - - # need to revisit. - "lmsDelay": 24, - # Adjust trigRstDly such that the ramp resets at the - # flux ramp glitch. Not totally clear at the moment - # what that means. - "trigRstDly" : 15, # 0xF - "toneScale" : 2, - "analysisScale" : 3, - "feedbackEnable": 1, - "feedbackGain" : 256, - "feedbackPolarity" : 1, - "synthesisScale": 2, - "feedbackLimitkHz": 225, - "lmsGain": 7, - "rfEnable": 1, - "bandCenterMHz": 5750, - "data_out_mux" : [8, 9], - "att_uc": 0, - "att_dc": 0, - "amplitude_scale": 12 - } -}, - -"bad_mask" : { -}, - -"channel_assignment" : { - "band_2" : "/usr/local/controls/Applications/smurf/pysmurf/pysmurf/scratch/shawn/channel_assignment_b2_teses.txt", - "band_3" : "/usr/local/controls/Applications/smurf/pysmurf/pysmurf/scratch/shawn/channel_assignment_b3.txt" -}, - -"amplifier": { - "hemt_Vg" : 0.570, - "bit_to_V_hemt" : 1.92e-6, - # Units=mA - "hemt_Id_offset" : 0.12891, - "LNA_Vg" : -0.7575, - # 32 if using a C02 cryostat card. Some C01s were - # kludged to provide a 50k gate voltage for ASU 50K LNAs - # in early testing. For those, use 2. - "dac_num_50k" : 32, - "bit_to_V_50k" : 3.88e-6, - "hemt_gate_min_voltage" : -1.0, - "hemt_gate_max_voltage" : 1.0 -}, - -"attenuator" : { - "att1" : 0, - "att2" : 1, - "att3" : 2, - "att4" : 3 -}, - -"chip_to_freq" : { - "9" : [4.94150, 5.05], - "10" : [5.05, 5.17550 ], - "11" : [5.20150, 5.28250 ], - "12" : [5.28250, 5.41050 ], - "13" : [5.42050, 5.54550 ], - "14" : [5.55150, 5.67650 ], - "15" : [5.66650, 5.79150 ], - "16" : [5.79050, 5.91550 ] -}, - -# Set for C02 cryostat card. See -#https://confluence.slac.stanford.edu/display/SMuRF/Cryostat+board -"pic_to_bias_group": { - "0" : 0, - "1" : 1, - "2" : 2, - "3" : 3, - "4" : 4, - "5" : 5, - "6" : 6, - "7" : 7, - "8" : 8, - "9" : 9, - "10" : 10, - "11" : 11, - "12" : 12, - "13" : 13, - "14" : 14, - "15" : 15 -}, - -# Set for C02 cryostat card. See -#https://confluence.slac.stanford.edu/display/SMuRF/Cryostat+board -"bias_group_to_pair" : { - "0" : [1,2], - "1" : [3,4], - "2" : [5,6], - "3" : [7,8], - "4" : [9,10], - "5" : [11,12], - "6" : [13,14], - "7" : [15,16], - "8" : [17,18], - "9" : [19,20], - "10" : [21,22], - "11" : [23,24], - "12" : [25,26], - "13" : [27,28], - "14" : [29,30] -}, - -"band_to_chip" : { - "1" : [1, 2, 3, 4], - "2" : [5, 6, 7, 8], - "3" : [9, 10, 11, 12], - "4" : [13, 14, 15, 16] -}, - -"R_sh" : 390e-6, -"bias_line_resistance" : 25479, -"high_low_current_ratio" : 12.50, - -"high_current_mode_bool": 0, - -"all_bias_groups": [3], - -"tune_band" : { - "n_samples" : 262144, - "grad_cut" : 0.05, - "amp_cut" : 0.25, - "freq_max" : 250000000, - "freq_min" : -250000000, - # For Stanford 5-6ghz 528 box in FP29, with a standard (not - # modified for high current) RTM - "fraction_full_scale": 0.65, - "lms_freq": { - "2" : 8520, - "3" : 8520 - }, - # The fraction of each flux ramp cycle above which we start - # applying feedback, within each cycle. Must be >0. If >1, - # then You want this to be large enough to mask the transient - # which occurs after each flux ramp reset. Must be in [0,1). - "feedback_start_frac" : { - "2" : 0.05, - "3" : 0.05 - }, - # The fraction of each flux ramp cycle above which we stop - # applying feedback, within each cycle. Must be >0. If >1, - # then feedback over the entire cycle (after feedbackStart). - "feedback_end_frac" : { - "2" : 0.98, - "3" : 0.98 - }, - "gradient_descent_gain": { - "2" : 1e-5, - "3" : 1e-5 - }, - "gradient_descent_averages": { - "2" : 10, - "3" : 10 - }, - "eta_scan_averages": { - "2" : 10, - "3" : 10 - }, - "default_tune": "/data/smurf_data/tune/1555011900_tune.npy" -}, - -"flux_ramp" : { - "select_ramp" : 1, - "ramp_start_mode" : 0, - "num_flux_ramp_counter_bits" : 32 -}, - -"constant" : { - "pA_per_phi0" : 9e6 -}, - -"timing" : { - # sel_ext_ref = 0: locked to the fiber timing system if - # - # sel_ext_ref = 1: internal oscillator locked to an external - # front-panel reference, or unlocked if there is no front - # panel reference. Assumes defaults.yml locks to fiber - # timing system by default (LmkReg_0x0147 : 0x0A) - "sel_ext_ref" : 1 -}, - -"fs" : 200.0, - -"smurf_to_mce" : { - "smurf_to_mce_file" : "/data/smurf2mce_config/smurf2mce.cfg", - "mask_file" : "/data/smurf2mce_config/mask.txt", - "receiver_ip" : "tcp://192.168.3.1:3334", - "port_number" : "3334", - "filter_freq" : 63, - "filter_order" : 4, - "filter_gain" : 1.0, - "file_name_extend" : 0, - "data_frames" : 2000000, - "static_mask" : 0, - "num_averages" : 20, - # Kludge to account for offset in gcp channel number in early - # versios of the DSPv3 fw. May be different for each band, in - # mitch_4_30 the offset for band 2 is -2. Mitch plans to fix - # in fw, so this should be unnecessary soon. - "mask_channel_offset" : -2 -}, - -"default_data_dir": "/data/smurf_data", -"smurf_cmd_dir": "/data/smurf_data/smurf_cmd", -"tune_dir" : "/data/smurf_data/tune", -"status_dir" : "/data/smurf_data/status" -} diff --git a/cfg_files/stanford/smurf-srv03/experiment_fp29_srv03_dspv3_noExtRef_lbOnlyBay0.cfg b/cfg_files/stanford/smurf-srv03/experiment_fp29_srv03_dspv3_noExtRef_lbOnlyBay0.cfg deleted file mode 100644 index 255b6acea..000000000 --- a/cfg_files/stanford/smurf-srv03/experiment_fp29_srv03_dspv3_noExtRef_lbOnlyBay0.cfg +++ /dev/null @@ -1,257 +0,0 @@ -{ -"epics_root" : "test_epics", -"init": { - - "bands" : [2,3], - "dspEnable": 1, - - "band_2" : { - "iq_swap_in" : 0, - "iq_swap_out" : 0, - "refPhaseDelay" : 6, - "refPhaseDelayFine" : 0, - # Matches system latency for LMS feedback (multiplex - # of 52x 9.6MHz ticks) Adjust to match refPhaseDelay*4 - # (e.g. if refPhaseDelay = 6, lmsDelay = 24). Mitch - # is checking this ; might not be refPhaseDelay*4 - - # need to revisit. - "lmsDelay" : 24, - # Adjust trigRstDly such that the ramp resets at the - # flux ramp glitch. Not totally clear at the moment - # what that means. - "trigRstDly" : 15, # 0xF - "toneScale" : 2, - "analysisScale" : 3, - "feedbackEnable": 1, - "feedbackGain" : 256, - "feedbackPolarity" : 1, - "synthesisScale": 2, - "feedbackLimitkHz": 225, - "lmsGain": 7, - "rfEnable": 1, - "bandCenterMHz": 5250, - "data_out_mux" : [6, 7], - "att_uc": 24, - "att_dc": 0, - "amplitude_scale": 12 - }, - - "band_3" : { - "iq_swap_in" : 0, - "iq_swap_out" : 0, - "refPhaseDelay" : 6, - "refPhaseDelayFine" : 0, - # Matches system latency for LMS feedback (multiplex - # of 52x 9.6MHz ticks) Adjust to match refPhaseDelay*4 - # (e.g. if refPhaseDelay = 6, lmsDelay = 24). Mitch - # is checking this ; might not be refPhaseDelay*4 - - # need to revisit. - "lmsDelay": 24, - # Adjust trigRstDly such that the ramp resets at the - # flux ramp glitch. Not totally clear at the moment - # what that means. - "trigRstDly" : 15, # 0xF - "toneScale" : 2, - "analysisScale" : 3, - "feedbackEnable": 1, - "feedbackGain" : 256, - "feedbackPolarity" : 1, - "synthesisScale": 2, - "feedbackLimitkHz": 225, - "lmsGain": 7, - "rfEnable": 1, - "bandCenterMHz": 5750, - "data_out_mux" : [8, 9], - "att_uc": 24, - "att_dc": 0, - "amplitude_scale": 12 - } -}, - -"bad_mask" : { -}, - -"channel_assignment" : { - "band_2" : "/usr/local/controls/Applications/smurf/pysmurf/pysmurf/scratch/shawn/channel_assignment_b2_teses.txt", - "band_3" : "/usr/local/controls/Applications/smurf/pysmurf/pysmurf/scratch/shawn/channel_assignment_b3.txt" -}, - -"amplifier": { - "hemt_Vg" : 0.60, - "bit_to_V_hemt" : 1.92e-6, - "hemt_Id_offset" : 1.00546875, - "LNA_Vg" : -0.718, - # 32 if using a C02 cryostat card. Some C01s were - # kludged to provide a 50k gate voltage for ASU 50K LNAs - # in early testing. For those, use 2. - "dac_num_50k" : 2, - "bit_to_V_50k" : 3.88e-6, - "hemt_gate_min_voltage" : -1.0, - "hemt_gate_max_voltage" : 1.0 -}, - -"attenuator" : { - "att1" : 0, - "att2" : 1, - "att3" : 2, - "att4" : 3 -}, - -"chip_to_freq" : { - "9" : [4.94150, 5.05], - "10" : [5.05, 5.17550 ], - "11" : [5.20150, 5.28250 ], - "12" : [5.28250, 5.41050 ], - "13" : [5.42050, 5.54550 ], - "14" : [5.55150, 5.67650 ], - "15" : [5.66650, 5.79150 ], - "16" : [5.79050, 5.91550 ] -}, - -# Set for C01 cryostat card. See -#https://confluence.slac.stanford.edu/display/SMuRF/Cryostat+board -"pic_to_bias_group": { - "9" : 8, - "11" : 10, - "13" : 12, - "15" : 14, - "14" : 15, - "12" : 13, - "10" : 11, - "8" : 9, - "7" : 6, - "5" : 4, - "3" : 2, - "1" : 0, - "6" : 7, - "4" : 5, - "2" : 3, - "0" : 1 -}, - -# Set for C01 cryostat card. See -#https://confluence.slac.stanford.edu/display/SMuRF/Cryostat+board -"bias_group_to_pair" : { - "8" : [2,1], - "10": [4,3], - "12": [6,5], - "14": [8,7], - "15": [10,9], - "13": [12,11], - "11": [14,13], - "9": [16,15], - "6": [18,17], - "4": [20,19], - "2": [22,21], - "0": [24,23], - "7": [26,25], - "5": [28,27], - "3": [30,29], - "1": [32,31] -}, - -"band_to_chip" : { - "1" : [1, 2, 3, 4], - "2" : [5, 6, 7, 8], - "3" : [9, 10, 11, 12], - "4" : [13, 14, 15, 16] -}, - - -"R_sh" : 390e-6, -"bias_line_resistance" : 25479, -"high_low_current_ratio" : 12.50, - -"high_current_mode_bool": 0, - -"all_bias_groups": [3], - -"tune_band" : { - "n_samples" : 262144, - "grad_cut" : 0.05, - "amp_cut" : 0.25, - "freq_max" : 250000000, - "freq_min" : -250000000, - # For Stanford 5-6ghz 528 box in FP29, with a standard (not - # modified for high current) RTM - "fraction_full_scale": 0.495, - "lms_freq": { - "2" : 16500, - "3" : 16500 - }, - # The fraction of each flux ramp cycle above which we start - # applying feedback, within each cycle. Must be >0. If >1, - # then You want this to be large enough to mask the transient - # which occurs after each flux ramp reset. Must be in [0,1). - "feedback_start_frac" : { - "2" : 0.05, - "3" : 0.05 - }, - # The fraction of each flux ramp cycle above which we stop - # applying feedback, within each cycle. Must be >0. If >1, - # then feedback over the entire cycle (after feedbackStart). - "feedback_end_frac" : { - "2" : 0.98, - "3" : 0.98 - }, - "gradient_descent_gain": { - "2" : 1e-5, - "3" : 1e-5 - }, - "gradient_descent_averages": { - "2" : 10, - "3" : 10 - }, - "eta_scan_averages": { - "2" : 10, - "3" : 10 - }, - "default_tune": "/data/smurf_data/tune/1556941499_tune.npy" -}, - -"flux_ramp" : { - "select_ramp" : 1, - "ramp_start_mode" : 0, - "num_flux_ramp_counter_bits" : 32 -}, - -"constant" : { - "pA_per_phi0" : 9e6 -}, - -"timing" : { - # sel_ext_ref = 0: locked to the fiber timing system if - # - # sel_ext_ref = 1: internal oscillator locked to an external - # front-panel reference, or unlocked if there is no front - # panel reference. Assumes defaults.yml locks to fiber - # timing system by default (LmkReg_0x0147 : 0x0A) - "sel_ext_ref" : 1 -}, - -"fs" : 200.0, - -"smurf_to_mce" : { - "smurf_to_mce_file" : "/data/smurf2mce_config/smurf2mce.cfg", - "mask_file" : "/data/smurf2mce_config/mask.txt", - "receiver_ip" : "tcp://192.168.3.1:3334", - "port_number" : "3334", - "filter_freq" : 63, - "filter_order" : 4, - "filter_gain" : 1.0, - "file_name_extend" : 1, - "data_frames" : 2000000, - "static_mask" : 0, - "num_averages" : 20, - # Kludge to account for offset in gcp channel number in early - # versios of the DSPv3 fw. May be different for each band, in - # mitch_4_30 the offset for band 2 is -2. Mitch plans to fix - # in fw, so this should be unnecessary soon. - "mask_channel_offset" : -2 -}, - -"default_data_dir": "/data/smurf_data", -"smurf_cmd_dir": "/data/smurf_data/smurf_cmd", -"tune_dir" : "/data/smurf_data/tune", -"status_dir" : "/data/smurf_data/status" -} diff --git a/cfg_files/stanford/smurf-srv03/experiment_fp29_srv03_noExtRef.cfg b/cfg_files/stanford/smurf-srv03/experiment_fp29_srv03_noExtRef.cfg deleted file mode 100644 index 7656882c4..000000000 --- a/cfg_files/stanford/smurf-srv03/experiment_fp29_srv03_noExtRef.cfg +++ /dev/null @@ -1,196 +0,0 @@ -{ -"epics_root" : "test_epics", -"init": { - "bands" : [2,3], - "dspEnable": 1, - - "band_2" : { - "iq_swap_in" : 0, - "iq_swap_out" : 0, - "refPhaseDelay" : 6, - "refPhaseDelayFine" : 0, - "toneScale" : 2, - "analysisScale" : 3, - "feedbackEnable": 1, - "feedbackGain" : 256, - "feedbackPolarity" : 1, - "synthesisScale": 3, - "feedbackLimitkHz": 225, - "lmsGain": 7, - "rfEnable": 1, - "bandCenterMHz": 5250, - "data_out_mux" : [6, 7], - "att_uc": 24, - "att_dc": 0, - "amplitude_scale": 11 - }, - - "band_3" : { - "iq_swap_in" : 0, - "iq_swap_out" : 0, - "refPhaseDelay" : 6, - "refPhaseDelayFine" : 0, - "toneScale" : 2, - "analysisScale" : 3, - "feedbackEnable": 1, - "feedbackGain" : 256, - "feedbackPolarity" : 1, - "synthesisScale": 3, - "feedbackLimitkHz": 225, - "lmsGain": 7, - "rfEnable": 1, - "bandCenterMHz": 5750, - "data_out_mux" : [8, 9], - "att_uc": 24, - "att_dc": 0, - "amplitude_scale": 11 - } -}, - -"bad_mask" : { -}, - -"channel_assignment" : { - "band_2" : "/usr/local/controls/Applications/smurf/pysmurf/pysmurf/scratch/shawn/channel_assignment_b2_teses.txt", - "band_3" : "/usr/local/controls/Applications/smurf/pysmurf/pysmurf/scratch/shawn/channel_assignment_b3.txt" -}, - -"amplifier": { - "hemt_Vg" : 0.60, - "bit_to_V_hemt" : 1.92e-6, - "bit_to_V_hemt_offset" : 0, - "LNA_Vg" : -0.718, - "dac_num_50k" : 32, - "bit_to_V_50k" : 3.88e-6 -}, - -"attenuator" : { - "att1" : 0, - "att2" : 1, - "att3" : 2, - "att4" : 3 -}, - -"chip_to_freq" : { - "9" : [4.94150, 5.05], - "10" : [5.05, 5.17550 ], - "11" : [5.20150, 5.28250 ], - "12" : [5.28250, 5.41050 ], - "13" : [5.42050, 5.54550 ], - "14" : [5.55150, 5.67650 ], - "15" : [5.66650, 5.79150 ], - "16" : [5.79050, 5.91550 ] -}, - -"pic_to_bias_group": { - "9" : 8, - "11" : 10, - "13" : 12, - "15" : 14, - "14" : 15, - "12" : 13, - "10" : 11, - "8" : 9, - "7" : 6, - "5" : 4, - "3" : 2, - "1" : 0, - "6" : 7, - "4" : 5, - "2" : 3, - "0" : 1 -}, - -"bias_group_to_pair" : { - "8" : [2,1], - "10": [4,3], - "12": [6,5], - "14": [8,7], - "15": [10,9], - "13": [12,11], - "11": [14,13], - "9": [16,15], - "6": [18,17], - "4": [20,19], - "2": [22,21], - "0": [24,23], - "7": [26,25], - "5": [28,27], - "3": [30,29], - "1": [32,31] -}, - -"band_to_chip" : { - "1" : [1, 2, 3, 4], - "2" : [5, 6, 7, 8], - "3" : [9, 10, 11, 12], - "4" : [13, 14, 15, 16] -}, - - -"R_sh" : 390e-6, -"bias_line_resistance" : 25479, -"high_low_current_ratio" : 12.50, - -"high_current_mode_bool": 0, - -"all_bias_groups": [3], - -"tune_band" : { - "n_samples" : 262144, - "grad_cut" : 0.05, - "amp_cut" : 0.25, - "freq_max" : 250000000, - "freq_min" : -250000000, - "fraction_full_scale": 0.495, - "lms_freq": { - "2" : 16660, - "3" : 19500 - }, - "gradient_descent_gain": { - "2" : 1e-5, - "3" : 1e-5 - }, - "gradient_descent_averages": { - "2" : 10, - "3" : 10 - }, - "eta_scan_averages": { - "2" : 10, - "3" : 10 - }, - "default_tune": "/data/smurf_data/tune/1547959798_tune.npy" -}, - -"flux_ramp" : { - "select_ramp" : 1, - "ramp_start_mode" : 0, - "num_flux_ramp_counter_bits" : 32 -}, - -"constant" : { - "pA_per_phi0" : 9e6 -}, - -"fs" : 180.37518037518038, - -"smurf_to_mce" : { - "smurf_to_mce_file" : "/data/smurf2mce_config/smurf2mce.cfg", - "mask_file" : "/data/smurf2mce_config/mask.txt", - "receiver_ip" : "tcp://192.168.3.1:3334", - "port_number" : "3334", - "filter_freq" : 63, - "filter_order" : 4, - "filter_gain" : 1.0, - "file_name_extend" : 0, - "data_frames" : 2000000, - "static_mask" : 0, - "num_averages" : 20 - -}, - -"default_data_dir": "/data/smurf_data", -"smurf_cmd_dir": "/data/smurf_data/smurf_cmd", -"tune_dir" : "/data/smurf_data/tune", -"status_dir" : "/data/smurf_data/status" -} diff --git a/cfg_files/stanford/smurf-srv03/experiment_fp29_srv03_noExtRef_hbOnlyBay0.cfg b/cfg_files/stanford/smurf-srv03/experiment_fp29_srv03_noExtRef_hbOnlyBay0.cfg deleted file mode 100644 index 1efd797e2..000000000 --- a/cfg_files/stanford/smurf-srv03/experiment_fp29_srv03_noExtRef_hbOnlyBay0.cfg +++ /dev/null @@ -1,198 +0,0 @@ -{ -"epics_root" : "test_epics", -"init": { - "bands" : [2,3], - "dspEnable": 1, - - "band_2" : { - "iq_swap_in" : 0, - "iq_swap_out" : 0, - "refPhaseDelay" : 6, - "refPhaseDelayFine" : 0, - "toneScale" : 2, - "analysisScale" : 3, - "feedbackEnable": 1, - "feedbackGain" : 256, - "feedbackPolarity" : 1, - "synthesisScale": 3, - "feedbackLimitkHz": 225, - "lmsGain": 7, - "rfEnable": 1, - "bandCenterMHz": 5250, - "data_out_mux" : [6, 7], - "att_uc": 0, - "att_dc": 0, - "amplitude_scale": 11 - }, - - "band_3" : { - "iq_swap_in" : 0, - "iq_swap_out" : 0, - "refPhaseDelay" : 6, - "refPhaseDelayFine" : 0, - "toneScale" : 2, - "analysisScale" : 3, - "feedbackEnable": 1, - "feedbackGain" : 256, - "feedbackPolarity" : 1, - "synthesisScale": 3, - "feedbackLimitkHz": 225, - "lmsGain": 7, - "rfEnable": 1, - "bandCenterMHz": 5750, - "data_out_mux" : [8, 9], - "att_uc": 0, - "att_dc": 0, - "amplitude_scale": 11 - } -}, - -"bad_mask" : { -}, - -"channel_assignment" : { - "band_2" : "/usr/local/controls/Applications/smurf/pysmurf/pysmurf/scratch/shawn/channel_assignment_b2_teses.txt", - "band_3" : "/usr/local/controls/Applications/smurf/pysmurf/pysmurf/scratch/shawn/channel_assignment_b3.txt" -}, - -"amplifier": { - "hemt_Vg" : 0.60, - "bit_to_V_hemt" : 1.92e-6, - "hemt_Id_offset" : 1.00546875, - "LNA_Vg" : -0.718, - "dac_num_50k" : 2, - "bit_to_V_50k" : 3.88e-6, - "hemt_gate_min_voltage" : -1.0, - "hemt_gate_max_voltage" : 1.0 -}, - -"attenuator" : { - "att1" : 0, - "att2" : 1, - "att3" : 2, - "att4" : 3 -}, - -"chip_to_freq" : { - "9" : [4.94150, 5.05], - "10" : [5.05, 5.17550 ], - "11" : [5.20150, 5.28250 ], - "12" : [5.28250, 5.41050 ], - "13" : [5.42050, 5.54550 ], - "14" : [5.55150, 5.67650 ], - "15" : [5.66650, 5.79150 ], - "16" : [5.79050, 5.91550 ] -}, - -"pic_to_bias_group": { - "9" : 8, - "11" : 10, - "13" : 12, - "15" : 14, - "14" : 15, - "12" : 13, - "10" : 11, - "8" : 9, - "7" : 6, - "5" : 4, - "3" : 2, - "1" : 0, - "6" : 7, - "4" : 5, - "2" : 3, - "0" : 1 -}, - -"bias_group_to_pair" : { - "8" : [2,1], - "10": [4,3], - "12": [6,5], - "14": [8,7], - "15": [10,9], - "13": [12,11], - "11": [14,13], - "9": [16,15], - "6": [18,17], - "4": [20,19], - "2": [22,21], - "0": [24,23], - "7": [26,25], - "5": [28,27], - "3": [30,29], - "1": [32,31] -}, - -"band_to_chip" : { - "1" : [1, 2, 3, 4], - "2" : [5, 6, 7, 8], - "3" : [9, 10, 11, 12], - "4" : [13, 14, 15, 16] -}, - - -"R_sh" : 390e-6, -"bias_line_resistance" : 25479, -"high_low_current_ratio" : 12.50, - -"high_current_mode_bool": 0, - -"all_bias_groups": [3], - -"tune_band" : { - "n_samples" : 262144, - "grad_cut" : 0.05, - "amp_cut" : 0.25, - "freq_max" : 250000000, - "freq_min" : -250000000, - "fraction_full_scale": 0.65, - "lms_freq": { - "2" : 8520, - "3" : 8520 - }, - "gradient_descent_gain": { - "2" : 1e-5, - "3" : 1e-5 - }, - "gradient_descent_averages": { - "2" : 10, - "3" : 10 - }, - "eta_scan_averages": { - "2" : 10, - "3" : 10 - }, - "default_tune": "/data/smurf_data/tune/1555011900_tune.npy" -}, - -"flux_ramp" : { - "select_ramp" : 1, - "ramp_start_mode" : 0, - "num_flux_ramp_counter_bits" : 32 -}, - -"constant" : { - "pA_per_phi0" : 9e6 -}, - -"fs" : 200.0, - -"smurf_to_mce" : { - "smurf_to_mce_file" : "/data/smurf2mce_config/smurf2mce.cfg", - "mask_file" : "/data/smurf2mce_config/mask.txt", - "receiver_ip" : "tcp://192.168.3.1:3334", - "port_number" : "3334", - "filter_freq" : 63, - "filter_order" : 4, - "filter_gain" : 1.0, - "file_name_extend" : 0, - "data_frames" : 2000000, - "static_mask" : 0, - "num_averages" : 20 - -}, - -"default_data_dir": "/data/smurf_data", -"smurf_cmd_dir": "/data/smurf_data/smurf_cmd", -"tune_dir" : "/data/smurf_data/tune", -"status_dir" : "/data/smurf_data/status" -} diff --git a/cfg_files/stanford/smurf-srv03/experiment_fp29_srv03_noExtRef_lbOnlyBay0.cfg b/cfg_files/stanford/smurf-srv03/experiment_fp29_srv03_noExtRef_lbOnlyBay0.cfg deleted file mode 100644 index c78c47dc6..000000000 --- a/cfg_files/stanford/smurf-srv03/experiment_fp29_srv03_noExtRef_lbOnlyBay0.cfg +++ /dev/null @@ -1,198 +0,0 @@ -{ -"epics_root" : "test_epics", -"init": { - "bands" : [2,3], - "dspEnable": 1, - - "band_2" : { - "iq_swap_in" : 0, - "iq_swap_out" : 0, - "refPhaseDelay" : 6, - "refPhaseDelayFine" : 0, - "toneScale" : 2, - "analysisScale" : 3, - "feedbackEnable": 1, - "feedbackGain" : 256, - "feedbackPolarity" : 1, - "synthesisScale": 2, - "feedbackLimitkHz": 225, - "lmsGain": 7, - "rfEnable": 1, - "bandCenterMHz": 5250, - "data_out_mux" : [6, 7], - "att_uc": 24, - "att_dc": 0, - "amplitude_scale": 12 - }, - - "band_3" : { - "iq_swap_in" : 0, - "iq_swap_out" : 0, - "refPhaseDelay" : 6, - "refPhaseDelayFine" : 0, - "toneScale" : 2, - "analysisScale" : 3, - "feedbackEnable": 1, - "feedbackGain" : 256, - "feedbackPolarity" : 1, - "synthesisScale": 2, - "feedbackLimitkHz": 225, - "lmsGain": 7, - "rfEnable": 1, - "bandCenterMHz": 5750, - "data_out_mux" : [8, 9], - "att_uc": 24, - "att_dc": 0, - "amplitude_scale": 12 - } -}, - -"bad_mask" : { -}, - -"channel_assignment" : { - "band_2" : "/usr/local/controls/Applications/smurf/pysmurf/pysmurf/scratch/shawn/channel_assignment_b2_teses.txt", - "band_3" : "/usr/local/controls/Applications/smurf/pysmurf/pysmurf/scratch/shawn/channel_assignment_b3.txt" -}, - -"amplifier": { - "hemt_Vg" : 0.60, - "bit_to_V_hemt" : 1.92e-6, - "hemt_Id_offset" : 1.00546875, - "LNA_Vg" : -0.718, - "dac_num_50k" : 2, - "bit_to_V_50k" : 3.88e-6, - "hemt_gate_min_voltage" : -1.0, - "hemt_gate_max_voltage" : 1.0 -}, - -"attenuator" : { - "att1" : 0, - "att2" : 1, - "att3" : 2, - "att4" : 3 -}, - -"chip_to_freq" : { - "9" : [4.94150, 5.05], - "10" : [5.05, 5.17550 ], - "11" : [5.20150, 5.28250 ], - "12" : [5.28250, 5.41050 ], - "13" : [5.42050, 5.54550 ], - "14" : [5.55150, 5.67650 ], - "15" : [5.66650, 5.79150 ], - "16" : [5.79050, 5.91550 ] -}, - -"pic_to_bias_group": { - "9" : 8, - "11" : 10, - "13" : 12, - "15" : 14, - "14" : 15, - "12" : 13, - "10" : 11, - "8" : 9, - "7" : 6, - "5" : 4, - "3" : 2, - "1" : 0, - "6" : 7, - "4" : 5, - "2" : 3, - "0" : 1 -}, - -"bias_group_to_pair" : { - "8" : [2,1], - "10": [4,3], - "12": [6,5], - "14": [8,7], - "15": [10,9], - "13": [12,11], - "11": [14,13], - "9": [16,15], - "6": [18,17], - "4": [20,19], - "2": [22,21], - "0": [24,23], - "7": [26,25], - "5": [28,27], - "3": [30,29], - "1": [32,31] -}, - -"band_to_chip" : { - "1" : [1, 2, 3, 4], - "2" : [5, 6, 7, 8], - "3" : [9, 10, 11, 12], - "4" : [13, 14, 15, 16] -}, - - -"R_sh" : 390e-6, -"bias_line_resistance" : 25479, -"high_low_current_ratio" : 12.50, - -"high_current_mode_bool": 0, - -"all_bias_groups": [3], - -"tune_band" : { - "n_samples" : 262144, - "grad_cut" : 0.05, - "amp_cut" : 0.25, - "freq_max" : 250000000, - "freq_min" : -250000000, - "fraction_full_scale": 0.170, - "lms_freq": { - "2" : 16500, - "3" : 16500 - }, - "gradient_descent_gain": { - "2" : 1e-5, - "3" : 1e-5 - }, - "gradient_descent_averages": { - "2" : 10, - "3" : 10 - }, - "eta_scan_averages": { - "2" : 10, - "3" : 10 - }, - "default_tune": "/data/smurf_data/tune/1554415480_tune.npy" -}, - -"flux_ramp" : { - "select_ramp" : 1, - "ramp_start_mode" : 0, - "num_flux_ramp_counter_bits" : 32 -}, - -"constant" : { - "pA_per_phi0" : 9e6 -}, - -"fs" : 200.0, - -"smurf_to_mce" : { - "smurf_to_mce_file" : "/data/smurf2mce_config/smurf2mce.cfg", - "mask_file" : "/data/smurf2mce_config/mask.txt", - "receiver_ip" : "tcp://192.168.3.1:3334", - "port_number" : "3334", - "filter_freq" : 63, - "filter_order" : 4, - "filter_gain" : 1.0, - "file_name_extend" : 0, - "data_frames" : 2000000, - "static_mask" : 0, - "num_averages" : 20 - -}, - -"default_data_dir": "/data/smurf_data", -"smurf_cmd_dir": "/data/smurf_data/smurf_cmd", -"tune_dir" : "/data/smurf_data/tune", -"status_dir" : "/data/smurf_data/status" -} diff --git a/cfg_files/stanford/smurf-srv04/experiment_fp28_srv04.cfg b/cfg_files/stanford/smurf-srv04/experiment_fp28_srv04.cfg deleted file mode 100644 index 17852adba..000000000 --- a/cfg_files/stanford/smurf-srv04/experiment_fp28_srv04.cfg +++ /dev/null @@ -1,191 +0,0 @@ -{ -"epics_root" : "test_epics", -"init": { - "bands" : [2,3], - "dspEnable": 1, - - "band_2" : { - "iq_swap_in" : 0, - "iq_swap_out" : 0, - "refPhaseDelay" : 6, - "refPhaseDelayFine" : 0, - "toneScale" : 2, - "analysisScale" : 3, - "feedbackEnable": 1, - "feedbackGain" : 256, - "feedbackPolarity" : 1, - "synthesisScale": 3, - "feedbackLimitkHz": 225, - "lmsGain": 7, - "rfEnable": 1, - "bandCenterMHz": 5250, - "data_out_mux" : [6, 7], - "att_uc": 0, - "att_dc": 0, - "amplitude_scale": 11 - }, - - "band_3" : { - "iq_swap_in" : 0, - "iq_swap_out" : 0, - "refPhaseDelay" : 6, - "refPhaseDelayFine" : 0, - "toneScale" : 2, - "analysisScale" : 3, - "feedbackEnable": 1, - "feedbackGain" : 256, - "feedbackPolarity" : 1, - "synthesisScale": 3, - "feedbackLimitkHz": 225, - "lmsGain": 7, - "rfEnable": 1, - "bandCenterMHz": 5750, - "data_out_mux" : [8, 9], - "att_uc": 0, - "att_dc": 0, - "amplitude_scale": 11 - } -}, - -"bad_mask" : { -}, - -"channel_assignment" : { - "band_2" : "/usr/local/controls/Applications/smurf/pysmurf/pysmurf/scratch/shawn/channel_assignment_b2_teses.txt", - "band_3" : "/usr/local/controls/Applications/smurf/pysmurf/pysmurf/scratch/shawn/channel_assignment_b3.txt" -}, - -"amplifier": { - "hemt_Vg" : 0.60, - "LNA_Vg" : -0.718 -}, - -"attenuator" : { - "att1" : 0, - "att2" : 1, - "att3" : 2, - "att4" : 3 -}, - -"chip_to_freq" : { - "9" : [4.94150, 5.05], - "10" : [5.05, 5.17550 ], - "11" : [5.20150, 5.28250 ], - "12" : [5.28250, 5.41050 ], - "13" : [5.42050, 5.54550 ], - "14" : [5.55150, 5.67650 ], - "15" : [5.66650, 5.79150 ], - "16" : [5.79050, 5.91550 ] -}, - -"pic_to_bias_group": { - "9" : 8, - "11" : 10, - "13" : 12, - "15" : 14, - "14" : 15, - "12" : 13, - "10" : 11, - "8" : 9, - "7" : 6, - "5" : 4, - "3" : 2, - "1" : 0, - "6" : 7, - "4" : 5, - "2" : 3, - "0" : 1 -}, - -"bias_group_to_pair" : { - "8" : [2,1], - "10": [4,3], - "12": [6,5], - "14": [8,7], - "15": [10,9], - "13": [12,11], - "11": [14,13], - "9": [16,15], - "6": [18,17], - "4": [20,19], - "2": [22,21], - "0": [24,23], - "7": [26,25], - "5": [28,27], - "3": [30,29], - "1": [32,31] -}, - -"band_to_chip" : { - "1" : [1, 2, 3, 4], - "2" : [5, 6, 7, 8], - "3" : [9, 10, 11, 12], - "4" : [13, 14, 15, 16] -}, - - -"R_sh" : 390e-6, -"bias_line_resistance" : 25479, -"high_low_current_ratio" : 12.50, - -"high_current_mode_bool": 0, - -"all_bias_groups": [3], - -"tune_band" : { - "n_samples" : 262144, - "grad_cut" : 0.05, - "amp_cut" : 0.25, - "freq_max" : 250000000, - "freq_min" : -250000000, - "fraction_full_scale": 0.495, - "lms_freq": { - "2" : 16660, - "3" : 19500 - }, - "gradient_descent_gain": { - "2" : 1e-5, - "3" : 1e-5 - }, - "gradient_descent_averages": { - "2" : 10, - "3" : 10 - }, - "eta_scan_averages": { - "2" : 10, - "3" : 10 - }, - "default_tune": "/data/smurf_data/tune/1547959798_tune.npy" -}, - -"flux_ramp" : { - "select_ramp" : 1, - "ramp_start_mode" : 1, - "num_flux_ramp_counter_bits" : 32 -}, - -"constant" : { - "pA_per_phi0" : 9e6 -}, - -"fs" : 180.37518037518038, - -"smurf_to_mce" : { - "smurf_to_mce_file" : "/usr/local/controls/Applications/smurf/smurf2mce/current/mcetransmit/smurf2mce.cfg", - "mask_file" : "/usr/local/controls/Applications/smurf/smurf2mce/current/mcetransmit/mask.txt", - "receiver_ip" : "tcp://192.168.3.1:3334", - "port_number" : "3334", - "filter_freq" : 63, - "filter_order" : 4, - "filter_gain" : 1.0, - "file_name_extend" : 0, - "data_frames" : 2000000, - "static_mask" : 0 - -}, - -"default_data_dir": "/data/smurf_data", -"smurf_cmd_dir": "/data/smurf_data/smurf_cmd", -"tune_dir" : "/data/smurf_data/tune", -"status_dir" : "/data/smurf_data/status" -} diff --git a/cfg_files/stanford/smurf-srv04/experiment_fp29_srv04.cfg b/cfg_files/stanford/smurf-srv04/experiment_fp29_srv04.cfg deleted file mode 100644 index 64d1857d3..000000000 --- a/cfg_files/stanford/smurf-srv04/experiment_fp29_srv04.cfg +++ /dev/null @@ -1,243 +0,0 @@ -{ -"epics_root" : "test_epics", -"init": { - "bands" : [2,3,6,7], - "dspEnable": 1, - - "band_2" : { - "iq_swap_in" : 0, - "iq_swap_out" : 0, - "refPhaseDelay" : 6, - "refPhaseDelayFine" : 0, - "toneScale" : 2, - "analysisScale" : 3, - "feedbackEnable": 1, - "feedbackGain" : 256, - "feedbackPolarity" : 1, - "synthesisScale": 3, - "feedbackLimitkHz": 225, - "lmsGain": 7, - "rfEnable": 1, - "bandCenterMHz": 5250, - "data_out_mux" : [6, 7], - "att_uc": 0, - "att_dc": 0, - "amplitude_scale": 11 - }, - - "band_3" : { - "iq_swap_in" : 0, - "iq_swap_out" : 0, - "refPhaseDelay" : 6, - "refPhaseDelayFine" : 0, - "toneScale" : 2, - "analysisScale" : 3, - "feedbackEnable": 1, - "feedbackGain" : 256, - "feedbackPolarity" : 1, - "synthesisScale": 3, - "feedbackLimitkHz": 225, - "lmsGain": 7, - "rfEnable": 1, - "bandCenterMHz": 5750, - "data_out_mux" : [8, 9], - "att_uc": 0, - "att_dc": 0, - "amplitude_scale": 11 - }, - - "band_6" : { - "iq_swap_in" : 0, - "iq_swap_out" : 0, - "refPhaseDelay" : 6, - "refPhaseDelayFine" : 0, - "toneScale" : 2, - "analysisScale" : 3, - "feedbackEnable": 1, - "feedbackGain" : 256, - "feedbackPolarity" : 1, - "synthesisScale": 3, - "feedbackLimitkHz": 225, - "lmsGain": 7, - "rfEnable": 1, - "bandCenterMHz": 7250, - "data_out_mux" : [8, 9], - "att_uc": 0, - "att_dc": 0, - "amplitude_scale": 11 - }, - - "band_7" : { - "iq_swap_in" : 0, - "iq_swap_out" : 0, - "refPhaseDelay" : 6, - "refPhaseDelayFine" : 0, - "toneScale" : 2, - "analysisScale" : 3, - "feedbackEnable": 1, - "feedbackGain" : 256, - "feedbackPolarity" : 1, - "synthesisScale": 3, - "feedbackLimitkHz": 225, - "lmsGain": 7, - "rfEnable": 1, - "bandCenterMHz": 7750, - "data_out_mux" : [8, 9], - "att_uc": 0, - "att_dc": 0, - "amplitude_scale": 11 - } -}, - -"bad_mask" : { -}, - -"channel_assignment" : { - "band_2" : "/usr/local/controls/Applications/smurf/pysmurf/pysmurf/scratch/shawn/channel_assignment_b2.txt", - "band_3" : "/usr/local/controls/Applications/smurf/pysmurf/pysmurf/scratch/shawn/channel_assignment_b3.txt", - "band_6" : "/usr/local/controls/Applications/smurf/pysmurf/pysmurf/scratch/shawn/channel_assignment_b6.txt", - "band_7" : "/usr/local/controls/Applications/smurf/pysmurf/pysmurf/scratch/shawn/channel_assignment_b7.txt" -}, - -"amplifier": { - "hemt_Vg" : 0.60, - "LNA_Vg" : -0.718 -}, - -"attenuator" : { - "att1" : 0, - "att2" : 1, - "att3" : 2, - "att4" : 3 -}, - -"chip_to_freq" : { - "9" : [4.94150, 5.05], - "10" : [5.05, 5.17550 ], - "11" : [5.20150, 5.28250 ], - "12" : [5.28250, 5.41050 ], - "13" : [5.42050, 5.54550 ], - "14" : [5.55150, 5.67650 ], - "15" : [5.66650, 5.79150 ], - "16" : [5.79050, 5.91550 ] -}, - -"pic_to_bias_group": { - "9" : 8, - "11" : 10, - "13" : 12, - "15" : 14, - "14" : 15, - "12" : 13, - "10" : 11, - "8" : 9, - "7" : 6, - "5" : 4, - "3" : 2, - "1" : 0, - "6" : 7, - "4" : 5, - "2" : 3, - "0" : 1 -}, - -"bias_group_to_pair" : { - "8" : [2,1], - "10": [4,3], - "12": [6,5], - "14": [8,7], - "15": [10,9], - "13": [12,11], - "11": [14,13], - "9": [16,15], - "6": [18,17], - "4": [20,19], - "2": [22,21], - "0": [24,23], - "7": [26,25], - "5": [28,27], - "3": [30,29], - "1": [32,31] -}, - -"band_to_chip" : { - "1" : [1, 2, 3, 4], - "2" : [5, 6, 7, 8], - "3" : [9, 10, 11, 12], - "4" : [13, 14, 15, 16] -}, - - -"R_sh" : 390e-6, -"bias_line_resistance" : 25479, -"high_low_current_ratio" : 12.50, - -"high_current_mode_bool": 0, - -"all_bias_groups": [3], - -"tune_band" : { - "n_samples" : 262144, - "grad_cut" : 0.05, - "amp_cut" : 0.25, - "freq_max" : 250000000, - "freq_min" : -250000000, - "fraction_full_scale": 0.495, - "lms_freq": { - "2" : 16660, - "3" : 19500, - "6" : 0, - "7" : 0 - }, - "gradient_descent_gain": { - "2" : 1e-5, - "3" : 1e-5, - "6" : 1e-5, - "7" : 1e-5 - }, - "gradient_descent_averages": { - "2" : 10, - "3" : 10, - "6" : 10, - "7" : 10 - }, - "eta_scan_averages": { - "2" : 10, - "3" : 10, - "6" : 10, - "7" : 10 - }, - "default_tune": "/data/smurf_data/tune/1547959798_tune.npy" -}, - -"flux_ramp" : { - "select_ramp" : 1, - "ramp_start_mode" : 1, - "num_flux_ramp_counter_bits" : 32 -}, - -"constant" : { - "pA_per_phi0" : 9e6 -}, - -"fs" : 180.37518037518038, - -"smurf_to_mce" : { - "smurf_to_mce_file" : "/usr/local/controls/Applications/smurf/smurf2mce/current/mcetransmit/smurf2mce.cfg", - "mask_file" : "/usr/local/controls/Applications/smurf/smurf2mce/current/mcetransmit/mask.txt", - "receiver_ip" : "tcp://192.168.3.1:3334", - "port_number" : "3334", - "filter_freq" : 63, - "filter_order" : 4, - "filter_gain" : 1.0, - "file_name_extend" : 0, - "data_frames" : 2000000, - "static_mask" : 0 - -}, - -"default_data_dir": "/data/smurf_data", -"smurf_cmd_dir": "/data/smurf_data/smurf_cmd", -"tune_dir" : "/data/smurf_data/tune", -"status_dir" : "/data/smurf_data/status" -} diff --git a/command/__init__.py b/command/__init__.py deleted file mode 100644 index d6bb08793..000000000 --- a/command/__init__.py +++ /dev/null @@ -1,3 +0,0 @@ -''' -init for command directory -''' diff --git a/debug/__init__.py b/debug/__init__.py deleted file mode 100644 index 047502118..000000000 --- a/debug/__init__.py +++ /dev/null @@ -1,3 +0,0 @@ -''' -init for debug dir -''' diff --git a/docs/.gitignore b/docs/.gitignore new file mode 100644 index 000000000..69fa449dd --- /dev/null +++ b/docs/.gitignore @@ -0,0 +1 @@ +_build/ diff --git a/docs/Makefile b/docs/Makefile index 43aa28bd0..161b5978b 100644 --- a/docs/Makefile +++ b/docs/Makefile @@ -5,9 +5,8 @@ SPHINXOPTS = SPHINXBUILD = sphinx-build PAPER = -BUILDDIR = _build SOURCEDIR = . -BUILDDIR = . +BUILDDIR = _build # Internal variables. PAPEROPT_a4 = -D latex_paper_size=a4 diff --git a/docs/_build/doctrees/environment.pickle b/docs/_build/doctrees/environment.pickle deleted file mode 100644 index 47849b226..000000000 Binary files a/docs/_build/doctrees/environment.pickle and /dev/null differ diff --git a/docs/_build/doctrees/index.doctree b/docs/_build/doctrees/index.doctree deleted file mode 100644 index 4c8caa225..000000000 Binary files a/docs/_build/doctrees/index.doctree and /dev/null differ diff --git a/docs/_build/html/.buildinfo b/docs/_build/html/.buildinfo deleted file mode 100644 index 48faa5f6d..000000000 --- a/docs/_build/html/.buildinfo +++ /dev/null @@ -1,4 +0,0 @@ -# Sphinx build info version 1 -# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done. -config: a8c20b35fe6c25f611b68eb68a9c5b04 -tags: fbb0d17656682115ca4d033fb2f83ba1 diff --git a/docs/_build/html/_sources/index.txt b/docs/_build/html/_sources/index.txt deleted file mode 100644 index 877b7ced3..000000000 --- a/docs/_build/html/_sources/index.txt +++ /dev/null @@ -1,20 +0,0 @@ -.. pysmurf documentation master file, created by - sphinx-quickstart on Tue Feb 19 15:17:07 2019. - You can adapt this file completely to your liking, but it should at least - contain the root `toctree` directive. - -Welcome to pysmurf's documentation! -=================================== - -Contents: - -.. toctree:: - :maxdepth: 2 - -Indices and tables -================== - -* :ref:`genindex` -* :ref:`modindex` -* :ref:`search` - diff --git a/docs/_build/html/_static/basic.css b/docs/_build/html/_static/basic.css deleted file mode 100644 index a04d6545b..000000000 --- a/docs/_build/html/_static/basic.css +++ /dev/null @@ -1,417 +0,0 @@ -/** - * Sphinx stylesheet -- basic theme - * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - */ - -/* -- main layout ----------------------------------------------------------- */ - -div.clearer { - clear: both; -} - -/* -- relbar ---------------------------------------------------------------- */ - -div.related { - width: 100%; - font-size: 90%; -} - -div.related h3 { - display: none; -} - -div.related ul { - margin: 0; - padding: 0 0 0 10px; - list-style: none; -} - -div.related li { - display: inline; -} - -div.related li.right { - float: right; - margin-right: 5px; -} - -/* -- sidebar --------------------------------------------------------------- */ - -div.sphinxsidebarwrapper { - padding: 10px 5px 0 10px; -} - -div.sphinxsidebar { - float: left; - width: 230px; - margin-left: -100%; - font-size: 90%; -} - -div.sphinxsidebar ul { - list-style: none; -} - -div.sphinxsidebar ul ul, -div.sphinxsidebar ul.want-points { - margin-left: 20px; - list-style: square; -} - -div.sphinxsidebar ul ul { - margin-top: 0; - margin-bottom: 0; -} - -div.sphinxsidebar form { - margin-top: 10px; -} - -div.sphinxsidebar input { - border: 1px solid #98dbcc; - font-family: sans-serif; - font-size: 1em; -} - -img { - border: 0; -} - -/* -- search page ----------------------------------------------------------- */ - -ul.search { - margin: 10px 0 0 20px; - padding: 0; -} - -ul.search li { - padding: 5px 0 5px 20px; - background-image: url(file.png); - background-repeat: no-repeat; - background-position: 0 7px; -} - -ul.search li a { - font-weight: bold; -} - -ul.search li div.context { - color: #888; - margin: 2px 0 0 30px; - text-align: left; -} - -ul.keywordmatches li.goodmatch a { - font-weight: bold; -} - -/* -- index page ------------------------------------------------------------ */ - -table.contentstable { - width: 90%; -} - -table.contentstable p.biglink { - line-height: 150%; -} - -a.biglink { - font-size: 1.3em; -} - -span.linkdescr { - font-style: italic; - padding-top: 5px; - font-size: 90%; -} - -/* -- general index --------------------------------------------------------- */ - -table.indextable td { - text-align: left; - vertical-align: top; -} - -table.indextable dl, table.indextable dd { - margin-top: 0; - margin-bottom: 0; -} - -table.indextable tr.pcap { - height: 10px; -} - -table.indextable tr.cap { - margin-top: 10px; - background-color: #f2f2f2; -} - -img.toggler { - margin-right: 3px; - margin-top: 3px; - cursor: pointer; -} - -/* -- general body styles --------------------------------------------------- */ - -a.headerlink { - visibility: hidden; -} - -h1:hover > a.headerlink, -h2:hover > a.headerlink, -h3:hover > a.headerlink, -h4:hover > a.headerlink, -h5:hover > a.headerlink, -h6:hover > a.headerlink, -dt:hover > a.headerlink { - visibility: visible; -} - -div.body p.caption { - text-align: inherit; -} - -div.body td { - text-align: left; -} - -.field-list ul { - padding-left: 1em; -} - -.first { - margin-top: 0 !important; -} - -p.rubric { - margin-top: 30px; - font-weight: bold; -} - -/* -- sidebars -------------------------------------------------------------- */ - -div.sidebar { - margin: 0 0 0.5em 1em; - border: 1px solid #ddb; - padding: 7px 7px 0 7px; - background-color: #ffe; - width: 40%; - float: right; -} - -p.sidebar-title { - font-weight: bold; -} - -/* -- topics ---------------------------------------------------------------- */ - -div.topic { - border: 1px solid #ccc; - padding: 7px 7px 0 7px; - margin: 10px 0 10px 0; -} - -p.topic-title { - font-size: 1.1em; - font-weight: bold; - margin-top: 10px; -} - -/* -- admonitions ----------------------------------------------------------- */ - -div.admonition { - margin-top: 10px; - margin-bottom: 10px; - padding: 7px; -} - -div.admonition dt { - font-weight: bold; -} - -div.admonition dl { - margin-bottom: 0; -} - -p.admonition-title { - margin: 0px 10px 5px 0px; - font-weight: bold; -} - -div.body p.centered { - text-align: center; - margin-top: 25px; -} - -/* -- tables ---------------------------------------------------------------- */ - -table.docutils { - border: 0; - border-collapse: collapse; -} - -table.docutils td, table.docutils th { - padding: 1px 8px 1px 0; - border-top: 0; - border-left: 0; - border-right: 0; - border-bottom: 1px solid #aaa; -} - -table.field-list td, table.field-list th { - border: 0 !important; -} - -table.footnote td, table.footnote th { - border: 0 !important; -} - -th { - text-align: left; - padding-right: 5px; -} - -/* -- other body styles ----------------------------------------------------- */ - -dl { - margin-bottom: 15px; -} - -dd p { - margin-top: 0px; -} - -dd ul, dd table { - margin-bottom: 10px; -} - -dd { - margin-top: 3px; - margin-bottom: 10px; - margin-left: 30px; -} - -dt:target, .highlight { - background-color: #fbe54e; -} - -dl.glossary dt { - font-weight: bold; - font-size: 1.1em; -} - -.field-list ul { - margin: 0; - padding-left: 1em; -} - -.field-list p { - margin: 0; -} - -.refcount { - color: #060; -} - -.optional { - font-size: 1.3em; -} - -.versionmodified { - font-style: italic; -} - -.system-message { - background-color: #fda; - padding: 5px; - border: 3px solid red; -} - -.footnote:target { - background-color: #ffa -} - -.line-block { - display: block; - margin-top: 1em; - margin-bottom: 1em; -} - -.line-block .line-block { - margin-top: 0; - margin-bottom: 0; - margin-left: 1.5em; -} - -/* -- code displays --------------------------------------------------------- */ - -pre { - overflow: auto; -} - -td.linenos pre { - padding: 5px 0px; - border: 0; - background-color: transparent; - color: #aaa; -} - -table.highlighttable { - margin-left: 0.5em; -} - -table.highlighttable td { - padding: 0 0.5em 0 0.5em; -} - -tt.descname { - background-color: transparent; - font-weight: bold; - font-size: 1.2em; -} - -tt.descclassname { - background-color: transparent; -} - -tt.xref, a tt { - background-color: transparent; - font-weight: bold; -} - -h1 tt, h2 tt, h3 tt, h4 tt, h5 tt, h6 tt { - background-color: transparent; -} - -/* -- math display ---------------------------------------------------------- */ - -img.math { - vertical-align: middle; -} - -div.body div.math p { - text-align: center; -} - -span.eqno { - float: right; -} - -/* -- printout stylesheet --------------------------------------------------- */ - -@media print { - div.document, - div.documentwrapper, - div.bodywrapper { - margin: 0 !important; - width: 100%; - } - - div.sphinxsidebar, - div.related, - div.footer, - #top-link { - display: none; - } -} diff --git a/docs/_build/html/_static/default.css b/docs/_build/html/_static/default.css deleted file mode 100644 index 372574404..000000000 --- a/docs/_build/html/_static/default.css +++ /dev/null @@ -1,230 +0,0 @@ -/** - * Sphinx stylesheet -- default theme - * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - */ - -@import url("basic.css"); - -/* -- page layout ----------------------------------------------------------- */ - -body { - font-family: sans-serif; - font-size: 100%; - background-color: #11303d; - color: #000; - margin: 0; - padding: 0; -} - -div.document { - background-color: #1c4e63; -} - -div.documentwrapper { - float: left; - width: 100%; -} - -div.bodywrapper { - margin: 0 0 0 230px; -} - -div.body { - background-color: #ffffff; - color: #000000; - padding: 0 20px 30px 20px; -} - -div.footer { - color: #ffffff; - width: 100%; - padding: 9px 0 9px 0; - text-align: center; - font-size: 75%; -} - -div.footer a { - color: #ffffff; - text-decoration: underline; -} - -div.related { - background-color: #133f52; - line-height: 30px; - color: #ffffff; -} - -div.related a { - color: #ffffff; -} - -div.sphinxsidebar { -} - -div.sphinxsidebar h3 { - font-family: 'Trebuchet MS', sans-serif; - color: #ffffff; - font-size: 1.4em; - font-weight: normal; - margin: 0; - padding: 0; -} - -div.sphinxsidebar h3 a { - color: #ffffff; -} - -div.sphinxsidebar h4 { - font-family: 'Trebuchet MS', sans-serif; - color: #ffffff; - font-size: 1.3em; - font-weight: normal; - margin: 5px 0 0 0; - padding: 0; -} - -div.sphinxsidebar p { - color: #ffffff; -} - -div.sphinxsidebar p.topless { - margin: 5px 10px 10px 10px; -} - -div.sphinxsidebar ul { - margin: 10px; - padding: 0; - color: #ffffff; -} - -div.sphinxsidebar a { - color: #98dbcc; -} - -div.sphinxsidebar input { - border: 1px solid #98dbcc; - font-family: sans-serif; - font-size: 1em; -} - -/* -- body styles ----------------------------------------------------------- */ - -a { - color: #355f7c; - text-decoration: none; -} - -a:hover { - text-decoration: underline; -} - -div.body p, div.body dd, div.body li { - text-align: justify; - line-height: 130%; -} - -div.body h1, -div.body h2, -div.body h3, -div.body h4, -div.body h5, -div.body h6 { - font-family: 'Trebuchet MS', sans-serif; - background-color: #f2f2f2; - font-weight: normal; - color: #20435c; - border-bottom: 1px solid #ccc; - margin: 20px -20px 10px -20px; - padding: 3px 0 3px 10px; -} - -div.body h1 { margin-top: 0; font-size: 200%; } -div.body h2 { font-size: 160%; } -div.body h3 { font-size: 140%; } -div.body h4 { font-size: 120%; } -div.body h5 { font-size: 110%; } -div.body h6 { font-size: 100%; } - -a.headerlink { - color: #c60f0f; - font-size: 0.8em; - padding: 0 4px 0 4px; - text-decoration: none; -} - -a.headerlink:hover { - background-color: #c60f0f; - color: white; -} - -div.body p, div.body dd, div.body li { - text-align: justify; - line-height: 130%; -} - -div.admonition p.admonition-title + p { - display: inline; -} - -div.admonition p { - margin-bottom: 5px; -} - -div.admonition pre { - margin-bottom: 5px; -} - -div.admonition ul, div.admonition ol { - margin-bottom: 5px; -} - -div.note { - background-color: #eee; - border: 1px solid #ccc; -} - -div.seealso { - background-color: #ffc; - border: 1px solid #ff6; -} - -div.topic { - background-color: #eee; -} - -div.warning { - background-color: #ffe4e4; - border: 1px solid #f66; -} - -p.admonition-title { - display: inline; -} - -p.admonition-title:after { - content: ":"; -} - -pre { - padding: 5px; - background-color: #eeffcc; - color: #333333; - line-height: 120%; - border: 1px solid #ac9; - border-left: none; - border-right: none; -} - -tt { - background-color: #ecf0f3; - padding: 0 1px 0 1px; - font-size: 0.95em; -} - -.warning tt { - background: #efc2c2; -} - -.note tt { - background: #d6d6d6; -} \ No newline at end of file diff --git a/docs/_build/html/_static/doctools.js b/docs/_build/html/_static/doctools.js deleted file mode 100644 index 9447678cd..000000000 --- a/docs/_build/html/_static/doctools.js +++ /dev/null @@ -1,232 +0,0 @@ -/// XXX: make it cross browser - -/** - * make the code below compatible with browsers without - * an installed firebug like debugger - */ -if (!window.console || !console.firebug) { - var names = ["log", "debug", "info", "warn", "error", "assert", "dir", "dirxml", - "group", "groupEnd", "time", "timeEnd", "count", "trace", "profile", "profileEnd"]; - window.console = {}; - for (var i = 0; i < names.length; ++i) - window.console[names[i]] = function() {} -} - -/** - * small helper function to urldecode strings - */ -jQuery.urldecode = function(x) { - return decodeURIComponent(x).replace(/\+/g, ' '); -} - -/** - * small helper function to urlencode strings - */ -jQuery.urlencode = encodeURIComponent; - -/** - * This function returns the parsed url parameters of the - * current request. Multiple values per key are supported, - * it will always return arrays of strings for the value parts. - */ -jQuery.getQueryParameters = function(s) { - if (typeof s == 'undefined') - s = document.location.search; - var parts = s.substr(s.indexOf('?') + 1).split('&'); - var result = {}; - for (var i = 0; i < parts.length; i++) { - var tmp = parts[i].split('=', 2); - var key = jQuery.urldecode(tmp[0]); - var value = jQuery.urldecode(tmp[1]); - if (key in result) - result[key].push(value); - else - result[key] = [value]; - } - return result; -} - -/** - * small function to check if an array contains - * a given item. - */ -jQuery.contains = function(arr, item) { - for (var i = 0; i < arr.length; i++) { - if (arr[i] == item) - return true; - } - return false; -} - -/** - * highlight a given string on a jquery object by wrapping it in - * span elements with the given class name. - */ -jQuery.fn.highlightText = function(text, className) { - function highlight(node) { - if (node.nodeType == 3) { - var val = node.nodeValue; - var pos = val.toLowerCase().indexOf(text); - if (pos >= 0 && !jQuery.className.has(node.parentNode, className)) { - var span = document.createElement("span"); - span.className = className; - span.appendChild(document.createTextNode(val.substr(pos, text.length))); - node.parentNode.insertBefore(span, node.parentNode.insertBefore( - document.createTextNode(val.substr(pos + text.length)), - node.nextSibling)); - node.nodeValue = val.substr(0, pos); - } - } - else if (!jQuery(node).is("button, select, textarea")) { - jQuery.each(node.childNodes, function() { - highlight(this) - }); - } - } - return this.each(function() { - highlight(this); - }); -} - -/** - * Small JavaScript module for the documentation. - */ -var Documentation = { - - init : function() { - this.fixFirefoxAnchorBug(); - this.highlightSearchWords(); - this.initModIndex(); - }, - - /** - * i18n support - */ - TRANSLATIONS : {}, - PLURAL_EXPR : function(n) { return n == 1 ? 0 : 1; }, - LOCALE : 'unknown', - - // gettext and ngettext don't access this so that the functions - // can savely bound to a different name (_ = Documentation.gettext) - gettext : function(string) { - var translated = Documentation.TRANSLATIONS[string]; - if (typeof translated == 'undefined') - return string; - return (typeof translated == 'string') ? translated : translated[0]; - }, - - ngettext : function(singular, plural, n) { - var translated = Documentation.TRANSLATIONS[singular]; - if (typeof translated == 'undefined') - return (n == 1) ? singular : plural; - return translated[Documentation.PLURALEXPR(n)]; - }, - - addTranslations : function(catalog) { - for (var key in catalog.messages) - this.TRANSLATIONS[key] = catalog.messages[key]; - this.PLURAL_EXPR = new Function('n', 'return +(' + catalog.plural_expr + ')'); - this.LOCALE = catalog.locale; - }, - - /** - * add context elements like header anchor links - */ - addContextElements : function() { - $('div[id] > :header:first').each(function() { - $('\u00B6'). - attr('href', '#' + this.id). - attr('title', _('Permalink to this headline')). - appendTo(this); - }); - $('dt[id]').each(function() { - $('\u00B6'). - attr('href', '#' + this.id). - attr('title', _('Permalink to this definition')). - appendTo(this); - }); - }, - - /** - * workaround a firefox stupidity - */ - fixFirefoxAnchorBug : function() { - if (document.location.hash && $.browser.mozilla) - window.setTimeout(function() { - document.location.href += ''; - }, 10); - }, - - /** - * highlight the search words provided in the url in the text - */ - highlightSearchWords : function() { - var params = $.getQueryParameters(); - var terms = (params.highlight) ? params.highlight[0].split(/\s+/) : []; - if (terms.length) { - var body = $('div.body'); - window.setTimeout(function() { - $.each(terms, function() { - body.highlightText(this.toLowerCase(), 'highlight'); - }); - }, 10); - $('
  • ' + _('Hide Search Matches') + '
    • ') - .appendTo($('.sidebar .this-page-menu')); - } - }, - - /** - * init the modindex toggle buttons - */ - initModIndex : function() { - var togglers = $('img.toggler').click(function() { - var src = $(this).attr('src'); - var idnum = $(this).attr('id').substr(7); - console.log($('tr.cg-' + idnum).toggle()); - if (src.substr(-9) == 'minus.png') - $(this).attr('src', src.substr(0, src.length-9) + 'plus.png'); - else - $(this).attr('src', src.substr(0, src.length-8) + 'minus.png'); - }).css('display', ''); - if (DOCUMENTATION_OPTIONS.COLLAPSE_MODINDEX) { - togglers.click(); - } - }, - - /** - * helper function to hide the search marks again - */ - hideSearchWords : function() { - $('.sidebar .this-page-menu li.highlight-link').fadeOut(300); - $('span.highlight').removeClass('highlight'); - }, - - /** - * make the url absolute - */ - makeURL : function(relativeURL) { - return DOCUMENTATION_OPTIONS.URL_ROOT + '/' + relativeURL; - }, - - /** - * get the current relative url - */ - getCurrentURL : function() { - var path = document.location.pathname; - var parts = path.split(/\//); - $.each(DOCUMENTATION_OPTIONS.URL_ROOT.split(/\//), function() { - if (this == '..') - parts.pop(); - }); - var url = parts.join('/'); - return path.substring(url.lastIndexOf('/') + 1, path.length - 1); - } -}; - -// quick alias for translations -_ = Documentation.gettext; - -$(document).ready(function() { - Documentation.init(); -}); diff --git a/docs/_build/html/_static/jquery.js b/docs/_build/html/_static/jquery.js deleted file mode 100644 index 82b98e1d7..000000000 --- a/docs/_build/html/_static/jquery.js +++ /dev/null @@ -1,32 +0,0 @@ -/* - * jQuery 1.2.6 - New Wave Javascript - * - * Copyright (c) 2008 John Resig (jquery.com) - * Dual licensed under the MIT (MIT-LICENSE.txt) - * and GPL (GPL-LICENSE.txt) licenses. - * - * $Date: 2008-05-24 14:22:17 -0400 (Sat, 24 May 2008) $ - * $Rev: 5685 $ - */ -(function(){var _jQuery=window.jQuery,_$=window.$;var jQuery=window.jQuery=window.$=function(selector,context){return new jQuery.fn.init(selector,context);};var quickExpr=/^[^<]*(<(.|\s)+>)[^>]*$|^#(\w+)$/,isSimple=/^.[^:#\[\.]*$/,undefined;jQuery.fn=jQuery.prototype={init:function(selector,context){selector=selector||document;if(selector.nodeType){this[0]=selector;this.length=1;return this;}if(typeof selector=="string"){var match=quickExpr.exec(selector);if(match&&(match[1]||!context)){if(match[1])selector=jQuery.clean([match[1]],context);else{var elem=document.getElementById(match[3]);if(elem){if(elem.id!=match[3])return jQuery().find(selector);return jQuery(elem);}selector=[];}}else -return jQuery(context).find(selector);}else if(jQuery.isFunction(selector))return jQuery(document)[jQuery.fn.ready?"ready":"load"](selector);return this.setArray(jQuery.makeArray(selector));},jquery:"1.2.6",size:function(){return this.length;},length:0,get:function(num){return num==undefined?jQuery.makeArray(this):this[num];},pushStack:function(elems){var ret=jQuery(elems);ret.prevObject=this;return ret;},setArray:function(elems){this.length=0;Array.prototype.push.apply(this,elems);return this;},each:function(callback,args){return jQuery.each(this,callback,args);},index:function(elem){var ret=-1;return jQuery.inArray(elem&&elem.jquery?elem[0]:elem,this);},attr:function(name,value,type){var options=name;if(name.constructor==String)if(value===undefined)return this[0]&&jQuery[type||"attr"](this[0],name);else{options={};options[name]=value;}return this.each(function(i){for(name in options)jQuery.attr(type?this.style:this,name,jQuery.prop(this,options[name],type,i,name));});},css:function(key,value){if((key=='width'||key=='height')&&parseFloat(value)<0)value=undefined;return this.attr(key,value,"curCSS");},text:function(text){if(typeof text!="object"&&text!=null)return this.empty().append((this[0]&&this[0].ownerDocument||document).createTextNode(text));var ret="";jQuery.each(text||this,function(){jQuery.each(this.childNodes,function(){if(this.nodeType!=8)ret+=this.nodeType!=1?this.nodeValue:jQuery.fn.text([this]);});});return ret;},wrapAll:function(html){if(this[0])jQuery(html,this[0].ownerDocument).clone().insertBefore(this[0]).map(function(){var elem=this;while(elem.firstChild)elem=elem.firstChild;return elem;}).append(this);return this;},wrapInner:function(html){return this.each(function(){jQuery(this).contents().wrapAll(html);});},wrap:function(html){return this.each(function(){jQuery(this).wrapAll(html);});},append:function(){return this.domManip(arguments,true,false,function(elem){if(this.nodeType==1)this.appendChild(elem);});},prepend:function(){return this.domManip(arguments,true,true,function(elem){if(this.nodeType==1)this.insertBefore(elem,this.firstChild);});},before:function(){return this.domManip(arguments,false,false,function(elem){this.parentNode.insertBefore(elem,this);});},after:function(){return this.domManip(arguments,false,true,function(elem){this.parentNode.insertBefore(elem,this.nextSibling);});},end:function(){return this.prevObject||jQuery([]);},find:function(selector){var elems=jQuery.map(this,function(elem){return jQuery.find(selector,elem);});return this.pushStack(/[^+>] [^+>]/.test(selector)||selector.indexOf("..")>-1?jQuery.unique(elems):elems);},clone:function(events){var ret=this.map(function(){if(jQuery.browser.msie&&!jQuery.isXMLDoc(this)){var clone=this.cloneNode(true),container=document.createElement("div");container.appendChild(clone);return jQuery.clean([container.innerHTML])[0];}else -return this.cloneNode(true);});var clone=ret.find("*").andSelf().each(function(){if(this[expando]!=undefined)this[expando]=null;});if(events===true)this.find("*").andSelf().each(function(i){if(this.nodeType==3)return;var events=jQuery.data(this,"events");for(var type in events)for(var handler in events[type])jQuery.event.add(clone[i],type,events[type][handler],events[type][handler].data);});return ret;},filter:function(selector){return this.pushStack(jQuery.isFunction(selector)&&jQuery.grep(this,function(elem,i){return selector.call(elem,i);})||jQuery.multiFilter(selector,this));},not:function(selector){if(selector.constructor==String)if(isSimple.test(selector))return this.pushStack(jQuery.multiFilter(selector,this,true));else -selector=jQuery.multiFilter(selector,this);var isArrayLike=selector.length&&selector[selector.length-1]!==undefined&&!selector.nodeType;return this.filter(function(){return isArrayLike?jQuery.inArray(this,selector)<0:this!=selector;});},add:function(selector){return this.pushStack(jQuery.unique(jQuery.merge(this.get(),typeof selector=='string'?jQuery(selector):jQuery.makeArray(selector))));},is:function(selector){return!!selector&&jQuery.multiFilter(selector,this).length>0;},hasClass:function(selector){return this.is("."+selector);},val:function(value){if(value==undefined){if(this.length){var elem=this[0];if(jQuery.nodeName(elem,"select")){var index=elem.selectedIndex,values=[],options=elem.options,one=elem.type=="select-one";if(index<0)return null;for(var i=one?index:0,max=one?index+1:options.length;i=0||jQuery.inArray(this.name,value)>=0);else if(jQuery.nodeName(this,"select")){var values=jQuery.makeArray(value);jQuery("option",this).each(function(){this.selected=(jQuery.inArray(this.value,values)>=0||jQuery.inArray(this.text,values)>=0);});if(!values.length)this.selectedIndex=-1;}else -this.value=value;});},html:function(value){return value==undefined?(this[0]?this[0].innerHTML:null):this.empty().append(value);},replaceWith:function(value){return this.after(value).remove();},eq:function(i){return this.slice(i,i+1);},slice:function(){return this.pushStack(Array.prototype.slice.apply(this,arguments));},map:function(callback){return this.pushStack(jQuery.map(this,function(elem,i){return callback.call(elem,i,elem);}));},andSelf:function(){return this.add(this.prevObject);},data:function(key,value){var parts=key.split(".");parts[1]=parts[1]?"."+parts[1]:"";if(value===undefined){var data=this.triggerHandler("getData"+parts[1]+"!",[parts[0]]);if(data===undefined&&this.length)data=jQuery.data(this[0],key);return data===undefined&&parts[1]?this.data(parts[0]):data;}else -return this.trigger("setData"+parts[1]+"!",[parts[0],value]).each(function(){jQuery.data(this,key,value);});},removeData:function(key){return this.each(function(){jQuery.removeData(this,key);});},domManip:function(args,table,reverse,callback){var clone=this.length>1,elems;return this.each(function(){if(!elems){elems=jQuery.clean(args,this.ownerDocument);if(reverse)elems.reverse();}var obj=this;if(table&&jQuery.nodeName(this,"table")&&jQuery.nodeName(elems[0],"tr"))obj=this.getElementsByTagName("tbody")[0]||this.appendChild(this.ownerDocument.createElement("tbody"));var scripts=jQuery([]);jQuery.each(elems,function(){var elem=clone?jQuery(this).clone(true)[0]:this;if(jQuery.nodeName(elem,"script"))scripts=scripts.add(elem);else{if(elem.nodeType==1)scripts=scripts.add(jQuery("script",elem).remove());callback.call(obj,elem);}});scripts.each(evalScript);});}};jQuery.fn.init.prototype=jQuery.fn;function evalScript(i,elem){if(elem.src)jQuery.ajax({url:elem.src,async:false,dataType:"script"});else -jQuery.globalEval(elem.text||elem.textContent||elem.innerHTML||"");if(elem.parentNode)elem.parentNode.removeChild(elem);}function now(){return+new Date;}jQuery.extend=jQuery.fn.extend=function(){var target=arguments[0]||{},i=1,length=arguments.length,deep=false,options;if(target.constructor==Boolean){deep=target;target=arguments[1]||{};i=2;}if(typeof target!="object"&&typeof target!="function")target={};if(length==i){target=this;--i;}for(;i-1;}},swap:function(elem,options,callback){var old={};for(var name in options){old[name]=elem.style[name];elem.style[name]=options[name];}callback.call(elem);for(var name in options)elem.style[name]=old[name];},css:function(elem,name,force){if(name=="width"||name=="height"){var val,props={position:"absolute",visibility:"hidden",display:"block"},which=name=="width"?["Left","Right"]:["Top","Bottom"];function getWH(){val=name=="width"?elem.offsetWidth:elem.offsetHeight;var padding=0,border=0;jQuery.each(which,function(){padding+=parseFloat(jQuery.curCSS(elem,"padding"+this,true))||0;border+=parseFloat(jQuery.curCSS(elem,"border"+this+"Width",true))||0;});val-=Math.round(padding+border);}if(jQuery(elem).is(":visible"))getWH();else -jQuery.swap(elem,props,getWH);return Math.max(0,val);}return jQuery.curCSS(elem,name,force);},curCSS:function(elem,name,force){var ret,style=elem.style;function color(elem){if(!jQuery.browser.safari)return false;var ret=defaultView.getComputedStyle(elem,null);return!ret||ret.getPropertyValue("color")=="";}if(name=="opacity"&&jQuery.browser.msie){ret=jQuery.attr(style,"opacity");return ret==""?"1":ret;}if(jQuery.browser.opera&&name=="display"){var save=style.outline;style.outline="0 solid black";style.outline=save;}if(name.match(/float/i))name=styleFloat;if(!force&&style&&style[name])ret=style[name];else if(defaultView.getComputedStyle){if(name.match(/float/i))name="float";name=name.replace(/([A-Z])/g,"-$1").toLowerCase();var computedStyle=defaultView.getComputedStyle(elem,null);if(computedStyle&&!color(elem))ret=computedStyle.getPropertyValue(name);else{var swap=[],stack=[],a=elem,i=0;for(;a&&color(a);a=a.parentNode)stack.unshift(a);for(;i]*?)\/>/g,function(all,front,tag){return tag.match(/^(abbr|br|col|img|input|link|meta|param|hr|area|embed)$/i)?all:front+">";});var tags=jQuery.trim(elem).toLowerCase(),div=context.createElement("div");var wrap=!tags.indexOf("",""]||!tags.indexOf("",""]||tags.match(/^<(thead|tbody|tfoot|colg|cap)/)&&[1,"","
    "]||!tags.indexOf("",""]||(!tags.indexOf("",""]||!tags.indexOf("",""]||jQuery.browser.msie&&[1,"div
    ","
    "]||[0,"",""];div.innerHTML=wrap[1]+elem+wrap[2];while(wrap[0]--)div=div.lastChild;if(jQuery.browser.msie){var tbody=!tags.indexOf(""&&tags.indexOf("=0;--j)if(jQuery.nodeName(tbody[j],"tbody")&&!tbody[j].childNodes.length)tbody[j].parentNode.removeChild(tbody[j]);if(/^\s/.test(elem))div.insertBefore(context.createTextNode(elem.match(/^\s*/)[0]),div.firstChild);}elem=jQuery.makeArray(div.childNodes);}if(elem.length===0&&(!jQuery.nodeName(elem,"form")&&!jQuery.nodeName(elem,"select")))return;if(elem[0]==undefined||jQuery.nodeName(elem,"form")||elem.options)ret.push(elem);else -ret=jQuery.merge(ret,elem);});return ret;},attr:function(elem,name,value){if(!elem||elem.nodeType==3||elem.nodeType==8)return undefined;var notxml=!jQuery.isXMLDoc(elem),set=value!==undefined,msie=jQuery.browser.msie;name=notxml&&jQuery.props[name]||name;if(elem.tagName){var special=/href|src|style/.test(name);if(name=="selected"&&jQuery.browser.safari)elem.parentNode.selectedIndex;if(name in elem&¬xml&&!special){if(set){if(name=="type"&&jQuery.nodeName(elem,"input")&&elem.parentNode)throw"type property can't be changed";elem[name]=value;}if(jQuery.nodeName(elem,"form")&&elem.getAttributeNode(name))return elem.getAttributeNode(name).nodeValue;return elem[name];}if(msie&¬xml&&name=="style")return jQuery.attr(elem.style,"cssText",value);if(set)elem.setAttribute(name,""+value);var attr=msie&¬xml&&special?elem.getAttribute(name,2):elem.getAttribute(name);return attr===null?undefined:attr;}if(msie&&name=="opacity"){if(set){elem.zoom=1;elem.filter=(elem.filter||"").replace(/alpha\([^)]*\)/,"")+(parseInt(value)+''=="NaN"?"":"alpha(opacity="+value*100+")");}return elem.filter&&elem.filter.indexOf("opacity=")>=0?(parseFloat(elem.filter.match(/opacity=([^)]*)/)[1])/100)+'':"";}name=name.replace(/-([a-z])/ig,function(all,letter){return letter.toUpperCase();});if(set)elem[name]=value;return elem[name];},trim:function(text){return(text||"").replace(/^\s+|\s+$/g,"");},makeArray:function(array){var ret=[];if(array!=null){var i=array.length;if(i==null||array.split||array.setInterval||array.call)ret[0]=array;else -while(i)ret[--i]=array[i];}return ret;},inArray:function(elem,array){for(var i=0,length=array.length;i*",this).remove();while(this.firstChild)this.removeChild(this.firstChild);}},function(name,fn){jQuery.fn[name]=function(){return this.each(fn,arguments);};});jQuery.each(["Height","Width"],function(i,name){var type=name.toLowerCase();jQuery.fn[type]=function(size){return this[0]==window?jQuery.browser.opera&&document.body["client"+name]||jQuery.browser.safari&&window["inner"+name]||document.compatMode=="CSS1Compat"&&document.documentElement["client"+name]||document.body["client"+name]:this[0]==document?Math.max(Math.max(document.body["scroll"+name],document.documentElement["scroll"+name]),Math.max(document.body["offset"+name],document.documentElement["offset"+name])):size==undefined?(this.length?jQuery.css(this[0],type):null):this.css(type,size.constructor==String?size:size+"px");};});function num(elem,prop){return elem[0]&&parseInt(jQuery.curCSS(elem[0],prop,true),10)||0;}var chars=jQuery.browser.safari&&parseInt(jQuery.browser.version)<417?"(?:[\\w*_-]|\\\\.)":"(?:[\\w\u0128-\uFFFF*_-]|\\\\.)",quickChild=new RegExp("^>\\s*("+chars+"+)"),quickID=new RegExp("^("+chars+"+)(#)("+chars+"+)"),quickClass=new RegExp("^([#.]?)("+chars+"*)");jQuery.extend({expr:{"":function(a,i,m){return m[2]=="*"||jQuery.nodeName(a,m[2]);},"#":function(a,i,m){return a.getAttribute("id")==m[2];},":":{lt:function(a,i,m){return im[3]-0;},nth:function(a,i,m){return m[3]-0==i;},eq:function(a,i,m){return m[3]-0==i;},first:function(a,i){return i==0;},last:function(a,i,m,r){return i==r.length-1;},even:function(a,i){return i%2==0;},odd:function(a,i){return i%2;},"first-child":function(a){return a.parentNode.getElementsByTagName("*")[0]==a;},"last-child":function(a){return jQuery.nth(a.parentNode.lastChild,1,"previousSibling")==a;},"only-child":function(a){return!jQuery.nth(a.parentNode.lastChild,2,"previousSibling");},parent:function(a){return a.firstChild;},empty:function(a){return!a.firstChild;},contains:function(a,i,m){return(a.textContent||a.innerText||jQuery(a).text()||"").indexOf(m[3])>=0;},visible:function(a){return"hidden"!=a.type&&jQuery.css(a,"display")!="none"&&jQuery.css(a,"visibility")!="hidden";},hidden:function(a){return"hidden"==a.type||jQuery.css(a,"display")=="none"||jQuery.css(a,"visibility")=="hidden";},enabled:function(a){return!a.disabled;},disabled:function(a){return a.disabled;},checked:function(a){return a.checked;},selected:function(a){return a.selected||jQuery.attr(a,"selected");},text:function(a){return"text"==a.type;},radio:function(a){return"radio"==a.type;},checkbox:function(a){return"checkbox"==a.type;},file:function(a){return"file"==a.type;},password:function(a){return"password"==a.type;},submit:function(a){return"submit"==a.type;},image:function(a){return"image"==a.type;},reset:function(a){return"reset"==a.type;},button:function(a){return"button"==a.type||jQuery.nodeName(a,"button");},input:function(a){return/input|select|textarea|button/i.test(a.nodeName);},has:function(a,i,m){return jQuery.find(m[3],a).length;},header:function(a){return/h\d/i.test(a.nodeName);},animated:function(a){return jQuery.grep(jQuery.timers,function(fn){return a==fn.elem;}).length;}}},parse:[/^(\[) *@?([\w-]+) *([!*$^~=]*) *('?"?)(.*?)\4 *\]/,/^(:)([\w-]+)\("?'?(.*?(\(.*?\))?[^(]*?)"?'?\)/,new RegExp("^([:.#]*)("+chars+"+)")],multiFilter:function(expr,elems,not){var old,cur=[];while(expr&&expr!=old){old=expr;var f=jQuery.filter(expr,elems,not);expr=f.t.replace(/^\s*,\s*/,"");cur=not?elems=f.r:jQuery.merge(cur,f.r);}return cur;},find:function(t,context){if(typeof t!="string")return[t];if(context&&context.nodeType!=1&&context.nodeType!=9)return[];context=context||document;var ret=[context],done=[],last,nodeName;while(t&&last!=t){var r=[];last=t;t=jQuery.trim(t);var foundToken=false,re=quickChild,m=re.exec(t);if(m){nodeName=m[1].toUpperCase();for(var i=0;ret[i];i++)for(var c=ret[i].firstChild;c;c=c.nextSibling)if(c.nodeType==1&&(nodeName=="*"||c.nodeName.toUpperCase()==nodeName))r.push(c);ret=r;t=t.replace(re,"");if(t.indexOf(" ")==0)continue;foundToken=true;}else{re=/^([>+~])\s*(\w*)/i;if((m=re.exec(t))!=null){r=[];var merge={};nodeName=m[2].toUpperCase();m=m[1];for(var j=0,rl=ret.length;j=0;if(!not&&pass||not&&!pass)tmp.push(r[i]);}return tmp;},filter:function(t,r,not){var last;while(t&&t!=last){last=t;var p=jQuery.parse,m;for(var i=0;p[i];i++){m=p[i].exec(t);if(m){t=t.substring(m[0].length);m[2]=m[2].replace(/\\/g,"");break;}}if(!m)break;if(m[1]==":"&&m[2]=="not")r=isSimple.test(m[3])?jQuery.filter(m[3],r,true).r:jQuery(r).not(m[3]);else if(m[1]==".")r=jQuery.classFilter(r,m[2],not);else if(m[1]=="["){var tmp=[],type=m[3];for(var i=0,rl=r.length;i=0)^not)tmp.push(a);}r=tmp;}else if(m[1]==":"&&m[2]=="nth-child"){var merge={},tmp=[],test=/(-?)(\d*)n((?:\+|-)?\d*)/.exec(m[3]=="even"&&"2n"||m[3]=="odd"&&"2n+1"||!/\D/.test(m[3])&&"0n+"+m[3]||m[3]),first=(test[1]+(test[2]||1))-0,last=test[3]-0;for(var i=0,rl=r.length;i=0)add=true;if(add^not)tmp.push(node);}r=tmp;}else{var fn=jQuery.expr[m[1]];if(typeof fn=="object")fn=fn[m[2]];if(typeof fn=="string")fn=eval("false||function(a,i){return "+fn+";}");r=jQuery.grep(r,function(elem,i){return fn(elem,i,m,r);},not);}}return{r:r,t:t};},dir:function(elem,dir){var matched=[],cur=elem[dir];while(cur&&cur!=document){if(cur.nodeType==1)matched.push(cur);cur=cur[dir];}return matched;},nth:function(cur,result,dir,elem){result=result||1;var num=0;for(;cur;cur=cur[dir])if(cur.nodeType==1&&++num==result)break;return cur;},sibling:function(n,elem){var r=[];for(;n;n=n.nextSibling){if(n.nodeType==1&&n!=elem)r.push(n);}return r;}});jQuery.event={add:function(elem,types,handler,data){if(elem.nodeType==3||elem.nodeType==8)return;if(jQuery.browser.msie&&elem.setInterval)elem=window;if(!handler.guid)handler.guid=this.guid++;if(data!=undefined){var fn=handler;handler=this.proxy(fn,function(){return fn.apply(this,arguments);});handler.data=data;}var events=jQuery.data(elem,"events")||jQuery.data(elem,"events",{}),handle=jQuery.data(elem,"handle")||jQuery.data(elem,"handle",function(){if(typeof jQuery!="undefined"&&!jQuery.event.triggered)return jQuery.event.handle.apply(arguments.callee.elem,arguments);});handle.elem=elem;jQuery.each(types.split(/\s+/),function(index,type){var parts=type.split(".");type=parts[0];handler.type=parts[1];var handlers=events[type];if(!handlers){handlers=events[type]={};if(!jQuery.event.special[type]||jQuery.event.special[type].setup.call(elem)===false){if(elem.addEventListener)elem.addEventListener(type,handle,false);else if(elem.attachEvent)elem.attachEvent("on"+type,handle);}}handlers[handler.guid]=handler;jQuery.event.global[type]=true;});elem=null;},guid:1,global:{},remove:function(elem,types,handler){if(elem.nodeType==3||elem.nodeType==8)return;var events=jQuery.data(elem,"events"),ret,index;if(events){if(types==undefined||(typeof types=="string"&&types.charAt(0)=="."))for(var type in events)this.remove(elem,type+(types||""));else{if(types.type){handler=types.handler;types=types.type;}jQuery.each(types.split(/\s+/),function(index,type){var parts=type.split(".");type=parts[0];if(events[type]){if(handler)delete events[type][handler.guid];else -for(handler in events[type])if(!parts[1]||events[type][handler].type==parts[1])delete events[type][handler];for(ret in events[type])break;if(!ret){if(!jQuery.event.special[type]||jQuery.event.special[type].teardown.call(elem)===false){if(elem.removeEventListener)elem.removeEventListener(type,jQuery.data(elem,"handle"),false);else if(elem.detachEvent)elem.detachEvent("on"+type,jQuery.data(elem,"handle"));}ret=null;delete events[type];}}});}for(ret in events)break;if(!ret){var handle=jQuery.data(elem,"handle");if(handle)handle.elem=null;jQuery.removeData(elem,"events");jQuery.removeData(elem,"handle");}}},trigger:function(type,data,elem,donative,extra){data=jQuery.makeArray(data);if(type.indexOf("!")>=0){type=type.slice(0,-1);var exclusive=true;}if(!elem){if(this.global[type])jQuery("*").add([window,document]).trigger(type,data);}else{if(elem.nodeType==3||elem.nodeType==8)return undefined;var val,ret,fn=jQuery.isFunction(elem[type]||null),event=!data[0]||!data[0].preventDefault;if(event){data.unshift({type:type,target:elem,preventDefault:function(){},stopPropagation:function(){},timeStamp:now()});data[0][expando]=true;}data[0].type=type;if(exclusive)data[0].exclusive=true;var handle=jQuery.data(elem,"handle");if(handle)val=handle.apply(elem,data);if((!fn||(jQuery.nodeName(elem,'a')&&type=="click"))&&elem["on"+type]&&elem["on"+type].apply(elem,data)===false)val=false;if(event)data.shift();if(extra&&jQuery.isFunction(extra)){ret=extra.apply(elem,val==null?data:data.concat(val));if(ret!==undefined)val=ret;}if(fn&&donative!==false&&val!==false&&!(jQuery.nodeName(elem,'a')&&type=="click")){this.triggered=true;try{elem[type]();}catch(e){}}this.triggered=false;}return val;},handle:function(event){var val,ret,namespace,all,handlers;event=arguments[0]=jQuery.event.fix(event||window.event);namespace=event.type.split(".");event.type=namespace[0];namespace=namespace[1];all=!namespace&&!event.exclusive;handlers=(jQuery.data(this,"events")||{})[event.type];for(var j in handlers){var handler=handlers[j];if(all||handler.type==namespace){event.handler=handler;event.data=handler.data;ret=handler.apply(this,arguments);if(val!==false)val=ret;if(ret===false){event.preventDefault();event.stopPropagation();}}}return val;},fix:function(event){if(event[expando]==true)return event;var originalEvent=event;event={originalEvent:originalEvent};var props="altKey attrChange attrName bubbles button cancelable charCode clientX clientY ctrlKey currentTarget data detail eventPhase fromElement handler keyCode metaKey newValue originalTarget pageX pageY prevValue relatedNode relatedTarget screenX screenY shiftKey srcElement target timeStamp toElement type view wheelDelta which".split(" ");for(var i=props.length;i;i--)event[props[i]]=originalEvent[props[i]];event[expando]=true;event.preventDefault=function(){if(originalEvent.preventDefault)originalEvent.preventDefault();originalEvent.returnValue=false;};event.stopPropagation=function(){if(originalEvent.stopPropagation)originalEvent.stopPropagation();originalEvent.cancelBubble=true;};event.timeStamp=event.timeStamp||now();if(!event.target)event.target=event.srcElement||document;if(event.target.nodeType==3)event.target=event.target.parentNode;if(!event.relatedTarget&&event.fromElement)event.relatedTarget=event.fromElement==event.target?event.toElement:event.fromElement;if(event.pageX==null&&event.clientX!=null){var doc=document.documentElement,body=document.body;event.pageX=event.clientX+(doc&&doc.scrollLeft||body&&body.scrollLeft||0)-(doc.clientLeft||0);event.pageY=event.clientY+(doc&&doc.scrollTop||body&&body.scrollTop||0)-(doc.clientTop||0);}if(!event.which&&((event.charCode||event.charCode===0)?event.charCode:event.keyCode))event.which=event.charCode||event.keyCode;if(!event.metaKey&&event.ctrlKey)event.metaKey=event.ctrlKey;if(!event.which&&event.button)event.which=(event.button&1?1:(event.button&2?3:(event.button&4?2:0)));return event;},proxy:function(fn,proxy){proxy.guid=fn.guid=fn.guid||proxy.guid||this.guid++;return proxy;},special:{ready:{setup:function(){bindReady();return;},teardown:function(){return;}},mouseenter:{setup:function(){if(jQuery.browser.msie)return false;jQuery(this).bind("mouseover",jQuery.event.special.mouseenter.handler);return true;},teardown:function(){if(jQuery.browser.msie)return false;jQuery(this).unbind("mouseover",jQuery.event.special.mouseenter.handler);return true;},handler:function(event){if(withinElement(event,this))return true;event.type="mouseenter";return jQuery.event.handle.apply(this,arguments);}},mouseleave:{setup:function(){if(jQuery.browser.msie)return false;jQuery(this).bind("mouseout",jQuery.event.special.mouseleave.handler);return true;},teardown:function(){if(jQuery.browser.msie)return false;jQuery(this).unbind("mouseout",jQuery.event.special.mouseleave.handler);return true;},handler:function(event){if(withinElement(event,this))return true;event.type="mouseleave";return jQuery.event.handle.apply(this,arguments);}}}};jQuery.fn.extend({bind:function(type,data,fn){return type=="unload"?this.one(type,data,fn):this.each(function(){jQuery.event.add(this,type,fn||data,fn&&data);});},one:function(type,data,fn){var one=jQuery.event.proxy(fn||data,function(event){jQuery(this).unbind(event,one);return(fn||data).apply(this,arguments);});return this.each(function(){jQuery.event.add(this,type,one,fn&&data);});},unbind:function(type,fn){return this.each(function(){jQuery.event.remove(this,type,fn);});},trigger:function(type,data,fn){return this.each(function(){jQuery.event.trigger(type,data,this,true,fn);});},triggerHandler:function(type,data,fn){return this[0]&&jQuery.event.trigger(type,data,this[0],false,fn);},toggle:function(fn){var args=arguments,i=1;while(i=0){var selector=url.slice(off,url.length);url=url.slice(0,off);}callback=callback||function(){};var type="GET";if(params)if(jQuery.isFunction(params)){callback=params;params=null;}else{params=jQuery.param(params);type="POST";}var self=this;jQuery.ajax({url:url,type:type,dataType:"html",data:params,complete:function(res,status){if(status=="success"||status=="notmodified")self.html(selector?jQuery("
    ").append(res.responseText.replace(//g,"")).find(selector):res.responseText);self.each(callback,[res.responseText,status,res]);}});return this;},serialize:function(){return jQuery.param(this.serializeArray());},serializeArray:function(){return this.map(function(){return jQuery.nodeName(this,"form")?jQuery.makeArray(this.elements):this;}).filter(function(){return this.name&&!this.disabled&&(this.checked||/select|textarea/i.test(this.nodeName)||/text|hidden|password/i.test(this.type));}).map(function(i,elem){var val=jQuery(this).val();return val==null?null:val.constructor==Array?jQuery.map(val,function(val,i){return{name:elem.name,value:val};}):{name:elem.name,value:val};}).get();}});jQuery.each("ajaxStart,ajaxStop,ajaxComplete,ajaxError,ajaxSuccess,ajaxSend".split(","),function(i,o){jQuery.fn[o]=function(f){return this.bind(o,f);};});var jsc=now();jQuery.extend({get:function(url,data,callback,type){if(jQuery.isFunction(data)){callback=data;data=null;}return jQuery.ajax({type:"GET",url:url,data:data,success:callback,dataType:type});},getScript:function(url,callback){return jQuery.get(url,null,callback,"script");},getJSON:function(url,data,callback){return jQuery.get(url,data,callback,"json");},post:function(url,data,callback,type){if(jQuery.isFunction(data)){callback=data;data={};}return jQuery.ajax({type:"POST",url:url,data:data,success:callback,dataType:type});},ajaxSetup:function(settings){jQuery.extend(jQuery.ajaxSettings,settings);},ajaxSettings:{url:location.href,global:true,type:"GET",timeout:0,contentType:"application/x-www-form-urlencoded",processData:true,async:true,data:null,username:null,password:null,accepts:{xml:"application/xml, text/xml",html:"text/html",script:"text/javascript, application/javascript",json:"application/json, text/javascript",text:"text/plain",_default:"*/*"}},lastModified:{},ajax:function(s){s=jQuery.extend(true,s,jQuery.extend(true,{},jQuery.ajaxSettings,s));var jsonp,jsre=/=\?(&|$)/g,status,data,type=s.type.toUpperCase();if(s.data&&s.processData&&typeof s.data!="string")s.data=jQuery.param(s.data);if(s.dataType=="jsonp"){if(type=="GET"){if(!s.url.match(jsre))s.url+=(s.url.match(/\?/)?"&":"?")+(s.jsonp||"callback")+"=?";}else if(!s.data||!s.data.match(jsre))s.data=(s.data?s.data+"&":"")+(s.jsonp||"callback")+"=?";s.dataType="json";}if(s.dataType=="json"&&(s.data&&s.data.match(jsre)||s.url.match(jsre))){jsonp="jsonp"+jsc++;if(s.data)s.data=(s.data+"").replace(jsre,"="+jsonp+"$1");s.url=s.url.replace(jsre,"="+jsonp+"$1");s.dataType="script";window[jsonp]=function(tmp){data=tmp;success();complete();window[jsonp]=undefined;try{delete window[jsonp];}catch(e){}if(head)head.removeChild(script);};}if(s.dataType=="script"&&s.cache==null)s.cache=false;if(s.cache===false&&type=="GET"){var ts=now();var ret=s.url.replace(/(\?|&)_=.*?(&|$)/,"$1_="+ts+"$2");s.url=ret+((ret==s.url)?(s.url.match(/\?/)?"&":"?")+"_="+ts:"");}if(s.data&&type=="GET"){s.url+=(s.url.match(/\?/)?"&":"?")+s.data;s.data=null;}if(s.global&&!jQuery.active++)jQuery.event.trigger("ajaxStart");var remote=/^(?:\w+:)?\/\/([^\/?#]+)/;if(s.dataType=="script"&&type=="GET"&&remote.test(s.url)&&remote.exec(s.url)[1]!=location.host){var head=document.getElementsByTagName("head")[0];var script=document.createElement("script");script.src=s.url;if(s.scriptCharset)script.charset=s.scriptCharset;if(!jsonp){var done=false;script.onload=script.onreadystatechange=function(){if(!done&&(!this.readyState||this.readyState=="loaded"||this.readyState=="complete")){done=true;success();complete();head.removeChild(script);}};}head.appendChild(script);return undefined;}var requestDone=false;var xhr=window.ActiveXObject?new ActiveXObject("Microsoft.XMLHTTP"):new XMLHttpRequest();if(s.username)xhr.open(type,s.url,s.async,s.username,s.password);else -xhr.open(type,s.url,s.async);try{if(s.data)xhr.setRequestHeader("Content-Type",s.contentType);if(s.ifModified)xhr.setRequestHeader("If-Modified-Since",jQuery.lastModified[s.url]||"Thu, 01 Jan 1970 00:00:00 GMT");xhr.setRequestHeader("X-Requested-With","XMLHttpRequest");xhr.setRequestHeader("Accept",s.dataType&&s.accepts[s.dataType]?s.accepts[s.dataType]+", */*":s.accepts._default);}catch(e){}if(s.beforeSend&&s.beforeSend(xhr,s)===false){s.global&&jQuery.active--;xhr.abort();return false;}if(s.global)jQuery.event.trigger("ajaxSend",[xhr,s]);var onreadystatechange=function(isTimeout){if(!requestDone&&xhr&&(xhr.readyState==4||isTimeout=="timeout")){requestDone=true;if(ival){clearInterval(ival);ival=null;}status=isTimeout=="timeout"&&"timeout"||!jQuery.httpSuccess(xhr)&&"error"||s.ifModified&&jQuery.httpNotModified(xhr,s.url)&&"notmodified"||"success";if(status=="success"){try{data=jQuery.httpData(xhr,s.dataType,s.dataFilter);}catch(e){status="parsererror";}}if(status=="success"){var modRes;try{modRes=xhr.getResponseHeader("Last-Modified");}catch(e){}if(s.ifModified&&modRes)jQuery.lastModified[s.url]=modRes;if(!jsonp)success();}else -jQuery.handleError(s,xhr,status);complete();if(s.async)xhr=null;}};if(s.async){var ival=setInterval(onreadystatechange,13);if(s.timeout>0)setTimeout(function(){if(xhr){xhr.abort();if(!requestDone)onreadystatechange("timeout");}},s.timeout);}try{xhr.send(s.data);}catch(e){jQuery.handleError(s,xhr,null,e);}if(!s.async)onreadystatechange();function success(){if(s.success)s.success(data,status);if(s.global)jQuery.event.trigger("ajaxSuccess",[xhr,s]);}function complete(){if(s.complete)s.complete(xhr,status);if(s.global)jQuery.event.trigger("ajaxComplete",[xhr,s]);if(s.global&&!--jQuery.active)jQuery.event.trigger("ajaxStop");}return xhr;},handleError:function(s,xhr,status,e){if(s.error)s.error(xhr,status,e);if(s.global)jQuery.event.trigger("ajaxError",[xhr,s,e]);},active:0,httpSuccess:function(xhr){try{return!xhr.status&&location.protocol=="file:"||(xhr.status>=200&&xhr.status<300)||xhr.status==304||xhr.status==1223||jQuery.browser.safari&&xhr.status==undefined;}catch(e){}return false;},httpNotModified:function(xhr,url){try{var xhrRes=xhr.getResponseHeader("Last-Modified");return xhr.status==304||xhrRes==jQuery.lastModified[url]||jQuery.browser.safari&&xhr.status==undefined;}catch(e){}return false;},httpData:function(xhr,type,filter){var ct=xhr.getResponseHeader("content-type"),xml=type=="xml"||!type&&ct&&ct.indexOf("xml")>=0,data=xml?xhr.responseXML:xhr.responseText;if(xml&&data.documentElement.tagName=="parsererror")throw"parsererror";if(filter)data=filter(data,type);if(type=="script")jQuery.globalEval(data);if(type=="json")data=eval("("+data+")");return data;},param:function(a){var s=[];if(a.constructor==Array||a.jquery)jQuery.each(a,function(){s.push(encodeURIComponent(this.name)+"="+encodeURIComponent(this.value));});else -for(var j in a)if(a[j]&&a[j].constructor==Array)jQuery.each(a[j],function(){s.push(encodeURIComponent(j)+"="+encodeURIComponent(this));});else -s.push(encodeURIComponent(j)+"="+encodeURIComponent(jQuery.isFunction(a[j])?a[j]():a[j]));return s.join("&").replace(/%20/g,"+");}});jQuery.fn.extend({show:function(speed,callback){return speed?this.animate({height:"show",width:"show",opacity:"show"},speed,callback):this.filter(":hidden").each(function(){this.style.display=this.oldblock||"";if(jQuery.css(this,"display")=="none"){var elem=jQuery("<"+this.tagName+" />").appendTo("body");this.style.display=elem.css("display");if(this.style.display=="none")this.style.display="block";elem.remove();}}).end();},hide:function(speed,callback){return speed?this.animate({height:"hide",width:"hide",opacity:"hide"},speed,callback):this.filter(":visible").each(function(){this.oldblock=this.oldblock||jQuery.css(this,"display");this.style.display="none";}).end();},_toggle:jQuery.fn.toggle,toggle:function(fn,fn2){return jQuery.isFunction(fn)&&jQuery.isFunction(fn2)?this._toggle.apply(this,arguments):fn?this.animate({height:"toggle",width:"toggle",opacity:"toggle"},fn,fn2):this.each(function(){jQuery(this)[jQuery(this).is(":hidden")?"show":"hide"]();});},slideDown:function(speed,callback){return this.animate({height:"show"},speed,callback);},slideUp:function(speed,callback){return this.animate({height:"hide"},speed,callback);},slideToggle:function(speed,callback){return this.animate({height:"toggle"},speed,callback);},fadeIn:function(speed,callback){return this.animate({opacity:"show"},speed,callback);},fadeOut:function(speed,callback){return this.animate({opacity:"hide"},speed,callback);},fadeTo:function(speed,to,callback){return this.animate({opacity:to},speed,callback);},animate:function(prop,speed,easing,callback){var optall=jQuery.speed(speed,easing,callback);return this[optall.queue===false?"each":"queue"](function(){if(this.nodeType!=1)return false;var opt=jQuery.extend({},optall),p,hidden=jQuery(this).is(":hidden"),self=this;for(p in prop){if(prop[p]=="hide"&&hidden||prop[p]=="show"&&!hidden)return opt.complete.call(this);if(p=="height"||p=="width"){opt.display=jQuery.css(this,"display");opt.overflow=this.style.overflow;}}if(opt.overflow!=null)this.style.overflow="hidden";opt.curAnim=jQuery.extend({},prop);jQuery.each(prop,function(name,val){var e=new jQuery.fx(self,opt,name);if(/toggle|show|hide/.test(val))e[val=="toggle"?hidden?"show":"hide":val](prop);else{var parts=val.toString().match(/^([+-]=)?([\d+-.]+)(.*)$/),start=e.cur(true)||0;if(parts){var end=parseFloat(parts[2]),unit=parts[3]||"px";if(unit!="px"){self.style[name]=(end||1)+unit;start=((end||1)/e.cur(true))*start;self.style[name]=start+unit;}if(parts[1])end=((parts[1]=="-="?-1:1)*end)+start;e.custom(start,end,unit);}else -e.custom(start,val,"");}});return true;});},queue:function(type,fn){if(jQuery.isFunction(type)||(type&&type.constructor==Array)){fn=type;type="fx";}if(!type||(typeof type=="string"&&!fn))return queue(this[0],type);return this.each(function(){if(fn.constructor==Array)queue(this,type,fn);else{queue(this,type).push(fn);if(queue(this,type).length==1)fn.call(this);}});},stop:function(clearQueue,gotoEnd){var timers=jQuery.timers;if(clearQueue)this.queue([]);this.each(function(){for(var i=timers.length-1;i>=0;i--)if(timers[i].elem==this){if(gotoEnd)timers[i](true);timers.splice(i,1);}});if(!gotoEnd)this.dequeue();return this;}});var queue=function(elem,type,array){if(elem){type=type||"fx";var q=jQuery.data(elem,type+"queue");if(!q||array)q=jQuery.data(elem,type+"queue",jQuery.makeArray(array));}return q;};jQuery.fn.dequeue=function(type){type=type||"fx";return this.each(function(){var q=queue(this,type);q.shift();if(q.length)q[0].call(this);});};jQuery.extend({speed:function(speed,easing,fn){var opt=speed&&speed.constructor==Object?speed:{complete:fn||!fn&&easing||jQuery.isFunction(speed)&&speed,duration:speed,easing:fn&&easing||easing&&easing.constructor!=Function&&easing};opt.duration=(opt.duration&&opt.duration.constructor==Number?opt.duration:jQuery.fx.speeds[opt.duration])||jQuery.fx.speeds.def;opt.old=opt.complete;opt.complete=function(){if(opt.queue!==false)jQuery(this).dequeue();if(jQuery.isFunction(opt.old))opt.old.call(this);};return opt;},easing:{linear:function(p,n,firstNum,diff){return firstNum+diff*p;},swing:function(p,n,firstNum,diff){return((-Math.cos(p*Math.PI)/2)+0.5)*diff+firstNum;}},timers:[],timerId:null,fx:function(elem,options,prop){this.options=options;this.elem=elem;this.prop=prop;if(!options.orig)options.orig={};}});jQuery.fx.prototype={update:function(){if(this.options.step)this.options.step.call(this.elem,this.now,this);(jQuery.fx.step[this.prop]||jQuery.fx.step._default)(this);if(this.prop=="height"||this.prop=="width")this.elem.style.display="block";},cur:function(force){if(this.elem[this.prop]!=null&&this.elem.style[this.prop]==null)return this.elem[this.prop];var r=parseFloat(jQuery.css(this.elem,this.prop,force));return r&&r>-10000?r:parseFloat(jQuery.curCSS(this.elem,this.prop))||0;},custom:function(from,to,unit){this.startTime=now();this.start=from;this.end=to;this.unit=unit||this.unit||"px";this.now=this.start;this.pos=this.state=0;this.update();var self=this;function t(gotoEnd){return self.step(gotoEnd);}t.elem=this.elem;jQuery.timers.push(t);if(jQuery.timerId==null){jQuery.timerId=setInterval(function(){var timers=jQuery.timers;for(var i=0;ithis.options.duration+this.startTime){this.now=this.end;this.pos=this.state=1;this.update();this.options.curAnim[this.prop]=true;var done=true;for(var i in this.options.curAnim)if(this.options.curAnim[i]!==true)done=false;if(done){if(this.options.display!=null){this.elem.style.overflow=this.options.overflow;this.elem.style.display=this.options.display;if(jQuery.css(this.elem,"display")=="none")this.elem.style.display="block";}if(this.options.hide)this.elem.style.display="none";if(this.options.hide||this.options.show)for(var p in this.options.curAnim)jQuery.attr(this.elem.style,p,this.options.orig[p]);}if(done)this.options.complete.call(this.elem);return false;}else{var n=t-this.startTime;this.state=n/this.options.duration;this.pos=jQuery.easing[this.options.easing||(jQuery.easing.swing?"swing":"linear")](this.state,n,0,1,this.options.duration);this.now=this.start+((this.end-this.start)*this.pos);this.update();}return true;}};jQuery.extend(jQuery.fx,{speeds:{slow:600,fast:200,def:400},step:{scrollLeft:function(fx){fx.elem.scrollLeft=fx.now;},scrollTop:function(fx){fx.elem.scrollTop=fx.now;},opacity:function(fx){jQuery.attr(fx.elem.style,"opacity",fx.now);},_default:function(fx){fx.elem.style[fx.prop]=fx.now+fx.unit;}}});jQuery.fn.offset=function(){var left=0,top=0,elem=this[0],results;if(elem)with(jQuery.browser){var parent=elem.parentNode,offsetChild=elem,offsetParent=elem.offsetParent,doc=elem.ownerDocument,safari2=safari&&parseInt(version)<522&&!/adobeair/i.test(userAgent),css=jQuery.curCSS,fixed=css(elem,"position")=="fixed";if(elem.getBoundingClientRect){var box=elem.getBoundingClientRect();add(box.left+Math.max(doc.documentElement.scrollLeft,doc.body.scrollLeft),box.top+Math.max(doc.documentElement.scrollTop,doc.body.scrollTop));add(-doc.documentElement.clientLeft,-doc.documentElement.clientTop);}else{add(elem.offsetLeft,elem.offsetTop);while(offsetParent){add(offsetParent.offsetLeft,offsetParent.offsetTop);if(mozilla&&!/^t(able|d|h)$/i.test(offsetParent.tagName)||safari&&!safari2)border(offsetParent);if(!fixed&&css(offsetParent,"position")=="fixed")fixed=true;offsetChild=/^body$/i.test(offsetParent.tagName)?offsetChild:offsetParent;offsetParent=offsetParent.offsetParent;}while(parent&&parent.tagName&&!/^body|html$/i.test(parent.tagName)){if(!/^inline|table.*$/i.test(css(parent,"display")))add(-parent.scrollLeft,-parent.scrollTop);if(mozilla&&css(parent,"overflow")!="visible")border(parent);parent=parent.parentNode;}if((safari2&&(fixed||css(offsetChild,"position")=="absolute"))||(mozilla&&css(offsetChild,"position")!="absolute"))add(-doc.body.offsetLeft,-doc.body.offsetTop);if(fixed)add(Math.max(doc.documentElement.scrollLeft,doc.body.scrollLeft),Math.max(doc.documentElement.scrollTop,doc.body.scrollTop));}results={top:top,left:left};}function border(elem){add(jQuery.curCSS(elem,"borderLeftWidth",true),jQuery.curCSS(elem,"borderTopWidth",true));}function add(l,t){left+=parseInt(l,10)||0;top+=parseInt(t,10)||0;}return results;};jQuery.fn.extend({position:function(){var left=0,top=0,results;if(this[0]){var offsetParent=this.offsetParent(),offset=this.offset(),parentOffset=/^body|html$/i.test(offsetParent[0].tagName)?{top:0,left:0}:offsetParent.offset();offset.top-=num(this,'marginTop');offset.left-=num(this,'marginLeft');parentOffset.top+=num(offsetParent,'borderTopWidth');parentOffset.left+=num(offsetParent,'borderLeftWidth');results={top:offset.top-parentOffset.top,left:offset.left-parentOffset.left};}return results;},offsetParent:function(){var offsetParent=this[0].offsetParent;while(offsetParent&&(!/^body|html$/i.test(offsetParent.tagName)&&jQuery.css(offsetParent,'position')=='static'))offsetParent=offsetParent.offsetParent;return jQuery(offsetParent);}});jQuery.each(['Left','Top'],function(i,name){var method='scroll'+name;jQuery.fn[method]=function(val){if(!this[0])return;return val!=undefined?this.each(function(){this==window||this==document?window.scrollTo(!i?val:jQuery(window).scrollLeft(),i?val:jQuery(window).scrollTop()):this[method]=val;}):this[0]==window||this[0]==document?self[i?'pageYOffset':'pageXOffset']||jQuery.boxModel&&document.documentElement[method]||document.body[method]:this[0][method];};});jQuery.each(["Height","Width"],function(i,name){var tl=i?"Left":"Top",br=i?"Right":"Bottom";jQuery.fn["inner"+name]=function(){return this[name.toLowerCase()]()+num(this,"padding"+tl)+num(this,"padding"+br);};jQuery.fn["outer"+name]=function(margin){return this["inner"+name]()+num(this,"border"+tl+"Width")+num(this,"border"+br+"Width")+(margin?num(this,"margin"+tl)+num(this,"margin"+br):0);};});})(); \ No newline at end of file diff --git a/docs/_build/html/_static/pygments.css b/docs/_build/html/_static/pygments.css deleted file mode 100644 index 1f2d2b618..000000000 --- a/docs/_build/html/_static/pygments.css +++ /dev/null @@ -1,61 +0,0 @@ -.hll { background-color: #ffffcc } -.c { color: #408090; font-style: italic } /* Comment */ -.err { border: 1px solid #FF0000 } /* Error */ -.k { color: #007020; font-weight: bold } /* Keyword */ -.o { color: #666666 } /* Operator */ -.cm { color: #408090; font-style: italic } /* Comment.Multiline */ -.cp { color: #007020 } /* Comment.Preproc */ -.c1 { color: #408090; font-style: italic } /* Comment.Single */ -.cs { color: #408090; background-color: #fff0f0 } /* Comment.Special */ -.gd { color: #A00000 } /* Generic.Deleted */ -.ge { font-style: italic } /* Generic.Emph */ -.gr { color: #FF0000 } /* Generic.Error */ -.gh { color: #000080; font-weight: bold } /* Generic.Heading */ -.gi { color: #00A000 } /* Generic.Inserted */ -.go { color: #303030 } /* Generic.Output */ -.gp { color: #c65d09; font-weight: bold } /* Generic.Prompt */ -.gs { font-weight: bold } /* Generic.Strong */ -.gu { color: #800080; font-weight: bold } /* Generic.Subheading */ -.gt { color: #0040D0 } /* Generic.Traceback */ -.kc { color: #007020; font-weight: bold } /* Keyword.Constant */ -.kd { color: #007020; font-weight: bold } /* Keyword.Declaration */ -.kn { color: #007020; font-weight: bold } /* Keyword.Namespace */ -.kp { color: #007020 } /* Keyword.Pseudo */ -.kr { color: #007020; font-weight: bold } /* Keyword.Reserved */ -.kt { color: #902000 } /* Keyword.Type */ -.m { color: #208050 } /* Literal.Number */ -.s { color: #4070a0 } /* Literal.String */ -.na { color: #4070a0 } /* Name.Attribute */ -.nb { color: #007020 } /* Name.Builtin */ -.nc { color: #0e84b5; font-weight: bold } /* Name.Class */ -.no { color: #60add5 } /* Name.Constant */ -.nd { color: #555555; font-weight: bold } /* Name.Decorator */ -.ni { color: #d55537; font-weight: bold } /* Name.Entity */ -.ne { color: #007020 } /* Name.Exception */ -.nf { color: #06287e } /* Name.Function */ -.nl { color: #002070; font-weight: bold } /* Name.Label */ -.nn { color: #0e84b5; font-weight: bold } /* Name.Namespace */ -.nt { color: #062873; font-weight: bold } /* Name.Tag */ -.nv { color: #bb60d5 } /* Name.Variable */ -.ow { color: #007020; font-weight: bold } /* Operator.Word */ -.w { color: #bbbbbb } /* Text.Whitespace */ -.mf { color: #208050 } /* Literal.Number.Float */ -.mh { color: #208050 } /* Literal.Number.Hex */ -.mi { color: #208050 } /* Literal.Number.Integer */ -.mo { color: #208050 } /* Literal.Number.Oct */ -.sb { color: #4070a0 } /* Literal.String.Backtick */ -.sc { color: #4070a0 } /* Literal.String.Char */ -.sd { color: #4070a0; font-style: italic } /* Literal.String.Doc */ -.s2 { color: #4070a0 } /* Literal.String.Double */ -.se { color: #4070a0; font-weight: bold } /* Literal.String.Escape */ -.sh { color: #4070a0 } /* Literal.String.Heredoc */ -.si { color: #70a0d0; font-style: italic } /* Literal.String.Interpol */ -.sx { color: #c65d09 } /* Literal.String.Other */ -.sr { color: #235388 } /* Literal.String.Regex */ -.s1 { color: #4070a0 } /* Literal.String.Single */ -.ss { color: #517918 } /* Literal.String.Symbol */ -.bp { color: #007020 } /* Name.Builtin.Pseudo */ -.vc { color: #bb60d5 } /* Name.Variable.Class */ -.vg { color: #bb60d5 } /* Name.Variable.Global */ -.vi { color: #bb60d5 } /* Name.Variable.Instance */ -.il { color: #208050 } /* Literal.Number.Integer.Long */ \ No newline at end of file diff --git a/docs/_build/html/_static/searchtools.js b/docs/_build/html/_static/searchtools.js deleted file mode 100644 index f679a7544..000000000 --- a/docs/_build/html/_static/searchtools.js +++ /dev/null @@ -1,471 +0,0 @@ -/** - * helper function to return a node containing the - * search summary for a given text. keywords is a list - * of stemmed words, hlwords is the list of normal, unstemmed - * words. the first one is used to find the occurance, the - * latter for highlighting it. - */ - -jQuery.makeSearchSummary = function(text, keywords, hlwords) { - var textLower = text.toLowerCase(); - var start = 0; - $.each(keywords, function() { - var i = textLower.indexOf(this.toLowerCase()); - if (i > -1) - start = i; - }); - start = Math.max(start - 120, 0); - var excerpt = ((start > 0) ? '...' : '') + - $.trim(text.substr(start, 240)) + - ((start + 240 - text.length) ? '...' : ''); - var rv = $('
    ').text(excerpt); - $.each(hlwords, function() { - rv = rv.highlightText(this, 'highlight'); - }); - return rv; -} - -/** - * Porter Stemmer - */ -var PorterStemmer = function() { - - var step2list = { - ational: 'ate', - tional: 'tion', - enci: 'ence', - anci: 'ance', - izer: 'ize', - bli: 'ble', - alli: 'al', - entli: 'ent', - eli: 'e', - ousli: 'ous', - ization: 'ize', - ation: 'ate', - ator: 'ate', - alism: 'al', - iveness: 'ive', - fulness: 'ful', - ousness: 'ous', - aliti: 'al', - iviti: 'ive', - biliti: 'ble', - logi: 'log' - }; - - var step3list = { - icate: 'ic', - ative: '', - alize: 'al', - iciti: 'ic', - ical: 'ic', - ful: '', - ness: '' - }; - - var c = "[^aeiou]"; // consonant - var v = "[aeiouy]"; // vowel - var C = c + "[^aeiouy]*"; // consonant sequence - var V = v + "[aeiou]*"; // vowel sequence - - var mgr0 = "^(" + C + ")?" + V + C; // [C]VC... is m>0 - var meq1 = "^(" + C + ")?" + V + C + "(" + V + ")?$"; // [C]VC[V] is m=1 - var mgr1 = "^(" + C + ")?" + V + C + V + C; // [C]VCVC... is m>1 - var s_v = "^(" + C + ")?" + v; // vowel in stem - - this.stemWord = function (w) { - var stem; - var suffix; - var firstch; - var origword = w; - - if (w.length < 3) - return w; - - var re; - var re2; - var re3; - var re4; - - firstch = w.substr(0,1); - if (firstch == "y") - w = firstch.toUpperCase() + w.substr(1); - - // Step 1a - re = /^(.+?)(ss|i)es$/; - re2 = /^(.+?)([^s])s$/; - - if (re.test(w)) - w = w.replace(re,"$1$2"); - else if (re2.test(w)) - w = w.replace(re2,"$1$2"); - - // Step 1b - re = /^(.+?)eed$/; - re2 = /^(.+?)(ed|ing)$/; - if (re.test(w)) { - var fp = re.exec(w); - re = new RegExp(mgr0); - if (re.test(fp[1])) { - re = /.$/; - w = w.replace(re,""); - } - } - else if (re2.test(w)) { - var fp = re2.exec(w); - stem = fp[1]; - re2 = new RegExp(s_v); - if (re2.test(stem)) { - w = stem; - re2 = /(at|bl|iz)$/; - re3 = new RegExp("([^aeiouylsz])\\1$"); - re4 = new RegExp("^" + C + v + "[^aeiouwxy]$"); - if (re2.test(w)) - w = w + "e"; - else if (re3.test(w)) { - re = /.$/; - w = w.replace(re,""); - } - else if (re4.test(w)) - w = w + "e"; - } - } - - // Step 1c - re = /^(.+?)y$/; - if (re.test(w)) { - var fp = re.exec(w); - stem = fp[1]; - re = new RegExp(s_v); - if (re.test(stem)) - w = stem + "i"; - } - - // Step 2 - re = /^(.+?)(ational|tional|enci|anci|izer|bli|alli|entli|eli|ousli|ization|ation|ator|alism|iveness|fulness|ousness|aliti|iviti|biliti|logi)$/; - if (re.test(w)) { - var fp = re.exec(w); - stem = fp[1]; - suffix = fp[2]; - re = new RegExp(mgr0); - if (re.test(stem)) - w = stem + step2list[suffix]; - } - - // Step 3 - re = /^(.+?)(icate|ative|alize|iciti|ical|ful|ness)$/; - if (re.test(w)) { - var fp = re.exec(w); - stem = fp[1]; - suffix = fp[2]; - re = new RegExp(mgr0); - if (re.test(stem)) - w = stem + step3list[suffix]; - } - - // Step 4 - re = /^(.+?)(al|ance|ence|er|ic|able|ible|ant|ement|ment|ent|ou|ism|ate|iti|ous|ive|ize)$/; - re2 = /^(.+?)(s|t)(ion)$/; - if (re.test(w)) { - var fp = re.exec(w); - stem = fp[1]; - re = new RegExp(mgr1); - if (re.test(stem)) - w = stem; - } - else if (re2.test(w)) { - var fp = re2.exec(w); - stem = fp[1] + fp[2]; - re2 = new RegExp(mgr1); - if (re2.test(stem)) - w = stem; - } - - // Step 5 - re = /^(.+?)e$/; - if (re.test(w)) { - var fp = re.exec(w); - stem = fp[1]; - re = new RegExp(mgr1); - re2 = new RegExp(meq1); - re3 = new RegExp("^" + C + v + "[^aeiouwxy]$"); - if (re.test(stem) || (re2.test(stem) && !(re3.test(stem)))) - w = stem; - } - re = /ll$/; - re2 = new RegExp(mgr1); - if (re.test(w) && re2.test(w)) { - re = /.$/; - w = w.replace(re,""); - } - - // and turn initial Y back to y - if (firstch == "y") - w = firstch.toLowerCase() + w.substr(1); - return w; - } -} - - -/** - * Search Module - */ -var Search = { - - _index : null, - _queued_query : null, - _pulse_status : -1, - - init : function() { - var params = $.getQueryParameters(); - if (params.q) { - var query = params.q[0]; - $('input[name="q"]')[0].value = query; - this.performSearch(query); - } - }, - - /** - * Sets the index - */ - setIndex : function(index) { - var q; - this._index = index; - if ((q = this._queued_query) !== null) { - this._queued_query = null; - Search.query(q); - } - }, - - hasIndex : function() { - return this._index !== null; - }, - - deferQuery : function(query) { - this._queued_query = query; - }, - - stopPulse : function() { - this._pulse_status = 0; - }, - - startPulse : function() { - if (this._pulse_status >= 0) - return; - function pulse() { - Search._pulse_status = (Search._pulse_status + 1) % 4; - var dotString = ''; - for (var i = 0; i < Search._pulse_status; i++) - dotString += '.'; - Search.dots.text(dotString); - if (Search._pulse_status > -1) - window.setTimeout(pulse, 500); - }; - pulse(); - }, - - /** - * perform a search for something - */ - performSearch : function(query) { - // create the required interface elements - this.out = $('#search-results'); - this.title = $('

    ' + _('Searching') + '

    ').appendTo(this.out); - this.dots = $('').appendTo(this.title); - this.status = $('

    ').appendTo(this.out); - this.output = $('
      ').appendTo(this.out); - - $('#search-progress').text(_('Preparing search...')); - this.startPulse(); - - // index already loaded, the browser was quick! - if (this.hasIndex()) - this.query(query); - else - this.deferQuery(query); - }, - - query : function(query) { - // stem the searchterms and add them to the - // correct list - var stemmer = new PorterStemmer(); - var searchterms = []; - var excluded = []; - var hlterms = []; - var tmp = query.split(/\s+/); - var object = (tmp.length == 1) ? tmp[0].toLowerCase() : null; - for (var i = 0; i < tmp.length; i++) { - // ignore leading/trailing whitespace - if (tmp[i] == "") - continue; - // stem the word - var word = stemmer.stemWord(tmp[i]).toLowerCase(); - // select the correct list - if (word[0] == '-') { - var toAppend = excluded; - word = word.substr(1); - } - else { - var toAppend = searchterms; - hlterms.push(tmp[i].toLowerCase()); - } - // only add if not already in the list - if (!$.contains(toAppend, word)) - toAppend.push(word); - }; - var highlightstring = '?highlight=' + $.urlencode(hlterms.join(" ")); - - console.debug('SEARCH: searching for:'); - console.info('required: ', searchterms); - console.info('excluded: ', excluded); - - // prepare search - var filenames = this._index.filenames; - var titles = this._index.titles; - var terms = this._index.terms; - var descrefs = this._index.descrefs; - var modules = this._index.modules; - var desctypes = this._index.desctypes; - var fileMap = {}; - var files = null; - var objectResults = []; - var regularResults = []; - $('#search-progress').empty(); - - // lookup as object - if (object != null) { - for (var module in modules) { - if (module.indexOf(object) > -1) { - fn = modules[module]; - descr = _('module, in ') + titles[fn]; - objectResults.push([filenames[fn], module, '#module-'+module, descr]); - } - } - for (var prefix in descrefs) { - for (var name in descrefs[prefix]) { - var fullname = (prefix ? prefix + '.' : '') + name; - if (fullname.toLowerCase().indexOf(object) > -1) { - match = descrefs[prefix][name]; - descr = desctypes[match[1]] + _(', in ') + titles[match[0]]; - objectResults.push([filenames[match[0]], fullname, '#'+fullname, descr]); - } - } - } - } - - // sort results descending - objectResults.sort(function(a, b) { - return (a[1] > b[1]) ? -1 : ((a[1] < b[1]) ? 1 : 0); - }); - - - // perform the search on the required terms - for (var i = 0; i < searchterms.length; i++) { - var word = searchterms[i]; - // no match but word was a required one - if ((files = terms[word]) == null) - break; - if (files.length == undefined) { - files = [files]; - } - // create the mapping - for (var j = 0; j < files.length; j++) { - var file = files[j]; - if (file in fileMap) - fileMap[file].push(word); - else - fileMap[file] = [word]; - } - } - - // now check if the files don't contain excluded terms - for (var file in fileMap) { - var valid = true; - - // check if all requirements are matched - if (fileMap[file].length != searchterms.length) - continue; - - // ensure that none of the excluded terms is in the - // search result. - for (var i = 0; i < excluded.length; i++) { - if (terms[excluded[i]] == file || - $.contains(terms[excluded[i]] || [], file)) { - valid = false; - break; - } - } - - // if we have still a valid result we can add it - // to the result list - if (valid) - regularResults.push([filenames[file], titles[file], '', null]); - } - - // delete unused variables in order to not waste - // memory until list is retrieved completely - delete filenames, titles, terms; - - // now sort the regular results descending by title - regularResults.sort(function(a, b) { - var left = a[1].toLowerCase(); - var right = b[1].toLowerCase(); - return (left > right) ? -1 : ((left < right) ? 1 : 0); - }); - - // combine both - var results = regularResults.concat(objectResults); - - // print the results - var resultCount = results.length; - function displayNextItem() { - // results left, load the summary and display it - if (results.length) { - var item = results.pop(); - var listItem = $('
    • '); - listItem.append($('').attr( - 'href', - item[0] + DOCUMENTATION_OPTIONS.FILE_SUFFIX + - highlightstring + item[2]).html(item[1])); - if (item[3]) { - listItem.append($(' (' + item[3] + ')')); - Search.output.append(listItem); - listItem.slideDown(5, function() { - displayNextItem(); - }); - } else if (DOCUMENTATION_OPTIONS.HAS_SOURCE) { - $.get(DOCUMENTATION_OPTIONS.URL_ROOT + '_sources/' + - item[0] + '.txt', function(data) { - listItem.append($.makeSearchSummary(data, searchterms, hlterms)); - Search.output.append(listItem); - listItem.slideDown(5, function() { - displayNextItem(); - }); - }); - } else { - // no source available, just display title - Search.output.append(listItem); - listItem.slideDown(5, function() { - displayNextItem(); - }); - } - } - // search finished, update title and status message - else { - Search.stopPulse(); - Search.title.text(_('Search Results')); - if (!resultCount) - Search.status.text(_('Your search did not match any documents. Please make sure that all words are spelled correctly and that you\'ve selected enough categories.')); - else - Search.status.text(_('Search finished, found %s page(s) matching the search query.').replace('%s', resultCount)); - Search.status.fadeIn(500); - } - } - displayNextItem(); - } -} - -$(document).ready(function() { - Search.init(); -}); diff --git a/docs/_build/html/genindex.html b/docs/_build/html/genindex.html deleted file mode 100644 index 9c6874013..000000000 --- a/docs/_build/html/genindex.html +++ /dev/null @@ -1,89 +0,0 @@ - - - - - - - Index — pysmurf v1 documentation - - - - - - - - -
      -

      Navigation

      -       -
      - -
      -
      -
      -
      - - -

      Index

      - - - -
      - - - - -
      -
      -
      -
      -
      - - - - - -
      -
      -
      -
      -
      -

      Navigation

      - -
      -
      - © Copyright 2019, Edward Young. - Created using Sphinx 0.6.6. -
      - - \ No newline at end of file diff --git a/docs/_build/html/index.html b/docs/_build/html/index.html deleted file mode 100644 index 3cbc0042f..000000000 --- a/docs/_build/html/index.html +++ /dev/null @@ -1,105 +0,0 @@ - - - - - - - Welcome to pysmurf’s documentation! — pysmurf v1 documentation - - - - - - - - -
      -

      Navigation

      - -
      - -
      -
      -
      -
      - -
      -

      Welcome to pysmurf’s documentation!¶

      -

      Contents:

      -
        -
      -
      -
      -

      Indices and tables¶

      - -
      - - -
      -
      -
      -
      -
      -

      Table Of Contents

      - - -

      This Page

      - - - -
      -
      -
      -
      -
      -

      Navigation

      - -
      -
      - © Copyright 2019, Edward Young. - Created using Sphinx 0.6.6. -
      - - \ No newline at end of file diff --git a/docs/_build/html/objects.inv b/docs/_build/html/objects.inv deleted file mode 100644 index 89bf9a543..000000000 --- a/docs/_build/html/objects.inv +++ /dev/null @@ -1,3 +0,0 @@ -# Sphinx inventory version 1 -# Project: pysmurf -# Version: 1 diff --git a/docs/_build/html/search.html b/docs/_build/html/search.html deleted file mode 100644 index 8f064e71c..000000000 --- a/docs/_build/html/search.html +++ /dev/null @@ -1,91 +0,0 @@ - - - - - - - Search — pysmurf v1 documentation - - - - - - - - - -
      -

      Navigation

      - -
      - -
      -
      -
      -
      - -

      Search

      -
      - -

      - Please activate JavaScript to enable the search - functionality. -

      -
      -

      - From here you can search these documents. Enter your search - words into the box below and click "search". Note that the search - function will automatically search for all of the words. Pages - containing fewer words won't appear in the result list. -

      -
      - - - -
      - -
      - -
      - -
      -
      -
      -
      -
      -
      -
      -
      -
      -
      -

      Navigation

      - -
      - -
      - © Copyright 2019, Edward Young. - Created using Sphinx 0.6.6. -
      - - - - \ No newline at end of file diff --git a/docs/_build/html/searchindex.js b/docs/_build/html/searchindex.js deleted file mode 100644 index 4cc4b45b1..000000000 --- a/docs/_build/html/searchindex.js +++ /dev/null @@ -1 +0,0 @@ -Search.setIndex({desctypes:{},terms:{index:0,search:0,welcom:0,modul:0,indic:0,content:0,tabl:0,document:0,page:0,pysmurf:0},titles:["Welcome to pysmurf’s documentation!"],modules:{},descrefs:{},filenames:["index"]}) \ No newline at end of file diff --git a/docs/base.rst b/docs/base.rst new file mode 100644 index 000000000..f5e004663 --- /dev/null +++ b/docs/base.rst @@ -0,0 +1,29 @@ +.. _base: + +base module +=========== + +base_class +---------- +.. automodule:: pysmurf.base.base_class + :members: + +logger +------ +.. automodule:: pysmurf.base.logger + :members: + +schema +------ +.. automodule:: pysmurf.base.schema + :members: + +smurf_config +------------ +.. automodule:: pysmurf.base.smurf_config + :members: + +smurf_control +------------- +.. automodule:: pysmurf.base.smurf_control + :members: diff --git a/docs/command.rst b/docs/command.rst new file mode 100644 index 000000000..9898cf89e --- /dev/null +++ b/docs/command.rst @@ -0,0 +1,29 @@ +.. _command: + +command module +============== + +cryo_card +--------- +.. automodule:: pysmurf.command.cryo_card + :members: + +smurf_atca_monitor +------------------ +.. automodule:: pysmurf.command.smurf_atca_monitor + :members: + +smurf_cmd +--------- +.. automodule:: pysmurf.command.smurf_cmd + :members: + +smurf_command +------------- +.. automodule:: pysmurf.command.smurf_command + :members: + +sync_group +---------- +.. automodule:: pysmurf.command.sync_group + :members: diff --git a/docs/conf.py b/docs/conf.py index 09bfb5960..0a8a2ba07 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -22,7 +22,11 @@ # Add any Sphinx extension module names here, as strings. They can be extensions # coming with Sphinx (named 'sphinx.ext.*') or your custom ones. -extensions = ['sphinx.ext.todo'] +extensions = [ + 'sphinx.ext.autodoc', + 'sphinx.ext.napoleon', + 'sphinx.ext.todo', +] # Add any paths that contain templates here, relative to this directory. templates_path = ['_templates'] @@ -38,7 +42,7 @@ # General information about the project. project = u'pysmurf' -copyright = u'2019, Edward Young' +copyright = u'2019, The Board of Trustees of the Leland Stanford Junior University, through SLAC National Accelerator Laboratory (subject to receipt of any required approvals from the U.S. Dept. of Energy).' # The version info for the project you're documenting, acts as replacement for # |version| and |release|, also used in various other places throughout the diff --git a/docs/debug.rst b/docs/debug.rst new file mode 100644 index 000000000..3bf77db29 --- /dev/null +++ b/docs/debug.rst @@ -0,0 +1,14 @@ +.. _debug: + +debug module +============ + +smurf_iv +--------- +.. automodule:: pysmurf.debug.smurf_iv + :members: + +smurf_noise +----------- +.. automodule:: pysmurf.debug.smurf_noise + :members: diff --git a/docs/index.html b/docs/index.html deleted file mode 100644 index ca68a4ae7..000000000 --- a/docs/index.html +++ /dev/null @@ -1,6 +0,0 @@ - - - - - - diff --git a/docs/index.md b/docs/index.md deleted file mode 100644 index 323e9d6eb..000000000 --- a/docs/index.md +++ /dev/null @@ -1 +0,0 @@ -Another test file... diff --git a/docs/index.rst b/docs/index.rst index 877b7ced3..4d45b3408 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -6,11 +6,19 @@ Welcome to pysmurf's documentation! =================================== -Contents: +Insert description of pysmurf here. +API +--- .. toctree:: :maxdepth: 2 + base + command + debug + tune + util + Indices and tables ================== diff --git a/docs/tune.rst b/docs/tune.rst new file mode 100644 index 000000000..26a3c6e1a --- /dev/null +++ b/docs/tune.rst @@ -0,0 +1,9 @@ +.. _tune: + +tune module +=========== + +smurf_tune +---------- +.. automodule:: pysmurf.tune.smurf_tune + :members: diff --git a/docs/util.rst b/docs/util.rst new file mode 100644 index 000000000..7ece3c62b --- /dev/null +++ b/docs/util.rst @@ -0,0 +1,19 @@ +.. _util: + +util module +=========== + +pub +--- +.. autoclass:: pysmurf.util.pub.Publisher + :members: + +smurf_util +---------- +.. automodule:: pysmurf.util.smurf_util + :members: + +tools +----- +.. automodule:: pysmurf.util.tools + :members: diff --git a/pysmurf/__init__.py b/pysmurf/__init__.py new file mode 100644 index 000000000..66b0c3142 --- /dev/null +++ b/pysmurf/__init__.py @@ -0,0 +1,18 @@ +#!/usr/bin/env python +#----------------------------------------------------------------------------- +# This file is part of the pysmurf software package. It is subject to +# the license terms in the LICENSE.txt file found in the top-level directory +# of this distribution and at: +# https://confluence.slac.stanford.edu/display/ppareg/LICENSE.html. +# No part of the pysmurf software package, including this file, may be +# copied, modified, propagated, or distributed except according to the terms +# contained in the LICENSE.txt file. +#----------------------------------------------------------------------------- +''' +init for root python directory +''' +from .base.smurf_control import SmurfControl + +from ._version import get_versions +__version__ = get_versions()['version'] +del get_versions diff --git a/pysmurf/_version.py b/pysmurf/_version.py new file mode 100644 index 000000000..6bfa032b3 --- /dev/null +++ b/pysmurf/_version.py @@ -0,0 +1,519 @@ +#!/usr/bin/env python +# This file helps to compute a version number in source trees obtained from +# git-archive tarball (such as those provided by githubs download-from-tag +# feature). Distribution tarballs (built by setup.py sdist) and build +# directories (produced by setup.py build) will contain a much shorter file +# that just contains the computed version number. + +# This file is released into the public domain. Generated by +# versioneer-0.18 (https://github.com/warner/python-versioneer) + +"""Git implementation of _version.py.""" + +import errno +import os +import re +import subprocess +import sys + +def get_keywords(): + """Get the keywords needed to look up the version information.""" + # these strings will be replaced by git during git-archive. + # setup.py/versioneer.py will grep for the variable names, so they must + # each be defined on a line of their own. _version.py will just call + # get_keywords(). + git_refnames = "$Format:%d$" + git_full = "$Format:%H$" + git_date = "$Format:%ci$" + keywords = {"refnames": git_refnames, "full": git_full, "date": git_date} + return keywords + + +class VersioneerConfig: + """Container for Versioneer configuration parameters.""" + + +def get_config(): + """Create, populate and return the VersioneerConfig() object.""" + # these strings are filled in when 'setup.py versioneer' creates + # _version.py + cfg = VersioneerConfig() + cfg.VCS = "git" + cfg.style = "pep440" + cfg.tag_prefix = "v" + cfg.parentdir_prefix = "pysmurf-" + cfg.versionfile_source = "pysmurf/_version.py" + cfg.verbose = False + return cfg + + +class NotThisMethod(Exception): + """Exception raised if a method is not valid for the current scenario.""" + + +LONG_VERSION_PY = {} +HANDLERS = {} + + +def register_vcs_handler(vcs, method): # decorator + """Decorator to mark a method as the handler for a particular VCS.""" + def decorate(f): + """Store f in HANDLERS[vcs][method].""" + if vcs not in HANDLERS: + HANDLERS[vcs] = {} + HANDLERS[vcs][method] = f + return f + return decorate + + +def run_command(commands, args, cwd=None, verbose=False, hide_stderr=False, + env=None): + """Call the given command(s).""" + assert isinstance(commands, list) + p = None + for c in commands: + try: + dispcmd = str([c] + args) + # remember shell=False, so use git.cmd on windows, not just git + p = subprocess.Popen([c] + args, cwd=cwd, env=env, + stdout=subprocess.PIPE, + stderr=(subprocess.PIPE if hide_stderr + else None)) + break + except EnvironmentError: + e = sys.exc_info()[1] + if e.errno == errno.ENOENT: + continue + if verbose: + print("unable to run %s" % dispcmd) + print(e) + return None, None + else: + if verbose: + print("unable to find command, tried %s" % (commands,)) + return None, None + stdout = p.communicate()[0].strip() + if sys.version_info[0] >= 3: + stdout = stdout.decode() + if p.returncode != 0: + if verbose: + print("unable to run %s (error)" % dispcmd) + print("stdout was %s" % stdout) + return None, p.returncode + return stdout, p.returncode + + +def versions_from_parentdir(parentdir_prefix, root, verbose): + """Try to determine the version from the parent directory name. + + Source tarballs conventionally unpack into a directory that includes both + the project name and a version string. We will also support searching up + two directory levels for an appropriately named parent directory + """ + rootdirs = [] + + for i in range(3): + dirname = os.path.basename(root) + if dirname.startswith(parentdir_prefix): + return {"version": dirname[len(parentdir_prefix):], + "full-revisionid": None, + "dirty": False, "error": None, "date": None} + else: + rootdirs.append(root) + root = os.path.dirname(root) # up a level + + if verbose: + print("Tried directories %s but none started with prefix %s" % + (str(rootdirs), parentdir_prefix)) + raise NotThisMethod("rootdir doesn't start with parentdir_prefix") + + +@register_vcs_handler("git", "get_keywords") +def git_get_keywords(versionfile_abs): + """Extract version information from the given file.""" + # the code embedded in _version.py can just fetch the value of these + # keywords. When used from setup.py, we don't want to import _version.py, + # so we do it with a regexp instead. This function is not used from + # _version.py. + keywords = {} + try: + f = open(versionfile_abs, "r") + for line in f.readlines(): + if line.strip().startswith("git_refnames ="): + mo = re.search(r'=\s*"(.*)"', line) + if mo: + keywords["refnames"] = mo.group(1) + if line.strip().startswith("git_full ="): + mo = re.search(r'=\s*"(.*)"', line) + if mo: + keywords["full"] = mo.group(1) + if line.strip().startswith("git_date ="): + mo = re.search(r'=\s*"(.*)"', line) + if mo: + keywords["date"] = mo.group(1) + f.close() + except EnvironmentError: + pass + return keywords + + +@register_vcs_handler("git", "keywords") +def git_versions_from_keywords(keywords, tag_prefix, verbose): + """Get version information from git keywords.""" + if not keywords: + raise NotThisMethod("no keywords at all, weird") + date = keywords.get("date") + if date is not None: + # git-2.2.0 added "%cI", which expands to an ISO-8601 -compliant + # datestamp. However we prefer "%ci" (which expands to an "ISO-8601 + # -like" string, which we must then edit to make compliant), because + # it's been around since git-1.5.3, and it's too difficult to + # discover which version we're using, or to work around using an + # older one. + date = date.strip().replace(" ", "T", 1).replace(" ", "", 1) + refnames = keywords["refnames"].strip() + if refnames.startswith("$Format"): + if verbose: + print("keywords are unexpanded, not using") + raise NotThisMethod("unexpanded keywords, not a git-archive tarball") + refs = set([r.strip() for r in refnames.strip("()").split(",")]) + # starting in git-1.8.3, tags are listed as "tag: foo-1.0" instead of + # just "foo-1.0". If we see a "tag: " prefix, prefer those. + TAG = "tag: " + tags = set([r[len(TAG):] for r in refs if r.startswith(TAG)]) + if not tags: + # Either we're using git < 1.8.3, or there really are no tags. We use + # a heuristic: assume all version tags have a digit. The old git %d + # expansion behaves like git log --decorate=short and strips out the + # refs/heads/ and refs/tags/ prefixes that would let us distinguish + # between branches and tags. By ignoring refnames without digits, we + # filter out many common branch names like "release" and + # "stabilization", as well as "HEAD" and "master". + tags = set([r for r in refs if re.search(r'\d', r)]) + if verbose: + print("discarding '%s', no digits" % ",".join(refs - tags)) + if verbose: + print("likely tags: %s" % ",".join(sorted(tags))) + for ref in sorted(tags): + # sorting will prefer e.g. "2.0" over "2.0rc1" + if ref.startswith(tag_prefix): + r = ref[len(tag_prefix):] + if verbose: + print("picking %s" % r) + return {"version": r, + "full-revisionid": keywords["full"].strip(), + "dirty": False, "error": None, + "date": date} + # no suitable tags, so version is "0+unknown", but full hex is still there + if verbose: + print("no suitable tags, using unknown + full revision id") + return {"version": "0+unknown", + "full-revisionid": keywords["full"].strip(), + "dirty": False, "error": "no suitable tags", "date": None} + + +@register_vcs_handler("git", "pieces_from_vcs") +def git_pieces_from_vcs(tag_prefix, root, verbose, run_command=run_command): + """Get version from 'git describe' in the root of the source tree. + + This only gets called if the git-archive 'subst' keywords were *not* + expanded, and _version.py hasn't already been rewritten with a short + version string, meaning we're inside a checked out source tree. + """ + GITS = ["git"] + if sys.platform == "win32": + GITS = ["git.cmd", "git.exe"] + + out, rc = run_command(GITS, ["rev-parse", "--git-dir"], cwd=root, + hide_stderr=True) + if rc != 0: + if verbose: + print("Directory %s not under git control" % root) + raise NotThisMethod("'git rev-parse --git-dir' returned error") + + # if there is a tag matching tag_prefix, this yields TAG-NUM-gHEX[-dirty] + # if there isn't one, this yields HEX[-dirty] (no NUM) + describe_out, rc = run_command(GITS, ["describe", "--tags", "--dirty", + "--always", "--long", + "--match", "%s*" % tag_prefix], + cwd=root) + # --long was added in git-1.5.5 + if describe_out is None: + raise NotThisMethod("'git describe' failed") + describe_out = describe_out.strip() + full_out, rc = run_command(GITS, ["rev-parse", "HEAD"], cwd=root) + if full_out is None: + raise NotThisMethod("'git rev-parse' failed") + full_out = full_out.strip() + + pieces = {} + pieces["long"] = full_out + pieces["short"] = full_out[:7] # maybe improved later + pieces["error"] = None + + # parse describe_out. It will be like TAG-NUM-gHEX[-dirty] or HEX[-dirty] + # TAG might have hyphens. + git_describe = describe_out + + # look for -dirty suffix + dirty = git_describe.endswith("-dirty") + pieces["dirty"] = dirty + if dirty: + git_describe = git_describe[:git_describe.rindex("-dirty")] + + # now we have TAG-NUM-gHEX or HEX + + if "-" in git_describe: + # TAG-NUM-gHEX + mo = re.search(r'^(.+)-(\d+)-g([0-9a-f]+)$', git_describe) + if not mo: + # unparseable. Maybe git-describe is misbehaving? + pieces["error"] = ("unable to parse git-describe output: '%s'" + % describe_out) + return pieces + + # tag + full_tag = mo.group(1) + if not full_tag.startswith(tag_prefix): + if verbose: + fmt = "tag '%s' doesn't start with prefix '%s'" + print(fmt % (full_tag, tag_prefix)) + pieces["error"] = ("tag '%s' doesn't start with prefix '%s'" + % (full_tag, tag_prefix)) + return pieces + pieces["closest-tag"] = full_tag[len(tag_prefix):] + + # distance: number of commits since tag + pieces["distance"] = int(mo.group(2)) + + # commit: short hex revision ID + pieces["short"] = mo.group(3) + + else: + # HEX: no tags + pieces["closest-tag"] = None + count_out, rc = run_command(GITS, ["rev-list", "HEAD", "--count"], + cwd=root) + pieces["distance"] = int(count_out) # total number of commits + + # commit date: see ISO-8601 comment in git_versions_from_keywords() + date = run_command(GITS, ["show", "-s", "--format=%ci", "HEAD"], + cwd=root)[0].strip() + pieces["date"] = date.strip().replace(" ", "T", 1).replace(" ", "", 1) + + return pieces + + +def plus_or_dot(pieces): + """Return a + if we don't already have one, else return a .""" + if "+" in pieces.get("closest-tag", ""): + return "." + return "+" + + +def render_pep440(pieces): + """Build up version string, with post-release "local version identifier". + + Our goal: TAG[+DISTANCE.gHEX[.dirty]] . Note that if you + get a tagged build and then dirty it, you'll get TAG+0.gHEX.dirty + + Exceptions: + 1: no tags. git_describe was just HEX. 0+untagged.DISTANCE.gHEX[.dirty] + """ + if pieces["closest-tag"]: + rendered = pieces["closest-tag"] + if pieces["distance"] or pieces["dirty"]: + rendered += plus_or_dot(pieces) + rendered += "%d.g%s" % (pieces["distance"], pieces["short"]) + if pieces["dirty"]: + rendered += ".dirty" + else: + # exception #1 + rendered = "0+untagged.%d.g%s" % (pieces["distance"], + pieces["short"]) + if pieces["dirty"]: + rendered += ".dirty" + return rendered + + +def render_pep440_pre(pieces): + """TAG[.post.devDISTANCE] -- No -dirty. + + Exceptions: + 1: no tags. 0.post.devDISTANCE + """ + if pieces["closest-tag"]: + rendered = pieces["closest-tag"] + if pieces["distance"]: + rendered += ".post.dev%d" % pieces["distance"] + else: + # exception #1 + rendered = "0.post.dev%d" % pieces["distance"] + return rendered + + +def render_pep440_post(pieces): + """TAG[.postDISTANCE[.dev0]+gHEX] . + + The ".dev0" means dirty. Note that .dev0 sorts backwards + (a dirty tree will appear "older" than the corresponding clean one), + but you shouldn't be releasing software with -dirty anyways. + + Exceptions: + 1: no tags. 0.postDISTANCE[.dev0] + """ + if pieces["closest-tag"]: + rendered = pieces["closest-tag"] + if pieces["distance"] or pieces["dirty"]: + rendered += ".post%d" % pieces["distance"] + if pieces["dirty"]: + rendered += ".dev0" + rendered += plus_or_dot(pieces) + rendered += "g%s" % pieces["short"] + else: + # exception #1 + rendered = "0.post%d" % pieces["distance"] + if pieces["dirty"]: + rendered += ".dev0" + rendered += "+g%s" % pieces["short"] + return rendered + + +def render_pep440_old(pieces): + """TAG[.postDISTANCE[.dev0]] . + + The ".dev0" means dirty. + + Eexceptions: + 1: no tags. 0.postDISTANCE[.dev0] + """ + if pieces["closest-tag"]: + rendered = pieces["closest-tag"] + if pieces["distance"] or pieces["dirty"]: + rendered += ".post%d" % pieces["distance"] + if pieces["dirty"]: + rendered += ".dev0" + else: + # exception #1 + rendered = "0.post%d" % pieces["distance"] + if pieces["dirty"]: + rendered += ".dev0" + return rendered + + +def render_git_describe(pieces): + """TAG[-DISTANCE-gHEX][-dirty]. + + Like 'git describe --tags --dirty --always'. + + Exceptions: + 1: no tags. HEX[-dirty] (note: no 'g' prefix) + """ + if pieces["closest-tag"]: + rendered = pieces["closest-tag"] + if pieces["distance"]: + rendered += "-%d-g%s" % (pieces["distance"], pieces["short"]) + else: + # exception #1 + rendered = pieces["short"] + if pieces["dirty"]: + rendered += "-dirty" + return rendered + + +def render_git_describe_long(pieces): + """TAG-DISTANCE-gHEX[-dirty]. + + Like 'git describe --tags --dirty --always -long'. + The distance/hash is unconditional. + + Exceptions: + 1: no tags. HEX[-dirty] (note: no 'g' prefix) + """ + if pieces["closest-tag"]: + rendered = pieces["closest-tag"] + rendered += "-%d-g%s" % (pieces["distance"], pieces["short"]) + else: + # exception #1 + rendered = pieces["short"] + if pieces["dirty"]: + rendered += "-dirty" + return rendered + + +def render(pieces, style): + """Render the given version pieces into the requested style.""" + if pieces["error"]: + return {"version": "unknown", + "full-revisionid": pieces.get("long"), + "dirty": None, + "error": pieces["error"], + "date": None} + + if not style or style == "default": + style = "pep440" # the default + + if style == "pep440": + rendered = render_pep440(pieces) + elif style == "pep440-pre": + rendered = render_pep440_pre(pieces) + elif style == "pep440-post": + rendered = render_pep440_post(pieces) + elif style == "pep440-old": + rendered = render_pep440_old(pieces) + elif style == "git-describe": + rendered = render_git_describe(pieces) + elif style == "git-describe-long": + rendered = render_git_describe_long(pieces) + else: + raise ValueError("unknown style '%s'" % style) + + return {"version": rendered, "full-revisionid": pieces["long"], + "dirty": pieces["dirty"], "error": None, + "date": pieces.get("date")} + + +def get_versions(): + """Get version information or return default if unable to do so.""" + # I am in _version.py, which lives at ROOT/VERSIONFILE_SOURCE. If we have + # __file__, we can work backwards from there to the root. Some + # py2exe/bbfreeze/non-CPython implementations don't do __file__, in which + # case we can only use expanded keywords. + + cfg = get_config() + verbose = cfg.verbose + + try: + return git_versions_from_keywords(get_keywords(), cfg.tag_prefix, + verbose) + except NotThisMethod: + pass + + try: + root = os.path.realpath(__file__) + # versionfile_source is the relative path from the top of the source + # tree (where the .git directory might live) to this file. Invert + # this to find the root from __file__. + for i in cfg.versionfile_source.split('/'): + root = os.path.dirname(root) + except NameError: + return {"version": "0+unknown", "full-revisionid": None, + "dirty": None, + "error": "unable to find root of source tree", + "date": None} + + try: + pieces = git_pieces_from_vcs(cfg.tag_prefix, root, verbose) + return render(pieces, cfg.style) + except NotThisMethod: + pass + + try: + if cfg.parentdir_prefix: + return versions_from_parentdir(cfg.parentdir_prefix, root, verbose) + except NotThisMethod: + pass + + return {"version": "0+unknown", "full-revisionid": None, + "dirty": None, + "error": "unable to compute version", "date": None} diff --git a/pysmurf/base/__init__.py b/pysmurf/base/__init__.py new file mode 100644 index 000000000..711822179 --- /dev/null +++ b/pysmurf/base/__init__.py @@ -0,0 +1,14 @@ +#!/usr/bin/env python +#----------------------------------------------------------------------------- +# This file is part of the pysmurf software package. It is subject to +# the license terms in the LICENSE.txt file found in the top-level directory +# of this distribution and at: +# https://confluence.slac.stanford.edu/display/ppareg/LICENSE.html. +# No part of the pysmurf software package, including this file, may be +# copied, modified, propagated, or distributed except according to the terms +# contained in the LICENSE.txt file. +#----------------------------------------------------------------------------- +''' +init for base +''' +from .base_class import SmurfBase diff --git a/base/base_class.py b/pysmurf/base/base_class.py similarity index 61% rename from base/base_class.py rename to pysmurf/base/base_class.py index 34804d362..cdb4d057a 100644 --- a/base/base_class.py +++ b/pysmurf/base/base_class.py @@ -1,7 +1,24 @@ +#!/usr/bin/env python +#----------------------------------------------------------------------------- +# Title : pysmurf base module - SmurfBase class +#----------------------------------------------------------------------------- +# File : pysmurf/base/base_class.py +# Created : 2018-08-30 +#----------------------------------------------------------------------------- +# This file is part of the pysmurf software package. It is subject to +# the license terms in the LICENSE.txt file found in the top-level directory +# of this distribution and at: +# https://confluence.slac.stanford.edu/display/ppareg/LICENSE.html. +# No part of the pysmurf software package, including this file, may be +# copied, modified, propagated, or distributed except according to the terms +# contained in the LICENSE.txt file. +#----------------------------------------------------------------------------- import numpy as np from .logger import SmurfLogger from pysmurf.command.cryo_card import CryoCard +from pysmurf.util.pub import Publisher + class SmurfBase(object): ''' Base class for common things @@ -27,7 +44,23 @@ class SmurfBase(object): Overall progress on a task """ - def __init__(self, log=None, epics_root=None, offline=False, **kwargs): + def __init__(self, log=None, epics_root=None, offline=False, + pub_root=None, script_id=None, **kwargs): + """ + Opt Arguments + -------------- + log (log file) : The log file to write to. If None, creates a new log + file. + epics_root (str) : The name of the epics root. For example "test_epics". + offline (bool) : Whether to run in offline mode (no rogue) or not. This + will break many things. Default is False. + pub_root (str): + Root of environment vars to set publisher options. If None, the + default root will be "SMURFPUB_". + script_id (str): + Script id included with publisher messages. For example, the + script or operation name. + """ # Set up logging self.log = log if self.log is None: @@ -37,6 +70,10 @@ def __init__(self, log=None, epics_root=None, offline=False, **kwargs): if verb is not None: self.set_verbose(verb) + # If BACKEND environment variable is not set to 'udp', all + # publish calls will be no-ops. + self.pub = Publisher(env_root=pub_root, script_id=script_id) + self.offline = offline if self.offline == True: self.log('Offline mode') @@ -76,59 +113,76 @@ def __init__(self, log=None, epics_root=None, offline=False, **kwargs): self.channel_root = self.cryo_root + 'CryoChannel[{}]:' self.streaming_root = self.amcc + 'streamingInterface:' + + # FpgaTopLevel + self.fpgatl = self.amcc + 'FpgaTopLevel:' + + # AppTop + self.apptop = self.fpgatl + 'AppTop:' + + # AppCore + self.appcore = self.apptop + 'AppCore:' + + # AmcCarrierCore + self.amccc = self.fpgatl + 'AmcCarrierCore:' # Crossbar - self.crossbar = self.epics_root + \ - ':AMCc:FpgaTopLevel:AmcCarrierCore:AxiSy56040:' + self.crossbar = self.amccc + 'AxiSy56040:' + + # Regulator + self.regulator = self.amccc + 'IntelEnpirion:' # CarrierBsi - self.amc_carrier_bsi = self.epics_root + \ - ':AMCc:FpgaTopLevel:AmcCarrierCore:AmcCarrierBsi:' + self.amc_carrier_bsi = self.amccc + 'AmcCarrierBsi:' # FPGA - self.ultrascale = self.epics_root + \ - ':AMCc:FpgaTopLevel:AmcCarrierCore:AxiSysMonUltraScale:' - + self.ultrascale = self.amccc + 'AxiSysMonUltraScale:' + # Tx -> DAC , Rx <- ADC - self.axi_version = self.epics_root + \ - ':AMCc:FpgaTopLevel:AmcCarrierCore:AxiVersion:' - self.waveform_engine_buffers_root = self.epics_root + \ - ':AMCc:FpgaTopLevel:'+ \ - 'AmcCarrierCore:AmcCarrierBsa:BsaWaveformEngine[{}]:' + \ + self.axi_version = self.amccc + 'AxiVersion:' + self.waveform_engine_buffers_root = self.amccc + \ + 'AmcCarrierBsa:BsaWaveformEngine[{}]:' + \ 'WaveformEngineBuffers:' - self.stream_data_writer_root = self.epics_root + \ - ':AMCc:streamDataWriter:' - self.jesd_tx_root = self.epics_root + \ - ':AMCc:FpgaTopLevel:AppTop:AppTopJesd[{}]:JesdTx:' - self.jesd_rx_root = self.epics_root + \ - ':AMCc:FpgaTopLevel:AppTop:AppTopJesd[{}]:JesdRx:' - self.daq_mux_root = self.epics_root + \ - ':AMCc:FpgaTopLevel:AppTop:DaqMuxV2[{}]:' + self.stream_data_writer_root = self.amcc + 'streamDataWriter:' + self.jesd_tx_root = self.apptop + 'AppTopJesd[{}]:JesdTx:' + self.jesd_rx_root = self.apptop + 'AppTopJesd[{}]:JesdRx:' + self.daq_mux_root = self.apptop + 'DaqMuxV2[{}]:' # RTM paths - self.rtm_cryo_det_root = self.epics_root + \ - ':AMCc:FpgaTopLevel:AppTop:AppCore:RtmCryoDet:' + self.rtm_cryo_det_root = self.appcore + 'RtmCryoDet:' self.rtm_spi_root = self.rtm_cryo_det_root + \ 'RtmSpiSr:' self.rtm_spi_max_root = self.rtm_cryo_det_root + \ 'RtmSpiMax:' self.rtm_spi_cryo_root = self.rtm_cryo_det_root + \ 'SpiCryo:' + self.rtm_lut_ctrl_root = self.rtm_cryo_det_root + \ + 'LutCtrl:' + self.rtm_lut_ctrl = self.rtm_lut_ctrl_root + \ + 'Ctrl:' # Timing paths - self.trigger_root = self.epics_root + \ - ':AMCc:FpgaTopLevel:AmcCarrierCore:AmcCarrierTiming:' + \ - 'EvrV2CoreTriggers:' - - # Timing status - self.timing_status = self.epics_root + \ - ':AMCc:FpgaTopLevel:AmcCarrierCore:AmcCarrierTiming:' + \ - 'TimingFrameRx:' + self.amctiming = self.amccc + 'AmcCarrierTiming:' + self.trigger_root = self.amctiming + 'EvrV2CoreTriggers:' + self.timing_status = self.amctiming + 'TimingFrameRx:' self.C = CryoCard(self.rtm_spi_cryo_root + 'read', self.rtm_spi_cryo_root + 'write') self.freq_resp = {} + # RTM slow DAC parameters (used, e.g., for TES biasing). The + # DACs are AD5790 chips + self._rtm_slow_dac_max_volt=10. # Max unipolar DAC voltage, + # in Volts + self._rtm_slow_dac_nbits=20 + # x2 because _rtm_slow_dac_max_volt is the maximum *unipolar* + # voltage. Units of Volt/bit + self._rtm_slow_dac_bit_to_volt=( 2*self._rtm_slow_dac_max_volt / + ( 2**( self._rtm_slow_dac_nbits ) ) ) + + # LUT table length for arbitrary waveform generation + self._lut_table_array_length=2048 + def init_log(self, verbose=0, logger=SmurfLogger, logfile=None, log_timestamp=True, log_prefix=None, **kwargs): """ diff --git a/base/logger.py b/pysmurf/base/logger.py similarity index 84% rename from base/logger.py rename to pysmurf/base/logger.py index 2d431dfc1..f98328108 100644 --- a/base/logger.py +++ b/pysmurf/base/logger.py @@ -1,8 +1,13 @@ -""" -Logger classes - This is stoled from spider_tools. -Originally written by M. Hasselfield and ported by S. Rahlin -""" - +#!/usr/bin/env python +#----------------------------------------------------------------------------- +# Title : pysmurf base module - Logger class +#----------------------------------------------------------------------------- +# File : pysmurf/base/logger.py +# Created : 2018-08-29 +#----------------------------------------------------------------------------- +# This is adapted from spider_tools. Originally written by +# M. Hasselfield and ported by S. Rahlin +#----------------------------------------------------------------------------- import sys import datetime as dt @@ -101,4 +106,4 @@ def format(self, s, level=0): # root argument added as hack so that MPI/non-MPI code can get along def write(self, s, level=0, root=False): - super(SmurfLogger, self).write(s, self.get_level(level)) \ No newline at end of file + super(SmurfLogger, self).write(s, self.get_level(level)) diff --git a/base/schema.py b/pysmurf/base/schema.py similarity index 99% rename from base/schema.py rename to pysmurf/base/schema.py index 01cdba677..4fc2468dc 100644 --- a/base/schema.py +++ b/pysmurf/base/schema.py @@ -1,3 +1,4 @@ +#!/usr/bin/env python """schema is a library for validating Python data structures, such as those obtained from config-files, forms, external services or command-line parsing, converted from JSON/YAML (or something else) to Python data-types.""" diff --git a/base/smurf_config.py b/pysmurf/base/smurf_config.py similarity index 88% rename from base/smurf_config.py rename to pysmurf/base/smurf_config.py index 4e6707029..d8468dff9 100644 --- a/base/smurf_config.py +++ b/pysmurf/base/smurf_config.py @@ -1,11 +1,23 @@ +#!/usr/bin/env python +#----------------------------------------------------------------------------- +# Title : pysmurf base module - SmurfConfig class +#----------------------------------------------------------------------------- +# File : pysmurf/base/smurf_config.py +# Created : 2018-08-30 +#----------------------------------------------------------------------------- +# This file is part of the pysmurf software package. It is subject to +# the license terms in the LICENSE.txt file found in the top-level directory +# of this distribution and at: +# https://confluence.slac.stanford.edu/display/ppareg/LICENSE.html. +# No part of the pysmurf software package, including this file, may be +# copied, modified, propagated, or distributed except according to the terms +# contained in the LICENSE.txt file. +#----------------------------------------------------------------------------- import json import io import re import os -''' -Stolen from Cyndia/Shawns get_config.py -read or dump a config file -''' +import numpy as np class SmurfConfig: """Initialize, read, or dump a SMuRF config file. @@ -13,11 +25,11 @@ class SmurfConfig: """ - def __init__(self, filename=None): + def __init__(self, filename=None, validate_config=True): self.filename = filename # self.config = [] # do I need to initialize this? I don't think so if self.filename is not None: - self.read(update=True) + self.read(update=True, validate_config=validate_config) def read_json(self, filename, comment_char='#'): """Reads a json config file @@ -42,7 +54,7 @@ def read_json(self, filename, comment_char='#'): loaded_config = json.loads('\n'.join(no_comments)) return loaded_config - def read(self, update=False): + def read(self, update=False, validate_config=True): """Reads config file and updates the configuration. Args: @@ -51,12 +63,15 @@ def read(self, update=False): loaded_config=self.read_json(self.filename) # validate - validated_config=self.validate_config(loaded_config) + if validate_config: + validated_config = self.validate_config(loaded_config) - if update: - # put in some logic here to make sure parameters in experiment file match - # the parameters we're looking for - self.config = validated_config + if update: + # put in some logic here to make sure parameters in experiment file match + # the parameters we're looking for + self.config = validated_config + else: + self.config = loaded_config def update(self, key, val): """Updates a single key in the config @@ -316,6 +331,7 @@ def RepresentsInt(s): Optional('freq_min', default=-250.e6) : And(Use(float),lambda f: -307.2e6 <= f <= 307.2e6), 'fraction_full_scale' : And(Use(float),lambda f: 0 < f <=1.), + 'reset_rate_khz' : And(Use(float), lambda f: 0 <= f <= 100), Optional('default_tune',default=None) : And(str,os.path.isfile) } @@ -511,6 +527,27 @@ def fileDirExistsAndUserHasWriteAccess(file_path): schema = Schema(schema_dict) validated_config = schema.validate(loaded_config) + ################################################### + # Higher level/composite validation, if schema validation + # succeeds + + # Check that no DAC has been assigned to multiple TES bias groups + bias_group_to_pair=validated_config['bias_group_to_pair'] + tes_bias_group_dacs=np.ndarray.flatten(np.array([bg2p[1] for bg2p in bias_group_to_pair.items()])) + assert ( len(np.unique(tes_bias_group_dacs)) == len(tes_bias_group_dacs) ), 'Configuration failed - DACs may not be assigned to multiple TES bias groups.' + + # Check that the DAC specified as the 50K gate driver + # isn't also defined as one of the DACs in a TES bias group + # pair. + dac_num_50k=validated_config['amplifier']['dac_num_50k'] + # Taking the first element works because we already required + # that no DAC show up in more than one TES bias group + # definition. + assert (dac_num_50k not in tes_bias_group_dacs),'Configuration failed - DAC requested for driving 50K amplifier gate, %d, is also assigned to TES bias group %d.'%(int(dac_num_50k),int([bg2p[0] for bg2p in bias_group_to_pair.items() if dac_num_50k in bg2p[1]][0])) + + ##### Done with higher level/composite validation. + ################################################### + # Splice in the sorted init:bands key before returning validated_config['init']['bands']=bands diff --git a/base/smurf_control.py b/pysmurf/base/smurf_control.py similarity index 89% rename from base/smurf_control.py rename to pysmurf/base/smurf_control.py index b92ef2268..b8b3bad91 100644 --- a/base/smurf_control.py +++ b/pysmurf/base/smurf_control.py @@ -1,3 +1,18 @@ +#!/usr/bin/env python +#----------------------------------------------------------------------------- +# Title : pysmurf base module - SmurfControl class +#----------------------------------------------------------------------------- +# File : pysmurf/base/smurf_control.py +# Created : 2018-08-29 +#----------------------------------------------------------------------------- +# This file is part of the pysmurf software package. It is subject to +# the license terms in the LICENSE.txt file found in the top-level directory +# of this distribution and at: +# https://confluence.slac.stanford.edu/display/ppareg/LICENSE.html. +# No part of the pysmurf software package, including this file, may be +# copied, modified, propagated, or distributed except according to the terms +# contained in the LICENSE.txt file. +#----------------------------------------------------------------------------- import numpy as np import os import sys @@ -10,7 +25,7 @@ from pysmurf.debug.smurf_noise import SmurfNoiseMixin as SmurfNoiseMixin from pysmurf.debug.smurf_iv import SmurfIVMixin as SmurfIVMixin from pysmurf.base.smurf_config import SmurfConfig as SmurfConfig -from pysmurf.util.pub import Publisher, DEFAULT_ENV_ROOT +from pysmurf.util.pub import Publisher class SmurfControl(SmurfCommandMixin, SmurfAtcaMonitorMixin, SmurfUtilMixin, SmurfTuneMixin, @@ -23,8 +38,8 @@ def __init__(self, epics_root=None, cfg_file='/home/cryo/pysmurf/cfg_files/experiment_k2umux.cfg', data_dir=None, name=None, make_logfile=True, setup=False, offline=False, smurf_cmd_mode=False, - no_dir=False, shelf_manager='shm-smrf-sp01', - publish=False, **kwargs): + no_dir=False, shelf_manager='shm-smrf-sp01', + validate_config=True, **kwargs): ''' Args: ----- @@ -33,14 +48,13 @@ def __init__(self, epics_root=None, data_dir (string) : Path to the data dir Opt Args: - ----- - shelf_manager (str): Shelf manager ip or network name. Usually - each SMuRF server is connected one-to-one - with a SMuRF crate, in which case we by - default give the shelf manager the network - name 'shm-smrf-sp01'. + ---------- + shelf_manager (str): + Shelf manager ip or network name. Usually each SMuRF server is + connected one-to-one with a SMuRF crate, in which case we by + default give the shelf manager the network name 'shm-smrf-sp01'. ''' - self.config = SmurfConfig(cfg_file) + self.config = SmurfConfig(cfg_file, validate_config=validate_config) self.shelf_manager=shelf_manager if epics_root is None: epics_root = self.config.get('epics_root') @@ -50,8 +64,7 @@ def __init__(self, epics_root=None, if cfg_file is not None or data_dir is not None: self.initialize(cfg_file=cfg_file, data_dir=data_dir, name=name, make_logfile=make_logfile, setup=setup, - smurf_cmd_mode=smurf_cmd_mode, no_dir=no_dir, - publish=publish, **kwargs) + smurf_cmd_mode=smurf_cmd_mode, no_dir=no_dir, **kwargs) def initialize(self, cfg_file, data_dir=None, name=None, make_logfile=True, setup=False, @@ -83,7 +96,8 @@ def initialize(self, cfg_file, data_dir=None, name=None, # Set logfile datestr = time.strftime('%y%m%d_', time.gmtime()) - self.log_file = os.path.join(self.output_dir, 'logs', datestr + 'smurf_cmd.log') + self.log_file = os.path.join(self.output_dir, 'logs', datestr + + 'smurf_cmd.log') self.log.set_logfile(self.log_file) else: # define data dir @@ -124,11 +138,6 @@ def initialize(self, cfg_file, data_dir=None, name=None, self.crate_id=self.get_crate_id() self.slot_number=self.get_slot_number() - self.publish = publish - if publish: - os.environ[DEFAULT_ENV_ROOT + 'BACKEND'] = 'udp' - self.pub = Publisher() - # Useful constants constant_cfg = self.config.get('constant') self.pA_per_phi0 = constant_cfg.get('pA_per_phi0') @@ -183,7 +192,7 @@ def initialize(self, cfg_file, data_dir=None, name=None, if not no_dir: for b in self.config.get('init').get('bands'): all_channel_assignment_files=glob.glob(os.path.join(self.tune_dir, - '*channel_assignment_b{}.txt'.format(b))) + '*channel_assignment_b{}.txt'.format(b))) if len(all_channel_assignment_files): self.channel_assignment_files['band_{}'.format(b)] = \ np.sort(all_channel_assignment_files)[-1] @@ -191,8 +200,10 @@ def initialize(self, cfg_file, data_dir=None, name=None, # bias groups available self.all_groups = self.config.get('all_bias_groups') - # bias group to pair + # bias group to pair bias_group_cfg = self.config.get('bias_group_to_pair') + # how many bias groups are there? + self._n_bias_groups=len(bias_group_cfg) keys = bias_group_cfg.keys() self.bias_group_to_pair = np.zeros((len(keys), 3), dtype=int) for i, k in enumerate(keys): @@ -244,25 +255,30 @@ def initialize(self, cfg_file, data_dir=None, name=None, self.freq_resp = {} self.lms_freq_hz = {} self.fraction_full_scale = self.config.get('tune_band').get('fraction_full_scale') + self.reset_rate_khz = self.config.get('tune_band').get('reset_rate_khz') + smurf_init_config = self.config.get('init') bands = smurf_init_config['bands'] # Load in tuning parameters, if present tune_band_cfg=self.config.get('tune_band') tune_band_keys=tune_band_cfg.keys() + self.lms_gain = {} for b in bands: # Make band dictionaries self.freq_resp[b] = {} self.freq_resp[b]['lock_status'] = {} self.lms_freq_hz[b] = tune_band_cfg['lms_freq'][str(b)] - + band_str = f'band_{b}' + self.lms_gain[b] = smurf_init_config[band_str]['lmsGain'] + # Load in tuning parameters, if present tune_band_cfg=self.config.get('tune_band') tune_band_keys=tune_band_cfg.keys() for cfg_var in ['gradient_descent_gain', 'gradient_descent_averages', 'gradient_descent_converge_hz', 'gradient_descent_step_hz', 'gradient_descent_momentum', 'gradient_descent_beta', - 'eta_scan_del_f', - 'eta_scan_amplitude', 'eta_scan_averages','delta_freq']: + 'eta_scan_del_f', 'eta_scan_amplitude', + 'eta_scan_averages','delta_freq']: if cfg_var in tune_band_keys: setattr(self, cfg_var, {}) for b in bands: @@ -281,17 +297,20 @@ def setup(self, write_log=True, **kwargs): self.log('Setting up...', (self.LOG_USER)) # If active, disable hardware logging while doing setup. - print(self._hardware_logging_thread) if self._hardware_logging_thread is not None: - self.log('Hardware logging is enabled. Pausing for setup.', (self.LOG_USER)) + self.log('Hardware logging is enabled. Pausing for setup.', + (self.LOG_USER)) self.pause_hardware_logging() # Thermal OT protection - ultrascale_temperature_limit_degC=self.config.get('ultrascale_temperature_limit_degC') + ultrascale_temperature_limit_degC = self.config.get('ultrascale_temperature_limit_degC') if ultrascale_temperature_limit_degC is not None: - self.log('Setting ultrascale OT protection limit to {}C'.format(ultrascale_temperature_limit_degC), (self.LOG_USER)) + self.log('Setting ultrascale OT protection limit to {}C'.format(ultrascale_temperature_limit_degC), + (self.LOG_USER)) # OT threshold in degrees C - self.set_ultrascale_ot_threshold(self.config.get('ultrascale_temperature_limit_degC'),write_log=write_log) + self.set_ultrascale_ot_threshold( + self.config.get('ultrascale_temperature_limit_degC'), + write_log=write_log) # Which bands are we configuring? smurf_init_config = self.config.get('init') @@ -461,7 +480,7 @@ def setup(self, write_log=True, **kwargs): if timing_reference=='ext_ref': for bay in self.bays: - self.log('Select external reference for bay %i' % (bay)) + self.log(f'Select external reference for bay {bay}') self.sel_ext_ref(bay) # make sure RTM knows there's no timing system @@ -483,16 +502,16 @@ def setup(self, write_log=True, **kwargs): # Check if link is up - just printing status to # screen, not currently taking any action if it's not. timingRxLinkUp=self.get_timing_link_up() - self.log('Timing RxLinkUp = {}'.format(timingRxLinkUp), self.LOG_USER if + self.log(f'Timing RxLinkUp = {timingRxLinkUp}', self.LOG_USER if timingRxLinkUp else self.LOG_ERROR) # Set LMK to use timing system as reference for bay in self.bays: - self.log('Configuring bay %i LMK to lock to the timing system' % (bay)) - self.set_lmk_reg(bay,0x147,0xA) + self.log(f'Configuring bay {bay} LMK to lock to the timing system') + self.set_lmk_reg(bay, 0x147, 0xA) # Configure RTM to trigger off of the timing system - self.set_ramp_start_mode(1,write_log=write_log) + self.set_ramp_start_mode(1, write_log=write_log) self.log('Done with setup') diff --git a/pysmurf/command/__init__.py b/pysmurf/command/__init__.py new file mode 100644 index 000000000..80ee331df --- /dev/null +++ b/pysmurf/command/__init__.py @@ -0,0 +1,13 @@ +#!/usr/bin/env python +#----------------------------------------------------------------------------- +# This file is part of the pysmurf software package. It is subject to +# the license terms in the LICENSE.txt file found in the top-level directory +# of this distribution and at: +# https://confluence.slac.stanford.edu/display/ppareg/LICENSE.html. +# No part of the pysmurf software package, including this file, may be +# copied, modified, propagated, or distributed except according to the terms +# contained in the LICENSE.txt file. +#----------------------------------------------------------------------------- +''' +init for command directory +''' diff --git a/command/cryo_card.py b/pysmurf/command/cryo_card.py similarity index 83% rename from command/cryo_card.py rename to pysmurf/command/cryo_card.py index a35992d62..255fa47d4 100644 --- a/command/cryo_card.py +++ b/pysmurf/command/cryo_card.py @@ -1,12 +1,24 @@ +#!/usr/bin/env python +#----------------------------------------------------------------------------- +# Title : pysmurf command module - CryoCard class +#----------------------------------------------------------------------------- +# File : pysmurf/command/cryo_card.py +# Created : 2018-09-21 +# Author : Joe Frisch +#----------------------------------------------------------------------------- +# This file is part of the pysmurf software package. It is subject to +# the license terms in the LICENSE.txt file found in the top-level directory +# of this distribution and at: +# https://confluence.slac.stanford.edu/display/ppareg/LICENSE.html. +# No part of the pysmurf software package, including this file, may be +# copied, modified, propagated, or distributed except according to the terms +# contained in the LICENSE.txt file. +#----------------------------------------------------------------------------- import epics import time import os import time -""" -This is written by Joe Frisch. -""" - def write_csv(filename, header, line): should_write_header = os.path.exists(filename) with open(filename, 'a+') as f: diff --git a/command/runfile/mce_status_20180814.txt b/pysmurf/command/runfile/mce_status_20180814.txt similarity index 100% rename from command/runfile/mce_status_20180814.txt rename to pysmurf/command/runfile/mce_status_20180814.txt diff --git a/command/runfile/runfile_template.txt b/pysmurf/command/runfile/runfile_template.txt similarity index 100% rename from command/runfile/runfile_template.txt rename to pysmurf/command/runfile/runfile_template.txt diff --git a/command/smurf_atca_monitor.py b/pysmurf/command/smurf_atca_monitor.py similarity index 75% rename from command/smurf_atca_monitor.py rename to pysmurf/command/smurf_atca_monitor.py index 5080f3123..842b5ef6d 100644 --- a/command/smurf_atca_monitor.py +++ b/pysmurf/command/smurf_atca_monitor.py @@ -1,3 +1,18 @@ +#!/usr/bin/env python +#----------------------------------------------------------------------------- +# Title : pysmurf command module - SmurfAtcaMonitorMixin class +#----------------------------------------------------------------------------- +# File : pysmurf/command/smurf_atca_monitor.py +# Created : 2019-07-22 +#----------------------------------------------------------------------------- +# This file is part of the pysmurf software package. It is subject to +# the license terms in the LICENSE.txt file found in the top-level directory +# of this distribution and at: +# https://confluence.slac.stanford.edu/display/ppareg/LICENSE.html. +# No part of the pysmurf software package, including this file, may be +# copied, modified, propagated, or distributed except according to the terms +# contained in the LICENSE.txt file. +#----------------------------------------------------------------------------- import numpy as np import os import epics diff --git a/command/smurf_cmd.py b/pysmurf/command/smurf_cmd.py similarity index 95% rename from command/smurf_cmd.py rename to pysmurf/command/smurf_cmd.py index 170d52303..46418800b 100755 --- a/command/smurf_cmd.py +++ b/pysmurf/command/smurf_cmd.py @@ -1,4 +1,16 @@ -#!/usr/bin/env python3 +#!/usr/bin/env python +#----------------------------------------------------------------------------- +# File : pysmurf/command/smurf_cmd.py +# Created : 2018-10-05 +#----------------------------------------------------------------------------- +# This file is part of the pysmurf software package. It is subject to +# the license terms in the LICENSE.txt file found in the top-level directory +# of this distribution and at: +# https://confluence.slac.stanford.edu/display/ppareg/LICENSE.html. +# No part of the pysmurf software package, including this file, may be +# copied, modified, propagated, or distributed except according to the terms +# contained in the LICENSE.txt file. +#----------------------------------------------------------------------------- import argparse import numpy as np import sys diff --git a/command/smurf_command.py b/pysmurf/command/smurf_command.py similarity index 82% rename from command/smurf_command.py rename to pysmurf/command/smurf_command.py index dc22d15ad..234628087 100644 --- a/command/smurf_command.py +++ b/pysmurf/command/smurf_command.py @@ -1,3 +1,18 @@ +#!/usr/bin/env python +#----------------------------------------------------------------------------- +# Title : pysmurf command module - SmurfCommandMixin class +#----------------------------------------------------------------------------- +# File : pysmurf/command/smurf_command.py +# Created : 2018-08-29 +#----------------------------------------------------------------------------- +# This file is part of the pysmurf software package. It is subject to +# the license terms in the LICENSE.txt file found in the top-level directory +# of this distribution and at: +# https://confluence.slac.stanford.edu/display/ppareg/LICENSE.html. +# No part of the pysmurf software package, including this file, may be +# copied, modified, propagated, or distributed except according to the terms +# contained in the LICENSE.txt file. +#----------------------------------------------------------------------------- import numpy as np import os import epics @@ -367,7 +382,6 @@ def get_gradient_descent_beta(self, band, **kwargs): return self._caget(self._cryo_root(band) + self._gradient_descent_beta, **kwargs) - def run_parallel_eta_scan(self, band, sync_group=True, **kwargs): """ runParallelScan @@ -492,10 +506,22 @@ def sel_ext_ref(self, bay, **kwargs): self.log('{} sent'.format(triggerPV), self.LOG_USER) + _writestate = ":AMCc:WriteState" + def write_state(self, val, **kwargs): + """ + Dumps all PyRogue settings to a yml file. + + Args: + ---- + val (str) : The path (including file name) to write the yml file to. + """ + self._caput(self.epics_root + self._writestate, + val, **kwargs) + _writeconfig = ":AMCc:WriteConfig" def write_config(self, val, **kwargs): """ - Writes the current PyRogue settings to a yml file. + Writes the current (un-masked) PyRogue settings to a yml file. Args: ---- @@ -2114,6 +2140,249 @@ def get_trigger_hw_arm(self, bay, **kwargs): return self._caget(self.daq_mux_root.format(bay) + self._trigger_hw_arm, **kwargs) # rtm commands + + ######################################################### + ## start rtm arbitrary waveform + + _rtm_arb_waveform_lut_table = 'Lut[{}]:MemArray' + def get_rtm_arb_waveform_lut_table(self, reg, **kwargs): + ''' + Gets the table currently loaded into the LUT table indexed by + reg. + ''' + assert (reg in range(2)), 'reg must be in [0,1]' + return self._caget(self.rtm_lut_ctrl_root + \ + self._rtm_arb_waveform_lut_table.format(reg), \ + **kwargs) + + def set_rtm_arb_waveform_lut_table(self, reg, arr, pad=0, **kwargs): + ''' + Loads provided array into the LUT table indexed by reg. If + array is empty, loads zeros into table. If array exceeds + maximum length of 2048 entries, array is truncated. If array + is less than 2048 entries, the table is padded on the end with + the value in the pad argument. + + Args: + ----- + arr (int array): Array of values to load into LUT table. Each + entry must be an integer and in [0,2^20). + + Opt Args: + ----- + pad (int): Value to pad end of array with if provided array's + length is less than 2048. Default is 0. + ''' + # cast as numpy array + lut_arr=np.pad(arr[:self._lut_table_array_length], \ + (0,self._lut_table_array_length-len(arr[:self._lut_table_array_length])), \ + 'constant', constant_values=pad) + # round entries and type as integer + lut_arr=np.around(lut_arr).astype(int) + + # clip exceed max number of DAC output bits + dac_nbits_fullscale=self._rtm_slow_dac_nbits + # warn user if some points get clipped + num_clip_above=len(np.where(lut_arr>(2**(dac_nbits_fullscale-1)-1))[0]) + if num_clip_above>0: + self.log('{} points in LUT table exceed (2**{})-1. Will be clipped to (2**{})-1.'.format(num_clip_above,(dac_nbits_fullscale-1),(dac_nbits_fullscale-1))) + num_clip_below=len(np.where(lut_arr<(-2**(dac_nbits_fullscale-1)))[0]) + if num_clip_below>0: + self.log('{} points in LUT table are less than -2**{}. Will be clipped to -2**{}.'.format(num_clip_below,(dac_nbits_fullscale-1),(dac_nbits_fullscale-1))) + # clip the array + lut_arr=np.clip(lut_arr,a_min=-2**(dac_nbits_fullscale-1),a_max=2**(dac_nbits_fullscale-1)-1) + self._caput(self.rtm_lut_ctrl_root + \ + self._rtm_arb_waveform_lut_table.format(reg), \ + lut_arr, \ + **kwargs) + + _rtm_arb_waveform_busy = 'Busy' + def get_rtm_arb_waveform_busy(self, **kwargs): + ''' + =1 if waveform if Continuous=1 and the RTM arbitrary waveform + is being continously generated. Can be toggled low again by + setting Continuous=0. + ''' + return self._caget(self.rtm_lut_ctrl + + self._rtm_arb_waveform_busy, \ + **kwargs) + + _rtm_arb_waveform_trig_cnt = 'TrigCnt' + def get_rtm_arb_waveform_trig_cnt(self, **kwargs): + ''' + Counts the number of RTM arbitrary waveform software triggers + since boot up or the last CntRst. + ''' + return self._caget(self.rtm_lut_ctrl + + self._rtm_arb_waveform_trig_cnt, \ + **kwargs) + + _rtm_arb_waveform_continuous = 'Continuous' + def get_rtm_arb_waveform_continuous(self, **kwargs): + ''' + If =1, RTM arbitrary waveform generation is continuous and + repeats, otherwise if =0, waveform in LUT tables is only + broadcast once on software trigger. + ''' + return self._caget(self.rtm_lut_ctrl + \ + self._rtm_arb_waveform_continuous, \ + **kwargs) + + def set_rtm_arb_waveform_continuous(self, val, **kwargs): + ''' + If =1, RTM arbitrary waveform generation is continuous and + repeats, otherwise if =0, waveform in LUT tables is only + broadcast once on software trigger. + + Args: + ----- + val (int): Whether or not arbitrary waveform generation is + continuous on software trigger. Must be in [0,1]. + ''' + assert (val in range(2)), 'val must be in [0,1]' + self._caput(self.rtm_lut_ctrl + \ + self._rtm_arb_waveform_continuous, \ + val, \ + **kwargs) + + _rtm_arb_waveform_software_trigger = 'SwTrig' + def trigger_rtm_arb_waveform(self, continuous=False, **kwargs): + ''' + Software trigger for arbitrary waveform generation on the slow + RTM DACs. This will cause the RTM to play the LUT tables only + once. + + Args: + ----- + continuous (bool): Whether or not to continously broadcast the + arbitrary waveform on software trigger. + Default False. + ''' + if continuous is True: + self.set_rtm_arb_waveform_continuous(1) + else: + self.set_rtm_arb_waveform_continuous(0) + + triggerPV=self.rtm_lut_ctrl + \ + self._rtm_arb_waveform_software_trigger + self._caput(triggerPV, \ + 1, \ + **kwargs) + self.log('{} sent'.format(triggerPV), self.LOG_USER) + + _dac_axil_addr = 'DacAxilAddr[{}]' + def get_dac_axil_addr(self, reg, **kwargs): + ''' + Gets the DacAxilAddr[#] registers. + ''' + assert (reg in range(2)), 'reg must be in [0,1]' + return self._caget(self.rtm_lut_ctrl + \ + self._dac_axil_addr.format(reg), \ + **kwargs) + + def set_dac_axil_addr(self, reg, val, **kwargs): + ''' + Sets the DacAxilAddr[#] registers. + ''' + assert (reg in range(2)), 'reg must be in [0,1]' + self._caput(self.rtm_lut_ctrl + \ + self._dac_axil_addr.format(reg), val, **kwargs) + + _rtm_arb_waveform_timer_size = 'TimerSize' + def get_rtm_arb_waveform_timer_size(self, **kwargs): + ''' + Arbitrary waveforms are written to the slow RTM DACs with time + between samples TimerSize*6.4ns. + ''' + return self._caget(self.rtm_lut_ctrl + + self._rtm_arb_waveform_timer_size, \ + **kwargs) + + def set_rtm_arb_waveform_timer_size(self, val, **kwargs): + ''' + Arbitrary waveforms are written to the slow RTM DACs with time + between samples TimerSize*6.4ns. + + Args: + ----- + val (int): The value to set TimerSize to. Must be an integer + in [0,2**24). + ''' + assert (val in range(2**24)), 'reg must be in [0,16777216)' + self._caput(self.rtm_lut_ctrl + + self._rtm_arb_waveform_timer_size, \ + val, \ + **kwargs) + + _rtm_arb_waveform_max_addr = 'MaxAddr' + def get_rtm_arb_waveform_max_addr(self, **kwargs): + ''' + Slow RTM DACs will play the sequence [0...MaxAddr] of points + out of the loaded LUT tables before stopping or repeating on + software trigger (if in continuous mode). MaxAddr is an + 11-bit number (must be in [0,2048), because that's the maximum + length of the LUT tables that store the waveforms. + ''' + return self._caget(self.rtm_lut_ctrl + + self._rtm_arb_waveform_max_addr, \ + **kwargs) + + def set_rtm_arb_waveform_max_addr(self, val, **kwargs): + ''' + Slow RTM DACs will play the sequence [0...MaxAddr] of points + out of the loaded LUT tables before stopping or repeating on + software trigger (if in continuous mode). MaxAddr is an + 11-bit number (must be in [0,2048), because that's the maximum + length of the LUT tables that store the waveforms. + + Args: + ----- + val (int): The value to set MaxAddr to. Must be an integer + in [0,2048). + ''' + assert (val in range(2**11)), 'reg must be in [0,2048)' + self._caput(self.rtm_lut_ctrl + + self._rtm_arb_waveform_max_addr, \ + val, \ + **kwargs) + + _rtm_arb_waveform_enable = 'EnableCh' + def get_rtm_arb_waveform_enable(self, **kwargs): + ''' + Enable for generation of arbitrary waveforms on the RTM slow + DACs. + + EnableCh = 0x0 is disable + 0x1 is Addr[0] + 0x2 is Addr[1] + 0x3 is Addr[0] and Addr[1] + ''' + return self._caget(self.rtm_lut_ctrl + \ + self._rtm_arb_waveform_enable, \ + **kwargs) + + def set_rtm_arb_waveform_enable(self, val, **kwargs): + ''' + Sets the enable for generation of arbitrary waveforms on the + RTM slow DACs. + + Args: + ----- + val (int): The value to set enable to. + EnableCh = 0x0 is disable + 0x1 is Addr[0] + 0x2 is Addr[1] + 0x3 is Addr[0] and Addr[1] + ''' + assert (val in range(4)), 'reg must be in [0,1,2,3]' + self._caput(self.rtm_lut_ctrl + \ + self._rtm_arb_waveform_enable, \ + val, \ + **kwargs) + + ## end rtm arbitrary waveform + ######################################################### + _reset_rtm = 'resetRtm' def reset_rtm(self, **kwargs): ''' @@ -2353,173 +2622,281 @@ def get_cfg_reg_ena_bit(self, **kwargs): ''' return self._caget(self.rtm_spi_root + self._cfg_reg_ena_bit, **kwargs) - _tes_bias_enable = 'TesBiasDacCtrlRegCh[{}]' - def set_tes_bias_enable(self, daq, val, **kwargs): - """ - """ - self._caput(self.rtm_spi_max_root + self._tes_bias_enable.format(daq), - val, **kwargs) - - - def get_tes_bias_enable(self, daq, **kwargs): - """ - """ - return self._caget(self.rtm_spi_max_root + self._tes_bias.format(daq), - **kwargs) - - _tes_bias_enable_array = 'TesBiasDacCtrlRegChArray' - def set_tes_bias_enable_array(self, val, **kwargs): - """ - Set the TES bias DAC enable bits all at once + # Right now in pyrogue, this is named as if it's always a TesBias, + # but pysmurf doesn't only use them as TES biases - e.g. in + # systems using a 50K follow-on amplifier, one of these DACs is + # used to drive the amplifier gate. + _rtm_slow_dac_enable = 'TesBiasDacCtrlRegCh[{}]' + def set_rtm_slow_dac_enable(self, dac, val, **kwargs): + ''' + Set DacCtrlReg for this DAC, which configures the AD5790 + analog output for the requested DAC number. Set to 0x2 to + enable for normal operation, which only needs to be done once + for each DAC in a boot session. Args: - val (int array): length 32, addresses the DACs in DAC ordering - """ - - self._caput(self.rtm_spi_max_root + self._tes_bias_enable_array, val, - **kwargs) + ----- + dac (int) : Which DAC to command. 1-indexed. If a DAC index + outside of the valid range is provided (must be + within [1,32]), will assert. + val (int) : Value to set the DAC enable to. + ''' + assert (dac in range(1,33)),'dac must be an integer and in [1,32]' + + self._caput(self.rtm_spi_max_root + + self._rtm_slow_dac_enable.format(dac), val, **kwargs) - def get_tes_bias_enable_array(self, **kwargs): - """ - Get the TES bias DAC enable bits all at once - Returns a numpy array of size (32,) for each of the DACs + def get_rtm_slow_dac_enable(self, dac, **kwargs): """ + Returns the DacCtrlReg for this DAC, which specifies the + AD5790 analog output configuration for the requested DAC + number. Should be set to 0x2 in normal operation. - return self._caget(self.rtm_spi_max_root + self._tes_bias_enable_array, - **kwargs) + Args: + ----- + dac (int) : Which DAC to query. 1-indexed. If a DAC index + outside of the valid range is provided (must be + within [1,32]), will assert. - #_bit_to_V_50k = 2.035/float(2**19) - #_dac_num_50k = 2 - def set_50k_amp_gate_voltage(self, voltage, override=False, **kwargs): - """ + Returns: + -------- + val (int) : The DacCtrlReg setting for the requested DAC. """ - if (voltage > 0 or voltage < -1.) and not override: - self.log('Voltage must be between -1 and 0. Doing nothing.') - else: - self.set_tes_bias(self._dac_num_50k, voltage/self._bit_to_V_50k, - **kwargs) + assert (dac in range(1,33)),'dac must be an integer and in [1,32]' + + return self._caget(self.rtm_spi_max_root + + self._rtm_slow_dac_enable.format(dac), **kwargs) - def get_50k_amp_gate_voltage(self, **kwargs): - """ - """ - return self._bit_to_V_50k * self.get_tes_bias(self._dac_num_50k, **kwargs) + _rtm_slow_dac_enable_array = 'TesBiasDacCtrlRegChArray' + def set_rtm_slow_dac_enable_array(self, val, **kwargs): + ''' + Sets DacCtrlReg for all of the DACs at once. DacCtrlReg + configures the AD5790 analog outputs. Setting to 0x2 enables + normal operation, and only needs to be done once for each DAC + in a boot session. Writing the values as an array should be + much faster than writing them to each DAC individually using + the set_rtm_slow_dac_enable function (single versus multiple + transactions). - def set_50k_amp_enable(self, disable=False, **kwargs): - """ - Sets the 50K amp bit to 2 for enable and 0 for disable. + Args: + ----- + val (int array): length 32, addresses the DACs in DAC + ordering. If provided array is not length + 32, asserts. + ''' + assert (len(val)==32),'len(val) must be 32, the number of DACs in hardware.' + self._caput(self.rtm_spi_max_root + + self._rtm_slow_dac_enable_array, val, **kwargs) - Opt Args: - --------- - disable (bool) : Disable the 50K amplifier. Default False. + def get_rtm_slow_dac_enable_array(self, **kwargs): """ - if disable: - self.set_tes_bias_enable(self._dac_num_50k, 0, **kwargs) - else: - self.set_tes_bias_enable(self._dac_num_50k, 2, **kwargs) + Returns the current DacCtrlReg setting for all of the DACs at + once (a 32 element integer array). DacCtrlReg configures the + AD5790 analog outputs. If set to 0x2, then the DAC is + configured for normal operation, which only needs to be done + once for each DAC in a boot session. Reading the values as an + array should be much faster than reading them for each DAC + individually using the get_rtm_slow_dac_enable function + (single versus multiple transactions). - _tes_bias = 'TesBiasDacDataRegCh[{}]' - def set_tes_bias(self, daq, val, **kwargs): + Returns: + -------- + val (int array) : An array containing the DacCtrlReg settings + for all of the slow RTM DACs. """ - Sets the TES bias current + return self._caget(self.rtm_spi_max_root + + self._rtm_slow_dac_enable_array, **kwargs) + _rtm_slow_dac_data = 'TesBiasDacDataRegCh[{}]' + def set_rtm_slow_dac_data(self, dac, val, **kwargs): + ''' + Sets the data register for the requested DAC, which sets the + output voltage of the DAC. + Args: ----- - val (int) : the TES bias current in DAC units - """ + dac (int) : Which DAC to command. 1-indexed. If a DAC index + outside of the valid range is provided (must be + within [1,32]), will assert. + val (int) : The DAC voltage to set in DAC units. Must be in + [-2^19,2^19). If requested value is less + (greater) than -2^19 (2^19-1), sets DAC to -2^19 + (2^19-1). + ''' + assert (dac in range(1,33)),'dac must be an integer and in [1,32]' - if val > 2**19-1: - val = 2**19-1 - self.log('Bias too high. Must be <= than 2^19-1. Setting to ' + + nbits=self._rtm_slow_dac_nbits + if val > 2**(nbits-1)-1: + val = 2**(nbits-1)-1 + self.log('Bias too high. Must be <= than 2^{}-1. Setting to '.format(nbits-1) + 'max value', self.LOG_ERROR) - elif val < -2**19: - val = -2**19 - self.log('Bias too low. Must be >= than -2^19. Setting to ' + + elif val < -2**(nbits-1): + val = -2**(nbits-1) + self.log('Bias too low. Must be >= than -2^{}. Setting to '.format(nbits-1) + 'min value', self.LOG_ERROR) - self._caput(self.rtm_spi_max_root + self._tes_bias.format(daq), val, - **kwargs) - + self._caput(self.rtm_spi_max_root + + self._rtm_slow_dac_data.format(dac), val, **kwargs) - def get_tes_bias(self, daq, **kwargs): - """ - Gets the TES bias current + def get_rtm_slow_dac_data(self, dac, **kwargs): + ''' + Gets the value in the data register for the requested DAC, + which sets the output voltage of the DAC. + + Args: + ----- + dac (int) : Which DAC to command. 1-indexed. If a DAC index + outside of the valid range is provided (must be + within [1,32]), will assert. Returns: -------- - bias (int) : The TES bias current - """ - return self._caget(self.rtm_spi_max_root + self._tes_bias.format(daq), - **kwargs) + val (int) : The data register setting for the requested DAC, + in DAC units. The data register sets the output + voltage of the DAC. + ''' + assert (dac in range(1,33)),'dac must be an integer and in [1,32]' + return self._caget(self.rtm_spi_max_root + + self._rtm_slow_dac_data.format(dac), + **kwargs) - _tes_bias_array = 'TesBiasDacDataRegChArray' - def set_tes_bias_array(self, val, **kwargs): + _rtm_slow_dac_data_array = 'TesBiasDacDataRegChArray' + def set_rtm_slow_dac_data_array(self, val, **kwargs): """ - Set the TES bias DACs. Must give all 32 values. + Sets the data registers for all 32 DACs, which sets their + output voltages. Must provide all 32 values. Args: ----- - val (int array): TES biases to set for each DAC. Expects np array of size - (32,) in DAC units. + val (int array): The DAC voltages to set in DAC units. Each + element of the array must Must be in + [-2^19,2^19). If a requested value is less + (greater) than -2^19 (2^19-1), sets that DAC + to -2^19 (2^19-1). (32,) in DAC units. If + provided array is not 32 elements long, + asserts. """ + assert (len(val)==32),'len(val) must be 32, the number of DACs in hardware.' - val[np.ravel(np.where(val > 2**19-1))] = 2**19-1 - if len(np.ravel(np.where(val > 2**19-1))) > 0: - self.log('Bias too high for some values. Must be <= 2^19 -1. Setting to ' + - 'max value', self.LOG_ERROR) + nbits=self._rtm_slow_dac_nbits + val=np.array(val) + if len(np.ravel(np.where(val > 2**(nbits-1)-1))) > 0: + self.log('Bias too high for some values. Must be <= 2^{}-1. Setting to '.format(nbits-1) + + 'max value', self.LOG_ERROR) + val[np.ravel(np.where(val > 2**(nbits-1)-1))] = 2**(nbits-1)-1 + + if len(np.ravel(np.where(val < - 2**(nbits-1)))) > 0: + self.log('Bias too low for some values. Must be >= -2^{}. Setting to '.format(nbits-1) + + 'min value', self.LOG_ERROR) + val[np.ravel(np.where(val < - 2**(nbits-1)))] = -2**(nbits-1) - val[np.ravel(np.where(val < - 2**19))] = -2**19 - if len(np.ravel(np.where(val < - 2**19))) > 0: - self.log('Bias too low for some values. Must be >= -2^19. Setting to ' + - 'min value', self.LOG_ERROR) - self._caput(self.rtm_spi_max_root + self._tes_bias_array, val, **kwargs) + self._caput(self.rtm_spi_max_root + self._rtm_slow_dac_data_array, val, **kwargs) - def get_tes_bias_array(self, **kwargs): + def get_rtm_slow_dac_data_array(self, **kwargs): """ - Get the TES bias for all 32 DACs. Returns in DAC units. + Gets the value in the data register, in DAC units, for all 32 + DACs. The value in these registers set the output voltages of + the DACs. Returns: ----- - bias_array (int array): Size (32,) array of DAC values, in DAC units + array (int array): Size (32,) array of DAC values, in DAC + units. The value of these registers set + the output voltages of the DACs. """ - - return self._caget(self.rtm_spi_max_root + self._tes_bias_array, + return self._caget(self.rtm_spi_max_root + self._rtm_slow_dac_data_array, **kwargs) - _bit_to_volt = 10./2**19 - def set_tes_bias_volt(self, dac_num, val, **kwargs): - """ - """ - self.set_tes_bias(dac_num, val/self._bit_to_volt, **kwargs) + def set_rtm_slow_dac_volt(self, dac, val, **kwargs): + ''' + Sets the output voltage for the requested DAC. + + Args: + ----- + dac (int) : Which DAC to command. 1-indexed. If a DAC index + outside of the valid range is provided (must be + within [1,32]), will assert. + val (int) : The DAC voltage to set in volts. + ''' + assert (dac in range(1,33)),'dac must be an integer and in [1,32]' + self.set_rtm_slow_dac_data(dac, val/self._rtm_slow_dac_bit_to_volt, **kwargs) - def get_tes_bias_volt(self, dac_num, **kwargs): - """ - """ - return self._bit_to_volt * self.get_tes_bias(dac_num, **kwargs) + def get_rtm_slow_dac_volt(self, dac, **kwargs): + ''' + Gets the current output voltage for the requested DAC. + + Args: + ----- + dac (int) : Which DAC to query. 1-indexed. If a DAC index + outside of the valid range is provided (must be + within [1,32]), will assert. + + Returns: + -------- + val (float) : The DAC voltage in volts. + ''' + assert (dac in range(1,33)),'dac must be an integer and in [1,32]' + return self._rtm_slow_dac_bit_to_volt * self.get_rtm_slow_dac_data(dac, **kwargs) - def set_tes_bias_array_volt(self, val, **kwargs): + def set_rtm_slow_dac_volt_array(self, val, **kwargs): """ - Set TES bias DACs. Must give 32 values. Converted to volts based on - DAC full scale. + Sets the output voltage for all 32 DACs at once. Writing the + values as an array should be much faster than writing them to + each DAC individually using the set_rtm_slow_dac_volt + function (single versus multiple transactions). Args: ----- - val (float array): TES biases to set for each DAC. Expects np array - of size (32,) in volts. + val (float array): TES biases to set for each DAC in + Volts. Expects an array of size (32,). If + provided array is not 32 elements, asserts. """ - int_val = np.array(val / self._bit_to_volt, dtype=int) - - self.set_tes_bias_array(int_val, **kwargs) + assert (len(val)==32),'len(val) must be 32, the number of DACs in hardware.' + int_val = np.array(np.array(val) / self._rtm_slow_dac_bit_to_volt, dtype=int) + self.set_rtm_slow_dac_data_array(int_val, **kwargs) - def get_tes_bias_array_volt(self, **kwargs): + def get_rtm_slow_dac_volt_array(self, **kwargs): """ - Get TES bias DAC settings in volt units. + Returns the output voltage for all 32 DACs at once, in volts. + Reading the values as an array should be much faster than + reading them for each DAC individually using the + get_rtm_slow_dac_volt function (single versus multiple + transactions). Returns: ----- - bias_array (float array): Size (32,) array of DAC values in volts + volt_array (float array): Size (32,) array of DAC values in + volts. + """ + return self._rtm_slow_dac_bit_to_volt * self.get_rtm_slow_dac_data_array(**kwargs) + + def set_50k_amp_gate_voltage(self, voltage, override=False, **kwargs): + """ + """ + if (voltage > 0 or voltage < -1.) and not override: + self.log('Voltage must be between -1 and 0. Doing nothing.') + else: + self.set_rtm_slow_dac_data(self._dac_num_50k, voltage/self._bit_to_V_50k, + **kwargs) + + def get_50k_amp_gate_voltage(self, **kwargs): + """ + """ + return self._bit_to_V_50k * self.get_rtm_slow_dac_data(self._dac_num_50k, **kwargs) + + def set_50k_amp_enable(self, disable=False, **kwargs): + """ + Sets the 50K amp bit to 2 for enable and 0 for disable. + + Opt Args: + --------- + disable (bool) : Disable the 50K amplifier. Default False. """ - return self._bit_to_volt * self.get_tes_bias_array(**kwargs) + if disable: + self.set_rtm_slow_dac_enable(self._dac_num_50k, 0, **kwargs) + else: + self.set_rtm_slow_dac_enable(self._dac_num_50k, 2, **kwargs) def flux_ramp_on(self, **kwargs): ''' @@ -2875,6 +3252,34 @@ def get_fpga_vccbram(self, **kwargs): """ return self._caget(self.epics_root + self.fpga_root + self._fpga_vccbram, **kwargs) + # Regulator + _regulator_iout = "READ_IOUT" + def get_regulator_iout(self, **kwargs): + """ + Returns: + -------- + value (float): Regulator current in amperes. + """ + return self._caget(self.regulator + self._regulator_iout, **kwargs) + + _regulator_temp1 = "READ_TEMPERATURE_1" + def get_regulator_temp1(self, **kwargs): + """ + Returns: + -------- + value (float): Regulator PT temperature in C. + """ + return self._caget(self.regulator + self._regulator_temp1, **kwargs) + + _regulator_temp2 = "READ_TEMPERATURE_2" + def get_regulator_temp2(self, **kwargs): + """ + Returns: + -------- + value (float): A regulator CTRL temperature in C. + """ + return self._caget(self.regulator + self._regulator_temp2, **kwargs) + # Cryo card comands def get_cryo_card_temp(self, enable_poll=False, disable_poll=False): """ @@ -3192,6 +3597,35 @@ def set_user_config0(self, val, as_binary=False, **kwargs): self._caput(self.timing_header + self._smurf_to_gcp_stream, val, **kwargs) + def clear_unwrapping_and_averages(self, epics_poll=True, **kwargs): + """ + Resets unwrapping and averaging for all channels, in all bands. + """ + + # Set bit 0 of userConfig[0] high. Use SyncGroup to detect + # when register changes so we're sure. + user_config0_pv=self.timing_header + self._smurf_to_gcp_stream + # Toggle using SyncGroup so we can confirm state as we toggle. + sg=SyncGroup([user_config0_pv]) + + # what is it now? + sg.wait(epics_poll=epics_poll) # wait for value + uc0=sg.get_values()[user_config0_pv] + + # set bit high, keeping all other bits the same + self.set_user_config0(uc0 | (1 << 0)) + sg.wait(epics_poll=epics_poll) # wait for change + uc0=sg.get_values()[user_config0_pv] + assert ( ( uc0 >> 0) & 1 ),'Failed to set averaging/clear bit high (userConfig0=%d).'%uc0 + + # toggle bit back to low, keeping all other bits the same + self.set_user_config0(uc0 & ~(1 << 0)) + sg.wait(epics_poll=epics_poll) # wait for change + uc0=sg.get_values()[user_config0_pv] + assert ( ~( uc0 >> 0) & 1 ),'Failed to set averaging/clear bit low after setting it high (userConfig0=%d).'%(uc0) + + self.log('Successfully toggled averaging/clearing bit (userConfig[0]=%d).'%uc0, + self.LOG_USER) def set_smurf_to_gcp_stream(self, val, **kwargs): """ diff --git a/command/sync_group.py b/pysmurf/command/sync_group.py similarity index 65% rename from command/sync_group.py rename to pysmurf/command/sync_group.py index a6b353230..7b1dbd630 100644 --- a/command/sync_group.py +++ b/pysmurf/command/sync_group.py @@ -1,3 +1,19 @@ +#!/usr/bin/env python +#----------------------------------------------------------------------------- +# Title : pysmurf command module - SyncGroup class +#----------------------------------------------------------------------------- +# File : pysmurf/command/sync_group.py +# Created : 2018-09-18 +# Author : Mitch D'Ewart +#----------------------------------------------------------------------------- +# This file is part of the pysmurf software package. It is subject to +# the license terms in the LICENSE.txt file found in the top-level directory +# of this distribution and at: +# https://confluence.slac.stanford.edu/display/ppareg/LICENSE.html. +# No part of the pysmurf software package, including this file, may be +# copied, modified, propagated, or distributed except according to the terms +# contained in the LICENSE.txt file. +#----------------------------------------------------------------------------- import time import epics diff --git a/pysmurf/debug/__init__.py b/pysmurf/debug/__init__.py new file mode 100644 index 000000000..1ea248dba --- /dev/null +++ b/pysmurf/debug/__init__.py @@ -0,0 +1,12 @@ +#----------------------------------------------------------------------------- +# This file is part of the pysmurf software package. It is subject to +# the license terms in the LICENSE.txt file found in the top-level directory +# of this distribution and at: +# https://confluence.slac.stanford.edu/display/ppareg/LICENSE.html. +# No part of the pysmurf software package, including this file, may be +# copied, modified, propagated, or distributed except according to the terms +# contained in the LICENSE.txt file. +#----------------------------------------------------------------------------- +''' +init for debug dir +''' diff --git a/debug/smurf_iv.py b/pysmurf/debug/smurf_iv.py similarity index 66% rename from debug/smurf_iv.py rename to pysmurf/debug/smurf_iv.py index f7ba04932..c5575bb67 100644 --- a/debug/smurf_iv.py +++ b/pysmurf/debug/smurf_iv.py @@ -1,120 +1,38 @@ +#!/usr/bin/env python +#----------------------------------------------------------------------------- +# Title : pysmurf debug module - SmurfIVMixin class +#----------------------------------------------------------------------------- +# File : pysmurf/debug/smurf_iv.py +# Created : 2018-09-17 +#----------------------------------------------------------------------------- +# This file is part of the pysmurf software package. It is subject to +# the license terms in the LICENSE.txt file found in the top-level directory +# of this distribution and at: +# https://confluence.slac.stanford.edu/display/ppareg/LICENSE.html. +# No part of the pysmurf software package, including this file, may be +# copied, modified, propagated, or distributed except according to the terms +# contained in the LICENSE.txt file. +#----------------------------------------------------------------------------- import numpy as np from pysmurf.base import SmurfBase import time import os,sys +import matplotlib.pyplot as plt +from matplotlib.gridspec import GridSpec +import matplotlib.colors as Colors class SmurfIVMixin(SmurfBase): - def slow_iv(self, band, bias_group, wait_time=.25, bias=None, bias_high=19.9, - bias_low=0, bias_step=.1, show_plot=False, overbias_wait=5., cool_wait=30., - make_plot=True, save_plot=True, channels=None, high_current_mode=False, - rn_accept_min=1e-3, rn_accept_max=1., overbias_voltage=19.9, - gcp_mode=True, grid_on=True, phase_excursion_min=3.): - """ - >>>NOTE: DEPRECATED. USE SLOW_IV_ALL WITH A SINGLE-ELEMENT ARRAY INSTEAD.<<< - - Steps the TES bias down slowly. Starts at bias_high to bias_low with - step size bias_step. Waits wait_time between changing steps. - - Args: - ----- - band (int) : The frequency band to take the data in - bias_group (int) : The bias group to take data on. - - Opt Args: - --------- - wait_time (float): The amount of time between changing TES biases in - seconds. Default .1 sec. - bias (float array): A float array of bias values. Must go high to low. - bias_high (int): The maximum TES bias in volts. Default 19.9 - bias_low (int): The minimum TES bias in volts. Default 0 - bias_step (int): The step size in volts. Default .1 - phase_excursion_min (int): The minimum phase excursion allowable - """ - self.log("WARNING: I AM NOW DEPRICATED. USE slow_iv_all") - # Look for good channels - if channels is None: - channels = self.which_on(band) - - if overbias_voltage != 0.: - overbias = True - else: - overbias = False - - if bias is None: - bias = np.arange(bias_high, bias_low-bias_step, -bias_step) - - if overbias: - self.overbias_tes(bias_group, overbias_wait=overbias_wait, - tes_bias=np.max(bias), cool_wait=cool_wait, - high_current_mode=high_current_mode, - overbias_voltage=overbias_voltage) - - self.log('Turning lmsGain to 0.', self.LOG_USER) - lms_gain = self.get_lms_gain(band) - self.set_lms_gain(band, 0) - - self.log('Starting to take IV.', self.LOG_USER) - self.log('Starting TES bias ramp.', self.LOG_USER) - - self.set_tes_bias_bipolar(bias_group, bias[0]) - time.sleep(1) - - datafile = self.stream_data_on(gcp_mode=gcp_mode) - self.log('writing to {}'.format(datafile)) - - for b in bias: - self.log('Bias at {:4.3f}'.format(b)) - #sys.stdout.write('\rBias at {:4.3f} V\033[K'.format(b)) - #sys.stdout.flush() - self.set_tes_bias_bipolar(bias_group, b) - time.sleep(wait_time) - #sys.stdout.write('\n') - - self.stream_data_off(gcp_mode=gcp_mode) - - self.log('Done with TES bias ramp', self.LOG_USER) - - self.log('Returning lmsGain to ' + str(lms_gain), self.LOG_USER) - self.set_lms_gain(band, lms_gain) - - #self.set_cryo_card_relays(2**16) - - - - basename, _ = os.path.splitext(os.path.basename(datafile)) - np.save(os.path.join(self.output_dir, basename + '_iv_bias'), bias) - - iv_raw_data = {} - iv_raw_data['bias'] = bias - iv_raw_data['band'] = band - iv_raw_data['bias group'] = bias_group - iv_raw_data['channels'] = channels - iv_raw_data['datafile'] = datafile - iv_raw_data['basename'] = basename - iv_raw_data['output_dir'] = self.output_dir - iv_raw_data['plot_dir'] = self.plot_dir - fn_iv_raw_data = os.path.join(self.output_dir, basename + - '_iv_raw_data.npy') - np.save(os.path.join(self.output_dir, fn_iv_raw_data), iv_raw_data) - - R_sh=self.R_sh - self.analyze_slow_iv_from_file(fn_iv_raw_data, make_plot=make_plot, - show_plot=show_plot, save_plot=save_plot, R_sh=R_sh, - high_current_mode=high_current_mode, rn_accept_min=rn_accept_min, - rn_accept_max=rn_accept_max, gcp_mode=gcp_mode,grid_on=grid_on, - phase_excursion_min=phase_excursion_min) - def slow_iv_all(self, bias_groups=None, wait_time=.1, bias=None, - bias_high=1.5, gcp_mode=True, bias_low=0, bias_step=.005, - show_plot=False, overbias_wait=2., cool_wait=30, - make_plot=True, save_plot=True, channels=None, band=None, - high_current_mode=True, overbias_voltage=8., - grid_on=True, phase_excursion_min=3.): + bias_high=1.5, gcp_mode=True, bias_low=0, bias_step=.005, + show_plot=False, overbias_wait=2., cool_wait=30, make_plot=True, + save_plot=True, channels=None, band=None, high_current_mode=True, + overbias_voltage=8., grid_on=True, phase_excursion_min=3.): """ Steps the TES bias down slowly. Starts at bias_high to bias_low with step size bias_step. Waits wait_time between changing steps. + If this analyzes the data, the outputs are stored to output_dir. Opt Args: --------- @@ -126,7 +44,24 @@ def slow_iv_all(self, bias_groups=None, wait_time=.1, bias=None, bias_high (int): The maximum TES bias in volts. Default 19.9 bias_low (int): The minimum TES bias in volts. Default 0 bias_step (int): The step size in volts. Default .1 + overbias_wait (float) : The time to stay in the overbiased state in + seconds. The default is 2 sec. + cool_wait (float) : The time to stay in the low current state after + overbiasing before taking the IV. + make_plot (bool) : Whether to make plots. Default True + save_plot (bool) : Whether to save the plot. Default True. + channels (int array) : A list of channels to make plots + band (int array) : The bands to analyze + high_current_mode (bool) : The current mode to take the IV in. + overbias_voltage (float) : The voltage to set the TES bias in the + overbias stage. + grid_on (bool) : Grids on plotting. This is Aris fault. + phase_excursion_min (float) : The minimum phase excursion required for + making plots. """ + + n_bias_groups = self._n_bias_groups + if bias_groups is None: bias_groups = self.all_groups @@ -136,33 +71,32 @@ def slow_iv_all(self, bias_groups=None, wait_time=.1, bias=None, overbias = False if bias is None: + # Set actual bias levels bias = np.arange(bias_high, bias_low-bias_step, -bias_step) + # Overbias the TESs to drive them normal if overbias: self.overbias_tes_all(bias_groups=bias_groups, overbias_wait=overbias_wait, tes_bias=np.max(bias), cool_wait=cool_wait, high_current_mode=high_current_mode, overbias_voltage=overbias_voltage) - self.log('Turning lmsGain to 0.', self.LOG_USER) - lms_gain2 = self.get_lms_gain(2) # just do this on both bands - lms_gain3 = self.get_lms_gain(3) # should fix the hardcoding though -CY - self.set_lms_gain(2, 0) - self.set_lms_gain(3, 0) - - self.log('Starting to take IV.', self.LOG_USER) - self.log('Starting TES bias ramp.', self.LOG_USER) - + #self.log('Turning lmsGain to 0.', self.LOG_USER) + #lms_gain2 = self.get_lms_gain(2) # just do this on both bands + #lms_gain3 = self.get_lms_gain(3) # should fix the hardcoding though -CY + #self.set_lms_gain(2, 0) + #self.set_lms_gain(3, 0) self.log('Starting to take IV.', self.LOG_USER) self.log('Starting TES bias ramp.', self.LOG_USER) - bias_group_bool = np.zeros((8,)) # hard coded to have 8 bias groups + bias_group_bool = np.zeros((n_bias_groups,)) # hard coded to have 8 bias groups bias_group_bool[bias_groups] = 1 # only set things on the bias groups that are on self.set_tes_bias_bipolar_array(bias[0] * bias_group_bool) time.sleep(wait_time) # loops are in pyrogue now, which are faster? + # Stream the data datafile = self.stream_data_on(gcp_mode=gcp_mode) self.log('writing to {}'.format(datafile)) @@ -174,12 +108,16 @@ def slow_iv_all(self, bias_groups=None, wait_time=.1, bias=None, self.stream_data_off(gcp_mode=gcp_mode) self.log('Done with TES bias ramp', self.LOG_USER) - self.log('Returning lmsGain to original values', self.LOG_USER) - self.set_lms_gain(2, lms_gain2) - self.set_lms_gain(3, lms_gain3) + #self.log('Returning lmsGain to original values', self.LOG_USER) + #self.set_lms_gain(2, lms_gain2) + #self.set_lms_gain(3, lms_gain3) basename, _ = os.path.splitext(os.path.basename(datafile)) - np.save(os.path.join(self.output_dir, basename + '_iv_bias_all'), bias) + path = os.path.join(self.output_dir, basename + '_iv_bias_all') + np.save(path, bias) + + # publisher announcement + self.pub.register_file(path, 'iv_bias', format='npy') iv_raw_data = {} iv_raw_data['bias'] = bias @@ -192,18 +130,22 @@ def slow_iv_all(self, bias_groups=None, wait_time=.1, bias=None, fn_iv_raw_data = os.path.join(self.output_dir, basename + '_iv_raw_data.npy') self.log('Writing IV metadata to {}.'.format(fn_iv_raw_data)) - np.save(os.path.join(self.output_dir, fn_iv_raw_data), iv_raw_data) + + path = os.path.join(self.output_dir, fn_iv_raw_data) + np.save(path, iv_raw_data) + self.pub.register_file(path, 'iv_raw', format='npy') R_sh=self.R_sh self.analyze_slow_iv_from_file(fn_iv_raw_data, make_plot=make_plot, show_plot=show_plot, save_plot=save_plot, R_sh=R_sh, - gcp_mode=gcp_mode, grid_on=grid_on, - phase_excursion_min=phase_excursion_min,chs=channels,band=band) + gcp_mode=gcp_mode, grid_on=grid_on, + phase_excursion_min=phase_excursion_min, chs=channels, band=band) + def partial_load_curve_all(self, bias_high_array, bias_low_array=None, - wait_time=0.1, bias_step=0.1, gcp_mode=True, show_plot=False, analyze=True, - make_plot=True, save_plot=True, channels=None, overbias_voltage=None, - overbias_wait=1.0, phase_excursion_min=1.): + wait_time=0.1, bias_step=0.1, gcp_mode=True, show_plot=False, + analyze=True, make_plot=True, save_plot=True, channels=None, + overbias_voltage=None, overbias_wait=1.0, phase_excursion_min=1.): """ Take a partial load curve on all bias groups. Function will step up to bias_high value, then step down. Will NOT change TES bias @@ -213,14 +155,15 @@ def partial_load_curve_all(self, bias_high_array, bias_low_array=None, Args: ----- - bias_high_array (float array): (8,) array of voltage biases, in + bias_high_array (float array): (n_bias_groups,) array of voltage biases, in bias group order Opt Args: ----- - bias_low_array (float array): (8,) array of voltage biases, in + bias_low_array (float array): (n_bias_groups,) array of voltage biases, in bias group order. Defaults to whatever is currently set - wait_time (float): Time to wait at each commanded bias value. Default 0.1 + wait_time (float): Time to wait at each commanded bias value. + Default 0.1 bias_step (float): Interval size to step the commanded voltage bias. Default 0.1 gcp_mode (bool): whether to stream data in GCP mode. Default True. @@ -292,7 +235,10 @@ def partial_load_curve_all(self, bias_high_array, bias_low_array=None, # save and analyze basename, _ = os.path.splitext(os.path.basename(datafile)) - np.save(os.path.join(self.output_dir, basename + '_plc_bias_all'), bias_sweep_array) + + path = os.path.join(self.output_dir, basename + '_plc_bias_all') + np.save(path, bias_sweep_array) + self.pub.register_file(path, 'plc_bias', format='npy') plc_raw_data = {} plc_raw_data['bias'] = bias_sweep_array @@ -303,7 +249,10 @@ def partial_load_curve_all(self, bias_high_array, bias_low_array=None, plc_raw_data['plot_dir'] = self.plot_dir fn_plc_raw_data = os.path.join(self.output_dir, basename + '_plc_raw_data.npy') - np.save(os.path.join(self.output_dir, fn_plc_raw_data), plc_raw_data) + + path = os.path.join(self.output_dir, fn_plc_raw_data) + np.save(path, plc_raw_data) + self.pub.register_file(path, 'plc_raw', format='npy') if analyze: self.analyze_plc_from_file(fn_plc_raw_data, make_plot=make_plot, @@ -311,19 +260,20 @@ def partial_load_curve_all(self, bias_high_array, bias_low_array=None, high_current_mode=self.high_current_mode_bool, gcp_mode=gcp_mode, phase_excursion_min=phase_excursion_min, channels=channels) + def analyze_slow_iv_from_file(self, fn_iv_raw_data, make_plot=True, - show_plot=False, save_plot=True, R_sh=None, - phase_excursion_min=3., grid_on=False, - gcp_mode=True, R_op_target=0.007, - chs=None, band=None): + show_plot=False, save_plot=True, R_sh=None, phase_excursion_min=3., + grid_on=False, gcp_mode=True, R_op_target=0.007, chs=None, band=None): """ Function to analyze a load curve from its raw file. Can be used to analyze IV's/generate plots separately from issuing commands. Args: + ----- fn_iv_raw_data (str): *_iv_raw_data.npy file to analyze Opt Args: + --------- make_plot (bool): Defaults True. Usually this is the slowest part. show_plot (bool): Defaults False. save_plot (bool): Defaults True. @@ -372,10 +322,10 @@ def analyze_slow_iv_from_file(self, fn_iv_raw_data, make_plot=True, v_tes_target_list = [] for c, (b, ch) in enumerate(zip(bands,chans)): if (chs is not None) and (ch not in chs): - self.log('Not in desired channel list: skipping band {} ch. {}'.format(b,ch)) + self.log(f'Not in desired channel list: skipping band {b} ch {ch}') continue elif (band is not None) and (b != band): - self.log('Not in desired band: skipping band {} ch. {}'.format(b,ch)) + self.log(f'Not in desired band: skipping band {b} ch. {ch}') continue self.log('Analyzing band {} channel {}'.format(b,ch)) @@ -392,7 +342,6 @@ def analyze_slow_iv_from_file(self, fn_iv_raw_data, make_plot=True, phase_excursion_list.append(phase_excursion) if make_plot: - import matplotlib.pyplot as plt plt.rcParams["patch.force_edgecolor"] = True if not show_plot: @@ -418,8 +367,9 @@ def analyze_slow_iv_from_file(self, fn_iv_raw_data, make_plot=True, plot_name = basename + \ '_IV_stream_b{}_g{}_ch{:03}.png'.format(b, bg_str, ch) if save_plot: - plt.savefig(os.path.join(plot_dir, plot_name), - bbox_inches='tight', dpi=300) + plot_fn = os.path.join(plot_dir, plot_name) + plt.savefig(plot_fn, bbox_inches='tight', dpi=300) + self.pub.register_file(plot_fn, 'iv_stream', plot=True) if not show_plot: plt.close() @@ -455,7 +405,10 @@ def analyze_slow_iv_from_file(self, fn_iv_raw_data, make_plot=True, fn_iv_analyzed = basename + '_iv' self.log('Writing analyzed IV data to {}.'.format(fn_iv_analyzed)) - np.save(os.path.join(output_dir, fn_iv_analyzed), ivs) + + path = os.path.join(output_dir, fn_iv_analyzed) + np.save(path, ivs) + self.pub.register_file(path, 'iv', format='npy') v_bias_target_median = np.median(v_bias_target_list) rn_median = np.median(rn_list) @@ -467,9 +420,6 @@ def analyze_slow_iv_from_file(self, fn_iv_raw_data, make_plot=True, if len(phase_excursion_list) == 0: self.log('phase excursion list length 0') elif make_plot: - import matplotlib.pyplot as plt - from matplotlib.gridspec import GridSpec - import matplotlib.colors as Colors colors = [] tableau = Colors.TABLEAU_COLORS for c in tableau: @@ -513,23 +463,28 @@ def analyze_slow_iv_from_file(self, fn_iv_raw_data, make_plot=True, ax_si.hist(si_target_list,bins=20) ax_si.axvline(si_target_median,linestyle='--',color=color_median,\ label='Median = {:.2f}'.format(si_target_median)\ - + ' $\mu\mathrm{V}^{-1}$') + + r' $\mu\mathrm{V}^{-1}$') ax_si.axvline(si_goal,linestyle='--',color=color_goal,\ label=r'$-\mathrm{med}(V_\mathrm{TES})^{-1} = $'+\ '{:.2f}'.format(si_goal) + \ - ' $\mu\mathrm{V}^{-1}$') - ax_si.set_xlabel('Responsivity [$\mu\mathrm{V}^{-1}$] at $R = $'+\ + r' $\mu\mathrm{V}^{-1}$') + ax_si.set_xlabel(r'Responsivity [$\mu\mathrm{V}^{-1}$] at $R = $'+\ '{:.0f}'.format(R_op_target/1e-3) + \ - ' $\mathrm{m}\Omega$') + r' $\mathrm{m}\Omega$') plt.legend(loc='best') plt.tight_layout() fig.subplots_adjust(top=0.925) + + # Title plt.suptitle('{}, band {}, group{}'.format(basename,\ np.unique(band),bias_group)) - iv_hist_filename = os.path.join(plot_dir,\ - '%s_IV_hist.png' % (basename)) + iv_hist_filename = os.path.join(plot_dir, f'{basename}_IV_hist.png') + + # Save the figure plt.savefig(iv_hist_filename,bbox_inches='tight') + self.pub.register_file(iv_hist_filename, 'iv_hist', plot=True) + self.log('Saved IV histogram to {}'.format(iv_hist_filename)) if not show_plot: plt.close() @@ -568,12 +523,12 @@ def analyze_slow_iv(self, v_bias, resp, make_plot=True, show_plot=False, r_inline = self.bias_line_resistance if high_current_mode: - # high-current mode generates higher current by decreases the in-line resistance + # high-current mode generates higher current by decreases the + # in-line resistance r_inline /= self.high_low_current_ratio i_bias = 1.0E6 * v_bias / r_inline if make_plot: - import matplotlib.pyplot as plt if show_plot: plt.ion() else: @@ -619,7 +574,14 @@ def analyze_slow_iv(self, v_bias, resp, make_plot=True, show_plot=False, resp_bin -= norm_fit[1] # now in real current units sc_fit = np.polyfit(i_bias[:sc_idx], resp_bin[:sc_idx], 1) - resp_bin[:sc_idx] -= sc_fit[1] # subtract off unphysical y-offset in superconducting branch; this is probably due to an undetected phase wrap at the kink between the superconducting branch and the transition, so it is *probably* legitimate to remove it by hand. We don't use the offset of the superconducting branch for anything meaningful anyway. This will just make our plots look nicer. + + # subtract off unphysical y-offset in superconducting branch; this is + # probably due to an undetected phase wrap at the kink between the + # superconducting branch and the transition, so it is *probably* + # legitimate to remove it by hand. We don't use the offset of the + # superconducting branch for anything meaningful anyway. This will just + # make our plots look nicer. + resp_bin[:sc_idx] -= sc_fit[1] sc_fit[1] = 0 # now change s.c. fit offset to 0 for plotting R = R_sh * (i_bias/(resp_bin) - 1) @@ -647,10 +609,14 @@ def analyze_slow_iv(self, v_bias, resp, make_plot=True, show_plot=False, i_tes = resp_bin smooth_dist = 5 w_len = 2*smooth_dist + 1 + + # Running average w = (1./float(w_len))*np.ones(w_len) # window - i_tes_smooth = np.convolve(i_tes,w,mode='same') - v_tes_smooth = np.convolve(v_tes,w,mode='same') + i_tes_smooth = np.convolve(i_tes, w, mode='same') + v_tes_smooth = np.convolve(v_tes, w, mode='same') r_tes_smooth = v_tes_smooth/i_tes_smooth + + # Take derivatives di_tes = np.diff(i_tes_smooth) dv_tes = np.diff(v_tes_smooth) R_L_smooth = np.ones(len(r_tes_smooth))*R_L @@ -661,22 +627,16 @@ def analyze_slow_iv(self, v_bias, resp, make_plot=True, show_plot=False, rL = R_L_smooth[:-1] si_etf = -1./(i0*r0) beta = 0. + + # Responsivity estimate si = -(1./i0)*( dv_tes/di_tes - (r0+rL+beta*r0) ) / \ ( (2.*r0-rL+beta*r0)*dv_tes/di_tes - 3.*rL*r0 - rL**2 ) - ''' - plt.figure() - plt.plot(i_bias[:-1],rL) - plt.plot(i_bias[:-1],R_L*np.ones(len(rL))) - plt.plot(i_bias[:-1],r0) - plt.show() - ''' + if i_R_op == len(si): i_R_op -= 1 si_target = si[i_R_op] if make_plot: - from matplotlib.gridspec import GridSpec - import matplotlib.colors as Colors colors = [] tableau = Colors.TABLEAU_COLORS for c in tableau: @@ -706,7 +666,7 @@ def analyze_slow_iv(self, v_bias, resp, make_plot=True, show_plot=False, if band is not None and channel is not None: title += ', {:.2f} MHz'.format(self.channel_to_freq(band, channel)) title += r', $R_\mathrm{sh}$ = ' + '${:.2f}$ '.format(R_sh*1.0E3) + \ - '$\mathrm{m}\Omega$' + r'$\mathrm{m}\Omega$' plot_name = basename + '_' + plot_name title = basename + ' ' + title plot_name += '.png' @@ -729,14 +689,14 @@ def analyze_slow_iv(self, v_bias, resp, make_plot=True, show_plot=False, r' $\mathrm{m}\Omega$') ax_ii.plot(i_bias[:sc_idx], sc_fit[0] * i_bias[:sc_idx] + sc_fit[1], linestyle='--', - color=color_sc,label=r'$R_L$' + \ - ' = ${:.0f}$'.format(R_L/1e-6) + \ - r' $\mu\mathrm{\Omega}$') + color=color_sc, label=r'$R_L$' + \ + ' = ${:.0f}$'.format(R_L/1e-6) + \ + r' $\mu\mathrm{\Omega}$') label_target = r'$R = {:.0f}$ '.format(R_op_target/1e-3)+\ - r'$\mathrm{m}\Omega$' + r'$\mathrm{m}\Omega$' label_rfrac = '{:.2f}-{:.2f}'.format(R_frac_min,\ - R_frac_max) + r'$R_N$' + R_frac_max) + r'$R_N$' for i in range(len(ax_i)): if ax_i[i] == ax_ri: @@ -745,22 +705,22 @@ def analyze_slow_iv(self, v_bias, resp, make_plot=True, show_plot=False, else: label_vline = None label_vspan = None - ax_i[i].axvline(i_op_target,color='g',linestyle='--', - label=label_vline) + ax_i[i].axvline(i_op_target, color='g', linestyle='--', + label=label_vline) ax_i[i].axvspan(i_bias[sc_idx], i_bias[nb_idx], - color=color_etf, alpha=.15,label=label_vspan) + color=color_etf, alpha=.15,label=label_vspan) if grid_on: ax_i[i].grid() - ax_i[i].set_xlim(min(i_bias),max(i_bias)) + ax_i[i].set_xlim(min(i_bias), max(i_bias)) if i != len(ax_i)-1: ax_i[i].set_xticklabels([]) - ax_si.axhline(0.,color=color_norm,linestyle='--') + ax_si.axhline(0., color=color_norm, linestyle='--') ax_ii.legend(loc='best') ax_ri.legend(loc='best') ax_ri.plot(i_bias, R/R_n, color=color_meas) ax_pr.plot(p_tes,R/R_n, color=color_meas) - for ax in [ax_ri,ax_pr]: + for ax in [ax_ri, ax_pr]: ax.axhline(1, color=color_norm, linestyle='--') ax_ri.set_ylabel(r'$R/R_N$') ax_i[-1].set_xlabel(r'$I_{b}$ [$\mu\mathrm{A}$]') @@ -788,7 +748,7 @@ def analyze_slow_iv(self, v_bias, resp, make_plot=True, show_plot=False, ax_si.plot(i_bias[:-1],si,color=color_meas) ax_si.plot(i_bias[:-1],si_etf,linestyle = '--', - label=r'$-1/V_\mathrm{TES}$',color=color_etf) + label=r'$-1/V_\mathrm{TES}$',color=color_etf) ax_si.set_ylabel(r'$S_I$ [$\mu\mathrm{V}^{-1}$]') ax_si.set_ylim(-2./v_tes_target,2./v_tes_target) ax_si.legend(loc='upper right') @@ -796,12 +756,12 @@ def analyze_slow_iv(self, v_bias, resp, make_plot=True, show_plot=False, ax_pr.set_xlabel(r'$P_\mathrm{TES}$ [pW]') ax_pr.set_xscale('log') ax_pr.axhspan(R_trans_min/R_n,R_trans_max/R_n,color=color_etf, - alpha=.15) - label_pr = r'%.1f pW' % (p_trans_median) + alpha=.15) + label_pr = f'{p_trans_median:.1f} pW' ax_pr.axvline(p_trans_median, linestyle='--', label=label_pr, - color=color_etf) + color=color_etf) ax_pr.plot(p_tes[i_R_op],R[i_R_op]/R_n,'o',color=color_target, - label=label_target) + label=label_target) ax_pr.legend(loc='best') if grid_on: ax_pr.grid() @@ -814,6 +774,8 @@ def analyze_slow_iv(self, v_bias, resp, make_plot=True, show_plot=False, plot_filename = os.path.join(plot_dir, plot_name) self.log('Saving IV plot to {}'.format(plot_filename)) plt.savefig(plot_filename,bbox_inches='tight') + self.pub.register_file(plot_filename, 'iv', plot=True) + if show_plot: plt.show() else: @@ -834,12 +796,14 @@ def analyze_slow_iv(self, v_bias, resp, make_plot=True, show_plot=False, return iv_dict - def analyze_plc_from_file(self, fn_plc_raw_data, make_plot=True, show_plot=False, - save_plot=True, R_sh=None, high_current_mode=None, phase_excursion_min=1., - gcp_mode=True, channels=None): + + def analyze_plc_from_file(self, fn_plc_raw_data, make_plot=True, + show_plot=False, save_plot=True, R_sh=None, high_current_mode=None, + phase_excursion_min=1., gcp_mode=True, channels=None): """ - Function to analyze a partial load curve from its raw file. Basically the same - as the slow_iv analysis but without fitting the superconducting branch. + Function to analyze a partial load curve from its raw file. Basically + the same as the slow_iv analysis but without fitting the superconducting + branch. Args: ----- @@ -901,7 +865,6 @@ def analyze_plc_from_file(self, fn_plc_raw_data, make_plot=True, show_plot=False # would work once we had a permanent lookup table of ch to bias group... if make_plot: # make the timestream plot - import matplotlib.pyplot as plt plt.rcParams["patch.force_edgecolor"] = True if not show_plot: @@ -923,209 +886,13 @@ def analyze_plc_from_file(self, fn_plc_raw_data, make_plot=True, show_plot=False plot_name = basename + \ 'plc_stream_b{}_g{}_ch{:03}.png'.format(b, bg_str, ch) - plt.savefig(of.path.join(plot_dir, plt_name), bbox_inches='tight', - dpi=300) + path = os.path.join(plot_dir, plot_name) + plt.savefig(path, bbox_inches='tight', dpi=300) + self.pub.register_file(path, 'plc_stream', plot=True) if not show_plot: plt.close() - - def find_bias_groups(self, make_plot=False, show_plot=False, - save_plot=True, min_gap=.5): - """ - Loops through all the bias groups and ramps the TES bias. - It takes full_band resp at each TES bias and looks for - frequency swings. Using this data, it attempts to assign - channels to bias groups. - - Opt Args: - -------- - make_plot (bool): Whether to make plots. - show_plot (bool): If make_plot is True, whether to show - the plot. - save_plot (bool): If make_plot is True, whether to save - the plot. - min_gap (float): The minimum allowable gap. - """ - self.log('This is specific for the Keck K2 umux FPU.') - self.log('Working on band 2 first') - tes_freq = {} - for bg in np.arange(4): - # The frequency of TESs in MHz - tes_freq[bg] = self.find_tes(2, bg, make_plot=make_plot) + \ - self.get_band_center_mhz(2) - - good_tes = {} - - # Anything we see in BG 0 is noise. - bad_res = tes_freq[0] - - for bg in np.arange(1,4): - good_tes[bg] = np.array([]) - - # Find resonators too close to known bad resonators - for r in tes_freq[bg]: - if np.min(np.abs(bad_res - r)) > min_gap: - good_tes[bg] = np.append(good_tes[bg], r) - - ca_freq, ca_sb, ca_ch, ca_bg = self.get_master_assignment(2) - - for bg in np.arange(1,4): - for tes in good_tes[bg]: - nearest = np.min(np.abs(ca_freq - tes)) - print(nearest) - if nearest < min_gap: - idx = np.where(np.abs(ca_freq-tes) == nearest) - ca_bg[idx] = bg - - self.write_master_assignment(2, ca_freq, ca_sb, ca_ch, - groups=ca_bg) - - self.log('Working on band 3') - for bg in np.arange(4,8): - # The frequency of TESs in MHz - tes_freq[bg] = self.find_tes(3, bg, make_plot=make_plot) + \ - self.get_band_center_mhz(3) - - # Anything we see in BG 6 is noise. - bad_res = tes_freq[6] - - for bg in np.array([4,5,7]): - good_tes[bg] = np.array([]) - - # Find resonators too close to known bad resonators - for r in tes_freq[bg]: - if np.min(np.abs(bad_res - r)) > min_gap: - good_tes[bg] = np.append(good_tes[bg], r) - - ca_freq, ca_sb, ca_ch, ca_bg = self.get_master_assignment(3) - - for bg in np.array([4,5,7]): - for tes in good_tes[bg]: - nearest = np.min(np.abs(ca_freq - tes)) - if nearest < min_gap: - idx = np.where(np.abs(ca_freq-tes) == nearest) - ca_bg[idx] = bg - - self.write_master_assignment(3, ca_freq, ca_sb, ca_ch, - groups=ca_bg) - - #for k in good_tes.keys(): - # self.log('{} TESs in BG {}'.format(len(good_tes[k], k))) - - return good_tes - - - def find_tes(self, band, bias_group, bias=np.arange(0,2.5,.4), - make_plot=False, show_plot=False, save_plot=True, - make_debug_plot=False, delta_peak_cutoff=.2): - """ - This changes the bias on the bias groups and attempts to find - resonators. - - Args: - ----- - band (int) : The band to search. - bias_group (int): The bias group to search - - Opt Args: - --------- - bias (float array) : The TES biases in volts to set to look - for TESs. - make_plot (bool) : Whether to make a summary plot. Default True. - make_debug_plot (bool) : Whether to make debugging plots. - Default is False. - delta_peak_cutoff (float) : The minimum a TES must move in MHz. - Default is 0.2. - - - Ret: - ---- - res_freq (float array) : The frequency of the resonators that - have TESs. - """ - if make_plot: - import matplotlib.pyplot as plt - - self.flux_ramp_off() - - f, d = self.full_band_resp(band) - f *= 1.0E-6 # convert freq to MHz - - ds = np.zeros((len(bias), len(d)), dtype=complex) - - # Find resonators at different TES biases - for i, b in enumerate(bias): - self.set_tes_bias_bipolar(bias_group, b, wait_after=.1) - _, ds[i] = self.full_band_resp(band) - - # Find resonator peaks - peaks = self.find_peak(f, ds[0], rolling_med=True, window=2500, pad=50, - min_gap=50) - - # Difference from zero bias - delta_ds = ds[1:] - ds[0] - - # The delta_ds at resonances - delta_ds_peaks = np.zeros((len(peaks), len(bias)-1)) - for i, p in enumerate(peaks): - idx = np.where(f == p)[0][0] - delta_ds_peaks[i] = np.abs(delta_ds[:,idx]) - if make_debug_plot: - n_lines = 8 - if i % n_lines == 0: - plt.figure() - plt.plot(bias[1:], delta_ds_peaks[i], - label='{:6.5f}'.format(f[idx]*1.0E-6)) - if i % n_lines == n_lines-1: - plt.legend() - plt.xlabel('Bias [V]') - plt.ylabel('Res Amp') - - peak_span = np.max(delta_ds_peaks, axis=1) - \ - np.min(delta_ds_peaks, axis=1) - - - if make_plot: - if show_plot: - plt.ion() - else: - plt.ioff() - fig, ax = plt.subplots(2, sharex=True) - cm = plt.get_cmap('viridis') - - for i, b in enumerate(bias): - color = cm(i/len(bias)) - ax[0].plot(f, np.abs(ds[i]), color=color, - label='{:3.2f}'.format(b)) - ax[0].legend() - - ax[1].plot(peaks, peak_span, '.') - - ax[1].axhline(delta_peak_cutoff, color='k', linestyle=':') - fig.suptitle('band {} BG {}'.format(band, bias_group)) - ax[1].set_xlabel('Freq [MHz]') - - ax[0].axvspan(-250, -125, color='k', alpha=.1) - ax[1].axvspan(-250, -125, color='k', alpha=.1) - ax[0].axvspan(0, 125, color='k', alpha=.1) - ax[1].axvspan(0, 125, color='k', alpha=.1) - - - if save_plot: - timestamp = self.get_timestamp() - plt.savefig(os.path.join(self.plot_dir, - '{}_find_tes.png'.format(timestamp)), - bbox_inches='tight') - if show_plot: - plt.show() - else: - plt.close() - - idx = np.ravel(np.where(peak_span > delta_peak_cutoff)) - return peaks[idx] - - def estimate_opt_eff(self, iv_fn_hot, iv_fn_cold,t_hot=293.,t_cold=77., channels = None, dPdT_lim=(0.,0.5)): """ @@ -1164,7 +931,6 @@ def estimate_opt_eff(self, iv_fn_hot, iv_fn_cold,t_hot=293.,t_cold=77., assert ivs_raw_cold['bias group'], \ 'Files must contain IVs from the same bias group' - import matplotlib.pyplot as plt plot_dir = self.plot_dir dT = t_hot - t_cold @@ -1187,10 +953,10 @@ def estimate_opt_eff(self, iv_fn_hot, iv_fn_cold,t_hot=293.,t_cold=77., Ptrans_hot = ivs_hot[ch]['Ptrans'] Ptrans_cold = ivs_cold[ch]['Ptrans'] if Ptrans_hot is None or Ptrans_cold is None: - print('Missing in-transition electrical powers for Ch. %i' % (ch)) + print(f'Missing in-transition electrical powers for Ch. {ch}') continue dPdT = (Ptrans_cold - Ptrans_hot)/dT - self.log('Group {}, Ch {:03}: dP/dT = {:.3f} pW/K'.format(group, ch, dPdT)) + self.log(f'Group {group}, Ch {ch:03}: dP/dT = {dPdT:.3f} pW/K') if dPdT_lim is not None: if dPdT >= dPdT_lim[0] and dPdT <= dPdT_lim[1]: dPdT_list.append(dPdT) @@ -1199,23 +965,32 @@ def estimate_opt_eff(self, iv_fn_hot, iv_fn_cold,t_hot=293.,t_cold=77., else: dPdT_list.append(dPdT) - fig_pr,ax_pr = plt.subplots(1,sharex=True) + # Make figure + fig_pr,ax_pr = plt.subplots(1, sharex=True) + + # Labels ax_pr.set_xlabel(r'$R_\mathrm{TES}$ [$\Omega$]') ax_pr.set_ylabel(r'$P_\mathrm{TES}$ [pW]') - label_hot = '%s: %.0f K' % (basename_hot,t_hot) - label_cold = '%s: %.0f K' % (basename_cold,t_cold) - ax_pr.axhline(y=Ptrans_hot,linestyle = '--',color = 'b') - ax_pr.axhline(y=Ptrans_cold,linestyle = '--',color = 'r') + label_hot = f'{basename_hot}: {t_hot:.0f} K' + label_cold = f'{basename_cold}: {t_cold:.0f} K' + ax_pr.axhline(y=Ptrans_hot, linestyle='--', color='b') + ax_pr.axhline(y=Ptrans_cold, linestyle='--', color='r') + + # Plot data ax_pr.plot(R_hot,P_hot,label=label_hot,color='b') ax_pr.plot(R_cold,P_cold,label=label_cold,color='r') ax_pr.legend(loc='best') - fig_pr.suptitle('Group {}, Ch {:03}: dP/dT = {:.3f} pW/K'.format(group, ch, dPdT)) + fig_pr.suptitle(f'Group {group}, Ch {ch:03}: dP/dT = {dPdT:.3f} pW/K') ax_pr.grid() - plot_name = basename_hot + '_' + basename_cold + '_optEff_g{}_ch{:03}.png'.format(group, ch) + # Plot name + plot_name = basename_hot + '_' + basename_cold + f'_optEff_g{group}_ch{ch:03}.png' plot_filename = os.path.join(plot_dir, plot_name) self.log('Saving optical-efficiency plot to {}'.format(plot_filename)) - plt.savefig(plot_filename,bbox_inches='tight', dpi=300) + plt.savefig(plot_filename, bbox_inches='tight', dpi=300) + + # Publish + self.pub.register_file(plot_filename, 'opt_efficiency', plot=True) plt.close() plt.figure() @@ -1223,11 +998,13 @@ def estimate_opt_eff(self, iv_fn_hot, iv_fn_cold,t_hot=293.,t_cold=77., plt.xlabel('dP/dT [pW/K]') plt.grid() dPdT_median = np.median(dPdT_list) - plt.title('Group {}, median = {:.3f} pW/K ({} outliers not plotted)'.format(group,dPdT_median,n_outliers)) + plt.title(f'Group {group}, median = {dPdT_median:.3f} pW/K '+ + f'({n_outliers} outliers not plotted)') plot_name = basename_hot + '_' + basename_cold + '_dPdT_hist_g{}.png'.format(group) hist_filename = os.path.join(plot_dir,plot_name) self.log('Saving optical-efficiency histogram to {}'.format(hist_filename)) - plt.savefig(hist_filename,bbox_inches='tight',dpi=300) + plt.savefig(hist_filename, bbox_inches='tight', dpi=300) + self.pub.register_file(hist_filename, 'opt_efficiency', plot=True) plt.close() diff --git a/debug/smurf_noise.py b/pysmurf/debug/smurf_noise.py similarity index 88% rename from debug/smurf_noise.py rename to pysmurf/debug/smurf_noise.py index 93624a875..3674bd5d4 100644 --- a/debug/smurf_noise.py +++ b/pysmurf/debug/smurf_noise.py @@ -1,3 +1,18 @@ +#!/usr/bin/env python +#----------------------------------------------------------------------------- +# Title : pysmurf debug module - SmurfNoiseMixin class +#----------------------------------------------------------------------------- +# File : pysmurf/debug/smurf_noise.py +# Created : 2018-09-17 +#----------------------------------------------------------------------------- +# This file is part of the pysmurf software package. It is subject to +# the license terms in the LICENSE.txt file found in the top-level directory +# of this distribution and at: +# https://confluence.slac.stanford.edu/display/ppareg/LICENSE.html. +# No part of the pysmurf software package, including this file, may be +# copied, modified, propagated, or distributed except according to the terms +# contained in the LICENSE.txt file. +#----------------------------------------------------------------------------- import numpy as np from scipy import signal from scipy import optimize @@ -5,6 +20,9 @@ import os import time from pysmurf.util import tools +import matplotlib.pyplot as plt +from matplotlib.gridspec import GridSpec +import seaborn as sns class SmurfNoiseMixin(SmurfBase): @@ -49,17 +67,18 @@ def take_noise_psd(self, band, meas_time, channel=None, nperseg=2**12, n_channel = self.get_number_channels(band) if datafile == None: + # Take the data datafile = self.take_stream_data(meas_time, gcp_mode=gcp_mode) else: - self.log('Reading data from %s' % (datafile)) + self.log(f'Reading data from {datafile}') basename, _ = os.path.splitext(os.path.basename(datafile)) + # Read back the data timestamp, phase, mask = self.read_stream_data_gcp_save(datafile) phase *= self.pA_per_phi0/(2.*np.pi) # phase converted to pA if fs is None: - #fs = self.fs num_averages = self.config.get('smurf_to_mce')['num_averages'] # flux ramp rate returns in kHz fs = self.get_flux_ramp_freq()*1.0E3/num_averages @@ -67,10 +86,9 @@ def take_noise_psd(self, band, meas_time, channel=None, nperseg=2**12, self.log('Plotting channels {}'.format(channel), self.LOG_USER) if make_summary_plot or make_channel_plot: - import matplotlib.pyplot as plt plt.rcParams["patch.force_edgecolor"] = True - noise_floors = np.full((len(low_freq), n_channel),np.nan) + noise_floors = np.full((len(low_freq), n_channel), np.nan) f_knees = np.full(n_channel,np.nan) res_freqs = np.full(n_channel,np.nan) @@ -85,14 +103,16 @@ def take_noise_psd(self, band, meas_time, channel=None, nperseg=2**12, if ch < 0: continue ch_idx = mask[band, ch] + # Calculate PSD f, Pxx = signal.welch(phase[ch_idx], nperseg=nperseg, fs=fs, detrend=detrend) Pxx = np.sqrt(Pxx) good_fit = False try: - popt,pcov,f_fit,Pxx_fit = self.analyze_psd(f,Pxx) - wl,n,f_knee = popt + # Fit the PSD + popt, pcov, f_fit, Pxx_fit = self.analyze_psd(f, Pxx) + wl, n, f_knee = popt if f_knee != 0.: wl_list.append(wl) f_knee_list.append(f_knee) @@ -104,9 +124,11 @@ def take_noise_psd(self, band, meas_time, channel=None, nperseg=2**12, ' pA/rtHz, n = {:.2f}'.format(n) + ', f_knee = {:.2f} Hz'.format(f_knee)) except Exception as e: - self.log('{} b{}ch{:03}: bad fit to noise model'.format(c+1,band,ch)) + self.log('{} b{}ch{:03}: bad fit to noise model'.format(c+1, + band, ch)) self.log(e) + # Calculate noise in various frequency bins for i, (l, h) in enumerate(zip(low_freq, high_freq)): idx = np.logical_and(f>l, f= 3: window_len = smooth_len - self.log('Smoothing PSDs for plotting with window of length %i' % (window_len)) - s = np.r_[Pxx[window_len-1:0:-1],Pxx,Pxx[-2:-window_len-1:-1]] + self.log(f'Smoothing PSDs for plotting with window of length {window_len}') + s = np.r_[Pxx[window_len-1:0:-1], Pxx, Pxx[-2:-window_len-1:-1]] w = np.hanning(window_len) - Pxx_smooth_ext = np.convolve(w/w.sum(),s,mode='valid') + Pxx_smooth_ext = np.convolve(w/w.sum(), s, mode='valid') ndx_add = window_len % 2 Pxx_smooth = Pxx_smooth_ext[(window_len//2)-1+ndx_add:-(window_len//2)] else: @@ -756,12 +808,14 @@ def analyze_noise_vs_bias(self, bias, datafile, channel=None, band=None, ax_NEI.plot(f_fit, Pxx_fit, color=color, linestyle='--') ax_NEI.plot(f, wl + np.zeros(len(f)), color=color, linestyle=':') - ax_NEI.plot(f_knee,2.*wl,marker = 'o',linestyle = 'none', + ax_NEI.plot(f_knee, 2.*wl, marker='o', linestyle='none', color=color) - ax_NEIwl.plot(b,noise_est,color=color,marker='s',linestyle='none') + ax_NEIwl.plot(b,noise_est,color=color,marker='s', + linestyle='none') if est_NEP: - ax_NEPwl.plot(b,NEP_est,color=color,marker='s',linestyle='none') + ax_NEPwl.plot(b,NEP_est,color=color,marker='s', + linestyle='none') iv_bias,si = self.get_si_data(iv_band_data,ch) iv_bias = iv_bias[:-1] if i == 0: @@ -779,14 +833,14 @@ def analyze_noise_vs_bias(self, bias, datafile, channel=None, band=None, R_frac_max = R[nb_idx]/R_n for ax in [ax_NEIwl,ax_NEPwl,ax_SI]: if ax == ax_SI: - label_Rfrac = r'{:.2f}-{:.2f}'.format(R_frac_min,R_frac_max) + \ + label_Rfrac = f'{R_frac_min:.2f}-{R_frac_max:.2f}' + \ r'$R_\mathrm{N}$' else: label_Rfrac = None ax.axvspan(iv_bias[sc_idx],iv_bias[nb_idx], alpha=.15,label=label_Rfrac) - ax_SI.plot(b,np.interp(b,iv_bias,si),color=color, - marker='s',linestyle='none') + ax_SI.plot(b, np.interp(b, iv_bias, si), color=color, + marker='s', linestyle='none') ax_NEI.set_xlabel(r'Freq [Hz]') ax_NEI.set_ylabel(r'NEI [$\mathrm{pA}/\sqrt{\mathrm{Hz}}$]') @@ -815,11 +869,11 @@ def analyze_noise_vs_bias(self, bias, datafile, channel=None, band=None, ax_NEIwl.set_xlabel(xlabel_bias) if freq_range_summary is not None: - ylabel_summary = r'mean noise %.2f-%.2f Hz' % (freq_min,freq_max) + ylabel_summary = f'mean noise {freq_min:.2f}-{freq_max:.2f} Hz' else: - ylabel_summary = r'white-noise level' - ax_NEIwl.set_ylabel(r'NEI %s [$\mathrm{pA}/\sqrt{\mathrm{Hz}}$]' % \ - (ylabel_summary)) + ylabel_summary = 'white-noise level' + ax_NEIwl.set_ylabel(f'NEI {ylabel_summary} ' + + r'[$\mathrm{pA}/\sqrt{\mathrm{Hz}}$]') bottom = max(0.95*min(noise_est_list),0.) top_desired = 1.05*max(noise_est_list) @@ -831,10 +885,10 @@ def analyze_noise_vs_bias(self, bias, datafile, channel=None, band=None, ax_NEIwl.grid() if est_NEP: - ax_NEPwl.set_ylabel(r'NEP %s [$\mathrm{aW}/\sqrt{\mathrm{Hz}}$]' % \ - (ylabel_summary)) - ax_SI.set_ylabel(r'Estimated responsivity with $\beta' + - r' = 0$ [$\mu\mathrm{V}^{-1}$]') + ax_NEPwl.set_ylabel(f'NEP {ylabel_summary} ' + + r'[$\mathrm{aW}/\sqrt{\mathrm{Hz}}$]') + ax_SI.set_ylabel(r'Estimated responsivity with $\beta = 0$'+ + r'[$\mu\mathrm{V}^{-1}$]') bottom_NEP = 0.95*min(NEP_est_list) top_NEP_desired = 1.05*max(NEP_est_list) @@ -852,10 +906,15 @@ def analyze_noise_vs_bias(self, bias, datafile, channel=None, band=None, ax_SI.grid() ax_NET = ax_NEPwl.twinx() + + # NEP to NET conversion model def NEPtoNET(NEP): return (1e-18/1e-6)*(1./np.sqrt(2.))*NEP/tools.dPdT_singleMode(f_center_GHz*1e9,bw_GHz*1e9,2.7) + bottom_NET = NEPtoNET(bottom_NEP) top_NET = NEPtoNET(top_NEP) + + # labels and limits ax_NET.set_ylim(bottom=bottom_NET,top=top_NET) ax_NET.set_yscale('log') ax_NET.set_ylabel(r'NET with opt. eff. = $100\%$ [$\mu\mathrm{K} \sqrt{\mathrm{s}}$]') @@ -872,13 +931,11 @@ def NEPtoNET(NEP): fig_title_string = str(bias_group) + ',' file_name_string = str(bias_group) + '_' - + # Title and layout fig.suptitle(basename + ' Band {}, Group {}'.format(band,fig_title_string) + ' Channel {:03} - {:.2f} MHz'.format(ch, res_freq)) - #fig.subplots_adjust(top=0.1) plt.tight_layout() - #plt.tight_layout(rect=[0.,0.03,1.,0.97]) if show_plot: plt.show() @@ -891,7 +948,7 @@ def NEPtoNET(NEP): else: plot_name = '{}_'.format(self.get_timestamp()) + plot_name plot_fn = os.path.join(self.plot_dir, plot_name) - self.log('Saving plot to %s' % (plot_fn)) + self.log(f'Saving plot to {plot_fn}') plt.savefig(plot_fn, bbox_inches='tight') plt.close() @@ -932,31 +989,43 @@ def NEPtoNET(NEP): bin_min = np.floor(np.log10(np.min(noise_est_data_bias))) bin_max = np.ceil(np.log10(np.max(noise_est_data_bias))) + # Make figure plt.figure() + + # Make bins bins_hist = np.logspace(bin_min,bin_max,20) hist_mat = np.zeros((len(bins_hist)-1,len(bias))) noise_est_median_list = [] + for i in range(len(bias)): hist_mat[:,i],_ = np.histogram(noise_est_data_bias[i],bins=bins_hist) noise_est_median_list.append(np.median(noise_est_data_bias[i])) X_hist,Y_hist = np.meshgrid(np.arange(len(bias),-1,-1),bins_hist) + plt.pcolor(X_hist,Y_hist,hist_mat) cbar = plt.colorbar() + + # Labels cbar.set_label('Number of channels') plt.yscale('log') - plt.ylabel(r'NEI %s [$\mathrm{pA}/\sqrt{\mathrm{Hz}}$]' % (ylabel_summary)) + plt.ylabel(f'NEI {ylabel_summary}' + + r' [$\mathrm{pA}/\sqrt{\mathrm{Hz}}$]') plt.ylim(10**bin_min,10**bin_max) plt.title(basename + - ': Band {}, Group {}, {} channels'.format(band,fig_title_string.strip(','),n_analyzed)) + ': Band {}, Group {}, {} channels'.format(band, + fig_title_string.strip(','),n_analyzed)) xtick_labels = [] for b in bias: xtick_labels.append('{}'.format(b)) xtick_locs = np.arange(len(bias)-1,-1,-1) + 0.5 - plt.xticks(xtick_locs,xtick_labels) + plt.xticks(xtick_locs, xtick_labels) plt.xlabel('Commanded bias voltage [V]') - plt.plot(xtick_locs,noise_est_median_list,linestyle='--',marker='o', - color='r',label='Median NEI') + + # Plot the data + plt.plot(xtick_locs, noise_est_median_list, linestyle='--', marker='o', + color='r', label='Median NEI') plt.legend(loc='lower center') + if show_plot: plt.show() if save_plot: @@ -966,8 +1035,8 @@ def NEPtoNET(NEP): else: plot_name = '{}_'.format(self.get_timestamp()) + plot_name plot_fn = os.path.join(self.plot_dir, plot_name) - self.log('\nSaving NEI histogram to %s' % (plot_fn)) - plt.savefig(plot_fn,bbox_inches='tight') + self.log(f'\nSaving NEI histogram to {plot_fn}') + plt.savefig(plot_fn, bbox_inches='tight') plt.close() if est_NEP: @@ -992,14 +1061,16 @@ def NEPtoNET(NEP): cbar_NEP = plt.colorbar() cbar_NEP.set_label('Number of channels') plt.yscale('log') - plt.ylabel(r'NEP %s [$\mathrm{aW}/\sqrt{\mathrm{Hz}}$]' % (ylabel_summary)) + plt.ylabel(f'NEP {ylabel_summary}' + + r' [$\mathrm{aW}/\sqrt{\mathrm{Hz}}$]') plt.ylim(10**bin_NEP_min,10**bin_NEP_max) plt.title(basename + - ': Band {}, Group {}, {} channels'.format(band,fig_title_string.strip(','),n_analyzed)) + ': Band {}, Group {}, {} channels'.format(band, + fig_title_string.strip(','), n_analyzed)) plt.xticks(xtick_locs,xtick_labels) plt.xlabel('Commanded bias voltage [V]') - plt.plot(xtick_locs,NEP_est_median_list,linestyle='--',marker='o', - color='r',label='Median NEP') + plt.plot(xtick_locs,NEP_est_median_list, linestyle='--', marker='o', + color='r', label='Median NEP') plt.legend(loc='lower center') if show_plot: plt.show() @@ -1010,20 +1081,39 @@ def NEPtoNET(NEP): else: plot_name = '{}_'.format(self.get_timestamp()) + plot_name plot_fn = os.path.join(self.plot_dir, plot_name) - self.log('\nSaving NEP histogram to %s' % (plot_fn)) - plt.savefig(plot_fn,bbox_inches='tight') + self.log(f'\nSaving NEP histogram to {plot_fn}') + plt.savefig(plot_fn, bbox_inches='tight') plt.close() def analyze_psd(self, f, Pxx, p0=[100.,0.5,0.01]): ''' Return model fit for a PSD. - p0 (float array): initial guesses for model fitting: [white-noise level in pA/rtHz, exponent of 1/f^n component, knee frequency in Hz] + p0 (float array): initial guesses for model fitting: [white-noise level + in pA/rtHz, exponent of 1/f^n component, knee frequency in Hz] + + Args: + ----- + f (float array) : The frequency information + Pxx (float array) : The power spectral data + + Opt Args: + --------- + p0 (float array) : Initial guess for fitting PSDs + + Ret: + ---- + popt (float array) : The fit parameters - [white_noise_level, n, f_knee] + pcov (float array) : Covariance matrix + f_fit (float array) : The frequency bins of the fit + Pxx_fit (flot array) : The amplitude ''' # incorporate timestream filtering f3dB = self.config.get('smurf_to_mce').get('filter_freq') filter_order = self.config.get('smurf_to_mce').get('filter_order') - b,a = signal.butter(filter_order,f3dB,analog=True,btype='low') # Butterworth filter in gcp streaming + + # Butterworth filter in gcp streaming + b,a = signal.butter(filter_order,f3dB,analog=True,btype='low') def noise_model(freq, wl, n, f_knee): ''' @@ -1048,14 +1138,17 @@ def noise_model(freq, wl, n, f_knee): p0=p0,bounds=bounds) except Exception as e: wl = np.mean(Pxx[1:]) - print('Unable to fit noise model. Reporting mean noise: %.2f pA/rtHz' % (wl)) - popt = [wl,1.,0.] + print('Unable to fit noise model. ' + + f'Reporting mean noise: {wl:.2f} pA/rtHz') + + popt = [wl, 1., 0.] pcov = None + df = f[1] - f[0] f_fit = np.arange(f[1],f[-1] + df,df/10.) Pxx_fit = noise_model(f_fit,*popt) - return popt,pcov,f_fit,Pxx_fit + return popt, pcov, f_fit, Pxx_fit def noise_all_vs_noise_solo(self, band, meas_time=10): """ @@ -1092,7 +1185,9 @@ def noise_all_vs_noise_solo(self, band, meas_time=10): filename = self.take_stream_data(meas_time) ret[ch] = filename - np.save(os.path.join(self.output_dir, timestamp + 'all_vs_solo'), ret) + path = os.path.join(self.output_dir, timestamp + 'all_vs_solo') + np.save(path, ret) + self.pub.register_file(path, 'noise', format='npy') return ret @@ -1108,8 +1203,6 @@ def analyze_noise_all_vs_noise_solo(self, ret, fs=None, nperseg=2**10, if fs is None: fs = self.fs - import matplotlib.pyplot as plt - keys = ret.keys() all_dir = ret.pop('all') @@ -1188,6 +1281,7 @@ def NET_CMB(self, NEI, V_b, R_tes, opt_eff, f_center=150e9, bw=32e9, return NET_SI/1e-6 # NET in uK rt(s) + def analyze_noise_vs_tone(self, tone, datafile, channel=None, band=None, nperseg=2**13, detrend='constant', fs=None, save_plot=True, show_plot=False, make_timestream_plot=False, data_timestamp=None, @@ -1196,8 +1290,6 @@ def analyze_noise_vs_tone(self, tone, datafile, channel=None, band=None, """ Analysis script associated with noise_vs_tone. """ - import matplotlib.pyplot as plt - from matplotlib.gridspec import GridSpec if not show_plot: plt.ioff() @@ -1212,11 +1304,11 @@ def analyze_noise_vs_tone(self, tone, datafile, channel=None, band=None, fs = self.fs if isinstance(tone,str): - self.log('Tone powers being read from %s' % (tone)) + self.log(f'Tone powers being read from {tone}') tone = self.get_biases_from_file(tone,dtype=int) if isinstance(datafile,str): - self.log('Noise data files being read from %s' % (datafile)) + self.log(f'Noise data files being read from {datafile}') datafile = self.get_datafiles_from_file(datafile) mask = np.loadtxt(self.smurf_to_mce_mask_file) @@ -1236,8 +1328,11 @@ def analyze_noise_vs_tone(self, tone, datafile, channel=None, band=None, f, Pxx = signal.welch(phase[ch_idx], nperseg=nperseg, fs=fs, detrend=detrend) Pxx = np.ravel(np.sqrt(Pxx)) # pA - np.savetxt(os.path.join(psd_dir, basename + - '_psd_ch{:03}.txt'.format(ch)), np.vstack((f, Pxx))) + + path = os.path.join(psd_dir, + basename + '_psd_ch{:03}.txt'.format(ch)) + np.savetxt(path, np.vstack((f, Pxx))) + self.pub.register_file(path, 'psd', format='txt') if make_timestream_plot: fig,ax = plt.subplots(1) @@ -1282,7 +1377,7 @@ def analyze_noise_vs_tone(self, tone, datafile, channel=None, band=None, # smooth Pxx for plotting if smooth_len >= 3: window_len = smooth_len - self.log('Smoothing PSDs for plotting with window of length %i' % (window_len)) + self.log(f'Smoothing PSDs for plotting with window of length {window_len}') s = np.r_[Pxx[window_len-1:0:-1],Pxx,Pxx[-2:-window_len-1:-1]] w = np.hanning(window_len) Pxx_smooth_ext = np.convolve(w/w.sum(),s,mode='valid') @@ -1333,10 +1428,11 @@ def analyze_noise_vs_tone(self, tone, datafile, channel=None, band=None, ax1.set_xlabel(r'Tone-power setting') if freq_range_summary is not None: - ylabel_summary = r'Mean noise %.2f-%.2f Hz' % (freq_min,freq_max) + ylabel_summary = f'Mean noise {freq_min:.2f}-{freq_max:.2f Hz}' else: ylabel_summary = r'White-noise level' - ax1.set_ylabel(r'%s [$\mathrm{pA}/\sqrt{\mathrm{Hz}}$]' % (ylabel_summary)) + ax1.set_ylabel(f'{ylabel_summary} ' + + r'[$\mathrm{pA}/\sqrt{\mathrm{Hz}}$]') bottom = max(0.95*min(noise_est_list),0.) top_desired = 1.05*max(noise_est_list) @@ -1372,7 +1468,7 @@ def analyze_noise_vs_tone(self, tone, datafile, channel=None, band=None, else: plot_name = '{}_'.format(self.get_timestamp()) + plot_name plot_fn = os.path.join(self.plot_dir, plot_name) - self.log('Saving plot to %s' % (plot_fn)) + self.log(f'Saving plot to {plot_fn}') plt.savefig(plot_fn, bbox_inches='tight') plt.close() @@ -1427,9 +1523,6 @@ def plot_svd_summary(self, u, s, save_plot=False, save_name (str) : The name of the file show_plot (bool) : Whether to show the plot """ - import matplotlib.pyplot as plt - import seaborn as sns - if not show_plot: plt.ioff() else: @@ -1485,7 +1578,6 @@ def plot_svd_modes(self, vh, n_row=4, n_col=5, figsize=(10,7.5), save_name (str) : The name of the file show_plot (bool) : Whether to show the plot """ - import matplotlib.pyplot as plt if not show_plot: plt.ioff() else: diff --git a/pysmurf/tune/__init__.py b/pysmurf/tune/__init__.py new file mode 100644 index 000000000..66fb1c4fd --- /dev/null +++ b/pysmurf/tune/__init__.py @@ -0,0 +1,13 @@ +#!/usr/bin/env python +#----------------------------------------------------------------------------- +# This file is part of the pysmurf software package. It is subject to +# the license terms in the LICENSE.txt file found in the top-level directory +# of this distribution and at: +# https://confluence.slac.stanford.edu/display/ppareg/LICENSE.html. +# No part of the pysmurf software package, including this file, may be +# copied, modified, propagated, or distributed except according to the terms +# contained in the LICENSE.txt file. +#----------------------------------------------------------------------------- +''' +init for tune dir +''' diff --git a/tune/smurf_tune.py b/pysmurf/tune/smurf_tune.py similarity index 82% rename from tune/smurf_tune.py rename to pysmurf/tune/smurf_tune.py index 23550c702..bd82cbedd 100644 --- a/tune/smurf_tune.py +++ b/pysmurf/tune/smurf_tune.py @@ -1,3 +1,18 @@ +#!/usr/bin/env python +#----------------------------------------------------------------------------- +# Title : pysmurf tune module - SmurfTuneMixin class +#----------------------------------------------------------------------------- +# File : pysmurf/tune/smurf_tune.py +# Created : 2018-08-31 +#----------------------------------------------------------------------------- +# This file is part of the pysmurf software package. It is subject to +# the license terms in the LICENSE.txt file found in the top-level directory +# of this distribution and at: +# https://confluence.slac.stanford.edu/display/ppareg/LICENSE.html. +# No part of the pysmurf software package, including this file, may be +# copied, modified, propagated, or distributed except according to the terms +# contained in the LICENSE.txt file. +#----------------------------------------------------------------------------- import numpy as np import os import glob @@ -8,6 +23,8 @@ from collections import Counter from ..util import tools from pysmurf.command.sync_group import SyncGroup as SyncGroup +import matplotlib.pyplot as plt +from matplotlib.gridspec import GridSpec class SmurfTuneMixin(SmurfBase): """ @@ -24,8 +41,8 @@ def tune(self, load_tune=True, tune_file=None, last_tune=False, channels using check lock. When this is done, we should be ready to take data. - Args: - ----- + Opt Args: + --------- load_tune (bool): Whether to load in a tuning file. If False, will do a full tuning. This will be very slow (~ 1 hour) tune_file (str): The tuning file to load in. Default is None. If @@ -38,11 +55,15 @@ def tune(self, load_tune=True, tune_file=None, last_tune=False, f_min (float): The minimum frequency swing allowable for check_lock. f_max (float): The maximum frequency swing allowable for check_lock. df_max (float): The maximum df stddev allowable for check_lock. + fraction_full_scale (float): The fraction (between 0-1) to set the + flux ramp amplitude. make_plot (bool): Whether to make a plot. Default is False. save_plot (bool): If making plots, whether to save them. Default is True. show_plot (bool): Whether to display the plots to screen. Default is False. track_and_check (bool): Whether or not after tuning to run track and check. Default is True. + new_master_assignment (bool): Whether to make a new master assignment + which forces resonators at a given frequency to a given channel. """ bands = self.config.get('init').get('bands') tune_cfg = self.config.get('tune_band') @@ -68,33 +89,31 @@ def tune(self, load_tune=True, tune_file=None, last_tune=False, self.find_freq(b, drive_power=drive) self.setup_notches(b, drive=drive, - new_master_assignment=new_master_assignment) + new_master_assignment=new_master_assignment) # Runs tune_band_serial to re-estimate eta params if retune: for b in bands: self.log('Running tune band serial on band {}'.format(b)) self.tune_band_serial(b, from_old_tune=load_tune, - old_tune=tune_file, make_plot=make_plot, - show_plot=show_plot, save_plot=save_plot, - new_master_assignment=new_master_assignment) + old_tune=tune_file, make_plot=make_plot, + show_plot=show_plot, save_plot=save_plot, + new_master_assignment=new_master_assignment) # Starts tracking and runs check_lock to prune bad resonators if track_and_check: for b in bands: self.log('Tracking and checking band {}'.format(b)) self.track_and_check(b, fraction_full_scale=fraction_full_scale, - f_min=f_min, - f_max=f_max, df_max=df_max, make_plot=make_plot, - save_plot=save_plot, show_plot=show_plot) + f_min=f_min, f_max=f_max, df_max=df_max, make_plot=make_plot, + save_plot=save_plot, show_plot=show_plot) def tune_band(self, band, freq=None, resp=None, n_samples=2**19, - make_plot=False, show_plot=False, plot_chans=[], save_plot=True, save_data=True, - make_subband_plot=False, subband=None, n_scan=5, - subband_plot_with_slow=False, drive=None, - grad_cut=.05, freq_min=-2.5E8, freq_max=2.5E8, amp_cut=.5, - use_slow_eta=False): + make_plot=False, show_plot=False, plot_chans=[], save_plot=True, + save_data=True, make_subband_plot=False, subband=None, n_scan=5, + subband_plot_with_slow=False, drive=None, grad_cut=.05, freq_min=-2.5E8, + freq_max=2.5E8, amp_cut=.5, use_slow_eta=False): """ This does the full_band_resp, which takes the raw resonance data. It then finds the where the resonances are. Using the resonance @@ -138,13 +157,13 @@ def tune_band(self, band, freq=None, resp=None, n_samples=2**19, timestamp = self.get_timestamp() if make_plot and save_plot: - import matplotlib.pyplot as plt plt.ioff() if freq is None or resp is None: self.band_off(band) self.flux_ramp_off() self.log('Running full band resp') + # Inject high amplitude noise with known waveform, measure it, and # then find resonators and etaParameters from cross-correlation. freq, resp = self.full_band_resp(band, n_samples=n_samples, @@ -169,6 +188,7 @@ def tune_band(self, band, freq=None, resp=None, n_samples=2**19, plot_chans=plot_chans, save_plot=save_plot, res_num=i, band=band, timestamp=timestamp, use_slow_eta=use_slow_eta) + # Fill the resonances dict resonances[i] = { 'freq': p*1.0E-6 + band_center_mhz, 'eta': eta, @@ -182,8 +202,10 @@ def tune_band(self, band, freq=None, resp=None, n_samples=2**19, if save_data: self.log('Saving resonances to {}'.format(self.output_dir)) - np.save(os.path.join(self.output_dir, - '{}_b{}_resonances'.format(timestamp, band)), resonances) + path = os.path.join(self.output_dir, + '{}_b{}_resonances'.format(timestamp, band)) + np.save(path, resonances) + self.pub.register_file(path, 'resonances', format='npyt') # Assign resonances to channels self.log('Assigning channels') @@ -198,14 +220,16 @@ def tune_band(self, band, freq=None, resp=None, n_samples=2**19, self.freq_resp[band]['resonances'] = resonances if drive is None: drive = self.config.get('init').get('band_{}'.format(band)).get('amplitude_scale') + + # Add tone amplitude to tuning dictionary self.freq_resp[band]['drive'] = drive + # Save the data self.save_tune() -# np.save(os.path.join(self.output_dir, -# '{}_freq_resp'.format(timestamp)), self.freq_resp) self.relock(band) - self.log('Done') + self.log('Done tuning') + return resonances def tune_band_serial(self, band, n_samples=2**19, @@ -216,9 +240,12 @@ def tune_band_serial(self, band, n_samples=2**19, del_f=.005, drive=None, new_master_assignment=False, from_old_tune=False, old_tune=None, pad=50, min_gap=50): """ - Tunes band using serial_gradient_descent and then - serial_eta_scan. This takes about 3 minutes per band if there - are about 150 resonators. + Tunes band using serial_gradient_descent and then serial_eta_scan. + This requires an initial guess, which this function gets by either + loading an old tune or by using the full_band_resp. This takes about 3 + minutes per band if there are about 150 resonators. + + This saves the results to the freq_resp dictionary. Args: ----- @@ -278,13 +305,13 @@ def tune_band_serial(self, band, n_samples=2**19, self.set_att_uc(band, old_att, write_log=True) # Find peaks - peaks = self.find_peak(freq, resp, rolling_med=rolling_med, window=window, - band=band, make_plot=make_plot, save_plot=save_plot, - show_plot=show_plot, grad_cut=grad_cut, freq_min=freq_min, - freq_max=freq_max, amp_cut=amp_cut, - make_subband_plot=make_subband_plot, timestamp=timestamp, - subband_plot_with_slow=subband_plot_with_slow, pad=pad, - min_gap=min_gap) + peaks = self.find_peak(freq, resp, rolling_med=rolling_med, + window=window, band=band, make_plot=make_plot, + save_plot=save_plot, show_plot=show_plot, grad_cut=grad_cut, + freq_min=freq_min, freq_max=freq_max, amp_cut=amp_cut, + make_subband_plot=make_subband_plot, timestamp=timestamp, + subband_plot_with_slow=subband_plot_with_slow, pad=pad, + min_gap=min_gap) resonances = {} for i, p in enumerate(peaks): @@ -360,231 +387,15 @@ def tune_band_serial(self, band, n_samples=2**19, self.log('Done with serial tuning') - def tune_band_parallel(self, band, n_samples=2**19, - make_plot=False, save_plot=True, save_data=True, show_plot=False, - make_subband_plot=False, subband=None, n_scan=2, - subband_plot_with_slow=False, window=5000, rolling_med=True, - grad_cut=.025, freq_min=-2.5E8, freq_max=2.5E8, amp_cut=.25, - load_peaks_from_file=True, del_f=.005): - """ - Uses parallel eta scans to tune the band. This does not work - very well. Use tune_band_serial instead. - """ - timestamp = self.get_timestamp() - - if make_plot: - import matplotlib.pyplot as plt - if show_plot: - plt.ion() - else: - plt.ioff() - - self.band_off(band) - self.flux_ramp_off() - self.log('Running full band resp') - - if load_peaks_from_file: - peaks = np.loadtxt('/home/cryo/ey/all_resonators.txt', delimiter=',') - if band == 2: - peaks = peaks[peaks < 5.500] - 5.25 - elif band == 3: - peaks = peaks[peaks > 5.500] - 5.75 - peaks *= 1.0E9 - - else: - # Inject high amplitude noise with known waveform, measure it, and - # then find resonators and etaParameters from cross-correlation. - att_uc = self.get_att_uc(band) - drive = self.config.get('init')['band_{}'.format(band)]['amplitude_scale'] - self.set_att_uc(band, (15-drive)*6+att_uc, write_log=True) - freq, resp = self.full_band_resp(band, n_samples=n_samples, - make_plot=make_plot, save_data=save_data, show_plot=False, - timestamp=timestamp, - n_scan=n_scan) - - self.set_att_uc(band, att_uc) - - # Find peaks - peaks = self.find_peak(freq, resp, rolling_med=rolling_med, window=window, - band=band, make_plot=make_plot, - save_plot=save_plot, show_plot=show_plot, grad_cut=grad_cut, freq_min=freq_min, - freq_max=freq_max, amp_cut=amp_cut, - make_subband_plot=make_subband_plot, timestamp=timestamp, - subband_plot_with_slow=subband_plot_with_slow, pad=50, min_gap=50) - - # Assign resonances - resonances = {} - for i, p in enumerate(peaks): - resonances[i] = { - 'freq': p*1.0E-6, # in MHz - 'r2' : 0, - 'Q' : 1, - 'eta_phase' : 1 , # Fill etas with arbitrary values for now - 'eta_scaled' : 1 - } - - # Assign resonances to channels - self.log('Assigning channels') - f = [resonances[k]['freq'] for k in resonances.keys()] - subbands, channels, offsets = self.assign_channels(f, band=band) - for i, k in enumerate(resonances.keys()): - resonances[k].update({'subband': subbands[i]}) - resonances[k].update({'channel': channels[i]}) - resonances[k].update({'offset': offsets[i]}) - self.freq_resp[band]['resonances'] = resonances - self.freq_resp[band]['drive'] = \ - self.config.get('init')['band_{}'.format(band)]['amplitude_scale'] - - # Set the resonator frequencies without eta params - self.relock(band) - - # Run parallel eta scans - self.set_eta_scan_del_f(band, del_f) - self.run_parallel_eta_scan(band) - - eta_phase = self.get_eta_phase_array(band) - eta_scaled = self.get_eta_mag_array(band) - chs = self.get_eta_scan_result_channel(band) - for i, ch in enumerate(chs): - if ch != -1: - resonances[i]['eta_phase'] = eta_phase[ch] - resonances[i]['eta_scaled'] = eta_scaled[ch] - - self.freq_resp[band]['resonances'] = resonances - - self.save_tune() - - - def tune_band_quad(self, band, del_f=.01, n_samples=2**19, - make_plot=False, plot_chans=[], save_plot=True, save_data=True, - subband=None, n_scan=1, grad_cut=.05, freq_min=-2.5E8, - freq_max=2.5E8, amp_cut=1, n_pts=20): - """ - """ - timestamp = self.get_timestamp() - - if make_plot and save_plot: - import matplotlib.pyplot as plt - plt.ioff() - - self.band_off(band) - self.flux_ramp_off() - self.log('Running full band resp') - - - # Find resonators with noise blast - freq, resp = self.full_band_resp(band, n_samples=n_samples, - make_plot=make_plot, save_data=save_data, - timestamp=timestamp, n_scan=n_scan) - - peaks = self.find_peak(freq, resp, band=band, make_plot=make_plot, - save_plot=save_plot, grad_cut=grad_cut, freq_min=freq_min, - freq_max=freq_max, amp_cut=amp_cut, - make_subband_plot=make_subband_plot, timestamp=timestamp, - subband_plot_with_slow=subband_plot_with_slow) - - # Assign resonances to channels - resonances = {} - self.log('Assigning channels') - for i, p in enumerate(peaks): - resonances[i] = {'peak' : p} - - subbands, channels, offsets = self.assign_channels(peaks*1.0E-6, band=band) - - for i, k in enumerate(resonances.keys()): - resonances[k].update({'subband': subbands[i]}) - resonances[k].update({'channel': channels[i]}) - resonances[k].update({'offset': offsets[i]}) - - # Fill with dummy values so relock does not fail - resonances[k].update({'eta': 0}) - resonances[k].update({'eta_scaled': 0}) - resonances[k].update({'eta_phase': 0}) - resonances[k].update({'r2': 0}) - resonances[k].update({'eta_mag': 0}) - resonances[k].update({'latency': 0}) - resonances[k].update({'Q': 0}) - - self.freq_resp[band] = resonances - self.relock(band, check_vals=False) - - channels = self.which_on(band) - - feedback_array = np.zeros_like(self.get_feedback_enable_array(band)) - self.set_feedback_enable_array(band, feedback_array) - - eta_mag_array = np.zeros_like(self.get_eta_mag_array(band)) - eta_mag_array[channels] = 1 - self.set_eta_mag_array(band, eta_mag_array) - - self.log('Measuring eta_phase = 0') - eta_phase_array = np.zeros_like(self.get_eta_phase_array(band)) - self.set_eta_phase_array(band, eta_phase_array) - - adc0 = np.zeros((n_pts, len(channels))) - for i in np.arange(n_pts): - adc0[i] = self.get_frequency_error_array(band)[channels] - - self.log('Measuring eta phase = 90') - eta_phase_array[channels] = 90. - self.set_eta_phase_array(band, eta_phase_array) - - adc90 = np.zeros_like(adc0) - for i in np.arange(n_pts): - adc90[i] = self.get_frequency_error_array(band)[channels] - - adc0_est = np.median(adc0, axis=0) - adc90_est = np.median(adc90, axis=0) - - in_phase_rad = np.arctan2(adc90_est, adc0_est) - quad_phase_rad = in_phase_rad + np.pi/2. - in_phase_deg = np.rad2deg(in_phase_rad) - quad_phase_deg = np.rad2deg(quad_phase_rad) - - self.log('In phase: {:4.2f}'.format(in_phase_deg) + \ - ' Quad phase: {:4.2f}'.format(quad_phase_deg)) - - center_freq_array = self.get_center_frequency_array(band) - - eta_phase_array[channels] = [tools.limit_phase_deg(qpd) for qpd in quad_phase_deg] - self.set_eta_phase_array(band, eta_phase_array) - - self.log('Measuring eta_mag') - adc_plus = np.zeros((n_pts, len(channels))) - adc_minus = np.zeros((n_pts, len(channels))) - - self.set_center_frequency_array(band, center_freq_array+del_f) - for i in np.arange(n_pts): - adc_plus[i] = self.get_frequency_error_array(band)[channels] - - self.set_center_frequency_array(band, center_freq_array-del_f) - for i in np.arange(n_pts): - adc_minus[i] = self.get_frequency_error_array(band)[channels] - - self.set_center_frequency_array(band, center_freq_array) - - adc_plus_est = np.median(adc_plus, axis=0) - adc_minus_est = np.median(adc_minus, axis=0) - - dig_freq = self.get_digitizer_frequency_mhz(band) - n_subband = self.get_number_sub_bands(band) - sb_halfwidth = dig_freq / n_subband # MHz - - eta_est = (2*del_f/(adc_plus_est - adc_minus_est)) - eta_mag = np.abs(eta_est) - eta_scaled = eta_mag / sb_halfwidth - - eta_phase_array = self.get_eta_phase_array(band) - eta_phase_array[channels]=[tools.limit_phase_deg(eP+180) if eE<0 \ - else eP for (eP,eE) in zip(eta_phase_array[channels], etaEst)] - self.set_eta_phase_array(band, eta_phase_array) - def plot_tune_summary(self, band, eta_scan=False, show_plot=False, - save_plot=True): + save_plot=True, eta_width=.3): """ Plots summary of tuning. Requires self.freq_resp to be filled. In other words, you must run find_freq and setup_notches - before calling this function. + before calling this function. Saves the plot to plot_dir. + + This will also make individual eta plots as well if {eta_scan} is True. + The eta scan plots are slow because there are many of them. Args: ----- @@ -596,8 +407,8 @@ def plot_tune_summary(self, band, eta_scan=False, show_plot=False, Warning this is slow. Default is False. show_plot (bool) : Whether to display the plot. Default is False. save_plot (bool) : Whether to save the plot. Default is True. + eta_width (float) : The width to plot in MHz. """ - import matplotlib.pyplot as plt if show_plot: plt.ion() else: @@ -654,45 +465,48 @@ def plot_tune_summary(self, band, eta_scan=False, show_plot=False, if save_plot: save_name = '{}_tune_summary.png'.format(timestamp) - plt.savefig(os.path.join(self.plot_dir, save_name), - bbox_inches='tight') + path = os.path.join(self.plot_dir, save_name) + plt.savefig(path, bbox_inches='tight') + self.pub.register_file(path, 'tune', plot=True) if not show_plot: plt.close() + # Plot individual eta scan if eta_scan: keys = self.freq_resp[band]['resonances'].keys() n_keys = len(keys) + # If using full band response as input if 'full_band_resp' in self.freq_resp[band]: freq = self.freq_resp[band]['full_band_resp']['freq'] resp = self.freq_resp[band]['full_band_resp']['resp'] for k in keys: r = self.freq_resp[band]['resonances'][k] - width = .300 # 300 kHz + eta_width = .300 # in MHz. So this = 300 kHz center_freq = r['freq'] - idx = np.logical_and(freq > center_freq - width, - freq < center_freq + width) + idx = np.logical_and(freq > center_freq - eta_width, + freq < center_freq + eta_width) + # Actually plot the data self.plot_eta_fit(band, freq[idx], resp[idx], - eta_mag=r['eta_mag'], eta_phase_deg=r['eta_phase'], - band=band, res_num=k, - timestamp=timestamp, save_plot=save_plot, - show_plot=show_plot, peak_freq=center_freq, - channel=r['channel']) + eta_mag=r['eta_mag'], eta_phase_deg=r['eta_phase'], + band=band, res_num=k, timestamp=timestamp, + save_plot=save_plot, show_plot=show_plot, + peak_freq=center_freq, channel=r['channel']) + # This is for data from find_freq/setup_notches else: for k in keys: self.log('Eta plot {} of {}'.format(k+1, n_keys)) r = self.freq_resp[band]['resonances'][k] self.plot_eta_fit(r['freq_eta_scan'], r['resp_eta_scan'], - eta=r['eta'], eta_mag=r['eta_mag'], - eta_phase_deg=r['eta_phase'], - band=band, res_num=k, - timestamp=timestamp, save_plot=save_plot, - show_plot=show_plot, peak_freq=r['freq']) + eta=r['eta'], eta_mag=r['eta_mag'], + eta_phase_deg=r['eta_phase'], band=band, res_num=k, + timestamp=timestamp, save_plot=save_plot, + show_plot=show_plot, peak_freq=r['freq']) def full_band_resp(self, band, n_scan=1, n_samples=2**19, make_plot=False, save_plot=True, show_plot=False, save_data=False, timestamp=None, - save_raw_data=False, correct_att=True, swap=False, - hw_trigger=True, write_log=False): + save_raw_data=False, correct_att=True, swap=False, hw_trigger=True, + write_log=False): """ Injects high amplitude noise with known waveform. The ADC measures it. The cross correlation contains the information about the resonances. @@ -758,10 +572,14 @@ def full_band_resp(self, band, n_scan=1, n_samples=2**19, make_plot=False, if save_raw_data: self.log('Saving raw data...', self.LOG_USER) - np.save(os.path.join(self.output_dir, - '{}_adc'.format(timestamp)), adc) - np.save(os.path.join(self.output_dir, - '{}_dac'.format(timestamp)), dac) + + path = os.path.join(self.output_dir, '{}_adc'.format(timestamp)) + np.save(path, adc) + self.pub.register_file(path, 'adc', format='npy') + + path = os.path.join(self.output_dir,'{}_dac'.format(timestamp)) + np.save(path, dac) + self.pub.register_file(path, 'dac', format='npy') # To do : Implement cross correlation to get shift @@ -783,7 +601,6 @@ def full_band_resp(self, band, n_scan=1, n_samples=2**19, make_plot=False, resp = np.mean(resp, axis=0) if make_plot: - import matplotlib.pyplot as plt if show_plot: plt.ion() else: @@ -806,9 +623,10 @@ def full_band_resp(self, band, n_scan=1, n_samples=2**19, make_plot=False, # plt.tight_layout() if save_plot: - plt.savefig(os.path.join(self.plot_dir, - '{}_b{}_full_band_resp_raw.png'.format(timestamp, band)), - bbox_inches='tight') + path = os.path.join(self.plot_dir, + '{}_b{}_full_band_resp_raw.png'.format(timestamp, band)) + plt.savefig(path, bbox_inches='tight') + self.pub.register_file(path, 'response', plot=True) plt.close() fig, ax = plt.subplots(1) @@ -818,9 +636,11 @@ def full_band_resp(self, band, n_scan=1, n_samples=2**19, make_plot=False, ax.set_ylabel('Response') ax.set_title(timestamp) if save_plot: - plt.savefig(os.path.join(self.plot_dir, - '{}_b{}_full_band_resp.png'.format(timestamp, band)), - bbox_inches='tight') + path = os.path.join(self.plot_dir, + '{}_b{}_full_band_resp.png'.format(timestamp, + band)) + plt.savefig(path, bbox_inches='tight') + self.pub.register_file(path, 'response', plot=True) if show_plot: plt.show() else: @@ -828,20 +648,28 @@ def full_band_resp(self, band, n_scan=1, n_samples=2**19, make_plot=False, if save_data: save_name = timestamp + '_{}_full_band_resp.txt' - np.savetxt(os.path.join(self.output_dir, save_name.format('freq')), - f) - np.savetxt(os.path.join(self.output_dir, save_name.format('real')), - np.real(resp)) - np.savetxt(os.path.join(self.output_dir, save_name.format('imag')), - np.imag(resp)) + + path = os.path.join(self.output_dir, save_name.format('freq')) + np.savetxt(path, f) + self.pub.register_file(path, 'full_band_resp', format='txt') + + path = os.path.join(self.output_dir, save_name.format('real')) + np.savetxt(path, np.real(resp)) + self.pub.register_file(path, 'full_band_resp', format='txt') + + path = os.path.join(self.output_dir, save_name.format('imag')) + np.savetxt(path, np.imag(resp)) + self.pub.register_file(path, 'full_band_resp', format='txt') return f, resp def find_peak(self, freq, resp, rolling_med=True, window=5000, - grad_cut=.5, amp_cut=.25, freq_min=-2.5E8, freq_max=2.5E8, make_plot=False, - save_plot=True, show_plot=False, band=None,subband=None, make_subband_plot=False, - subband_plot_with_slow=False, timestamp=None, pad=50, min_gap=100, plot_title=None): + grad_cut=.5, amp_cut=.25, freq_min=-2.5E8, freq_max=2.5E8, + make_plot=False, save_plot=True, show_plot=False, band=None, + subband=None, make_subband_plot=False, subband_plot_with_slow=False, + timestamp=None, pad=50, min_gap=100, plot_title=None, + grad_kernel_width=8): """find the peaks within a given subband Args: @@ -873,7 +701,8 @@ def find_peak(self, freq, resp, rolling_med=True, window=5000, pad (int): number of samples to pad on either side of a resonance search window min_gap (int): minimum number of samples between resonances - + grad_kernel_width (int) : The number of samples to take after a point + to calculate the gradient of phase. Default is 8. Returns: -------_ @@ -883,27 +712,30 @@ def find_peak(self, freq, resp, rolling_med=True, window=5000, if timestamp is None: timestamp = self.get_timestamp() + # Break apart the data angle = np.unwrap(np.angle(resp)) x = np.arange(len(angle)) p1 = np.poly1d(np.polyfit(x, angle, 1)) angle -= p1(x) - grad = np.convolve(angle, np.repeat([1,-1], 8), - mode='same') - #grad = np.ediff1d(angle, to_end=[np.nan]) + grad = np.convolve(angle, np.repeat([1,-1], grad_kernel_width), + mode='same') + amp = np.abs(resp) grad_loc = np.array(grad > grad_cut) + # Calculate the rolling median. This uses pandas. if rolling_med: import pandas as pd - med_amp = pd.Series(amp).rolling(window=window, center=True).median() else: med_amp = np.median(amp) * np.ones(len(amp)) + # Get the flagging starts, ends = self.find_flag_blocks(self.pad_flags(grad_loc, before_pad=pad, after_pad=pad, min_gap=min_gap)) + # Find the peaks locations peak = np.array([], dtype=int) for s, e in zip(starts, ends): if freq[s] > freq_min and freq[e] < freq_max: @@ -914,7 +746,6 @@ def find_peak(self, freq, resp, rolling_med=True, window=5000, # Make summary plot if make_plot: - import matplotlib.pyplot as plt if show_plot: plt.ion() else: @@ -935,8 +766,10 @@ def find_peak(self, freq, resp, rolling_med=True, window=5000, ax[1].set_ylim(-2, 20) for s, e in zip(starts, ends): - ax[0].axvspan(plot_freq_mhz[s], plot_freq_mhz[e], color='k', alpha=.1) - ax[1].axvspan(plot_freq_mhz[s], plot_freq_mhz[e], color='k', alpha=.1) + ax[0].axvspan(plot_freq_mhz[s], plot_freq_mhz[e], color='k', + alpha=.1) + ax[1].axvspan(plot_freq_mhz[s], plot_freq_mhz[e], color='k', + alpha=.1) ax[0].set_ylabel('Amp.') @@ -944,9 +777,9 @@ def find_peak(self, freq, resp, rolling_med=True, window=5000, title = timestamp if band is not None: - title = title + ': band {}, center = {:.1f} MHz'.format(band,bandCenterMHz) + title = title + f': band {band}, center = {bandCenterMHz:.1f} MHz' if subband is not None: - title = title + ' subband {}'.format(subband) + title = title + f' subband {subband}' fig.suptitle(title) if save_plot: @@ -956,8 +789,9 @@ def find_peak(self, freq, resp, rolling_med=True, window=5000, if subband is not None: save_name = save_name + '_sb{}'.format(int(subband)) save_name = save_name + '_find_freq.png' - plt.savefig(os.path.join(self.plot_dir, save_name), - bbox_inches='tight', dpi=300) + path = os.path.join(self.plot_dir, save_name) + plt.savefig(path, bbox_inches='tight', dpi=300) + self.pub.register_file(path, 'find_freq', plot=True) if show_plot: plt.show() else: @@ -965,7 +799,6 @@ def find_peak(self, freq, resp, rolling_med=True, window=5000, # Make plot per subband if make_subband_plot: - import matplotlib.pyplot as plt subbands, subband_freq = self.get_subband_centers(band, hardcode=True) # remove hardcode mode plot_freq_mhz = freq @@ -994,10 +827,10 @@ def find_peak(self, freq, resp, rolling_med=True, window=5000, ax[1].plot(f, ma, label='Median Amp') for s, e in zip(starts, ends): if (plot_freq_mhz[s] in f) or (plot_freq_mhz[e] in f): - ax[0].axvspan(plot_freq_mhz[s], plot_freq_mhz[e], color='k', - alpha=.1) - ax[1].axvspan(plot_freq_mhz[s], plot_freq_mhz[e], color='k', - alpha=.1) + ax[0].axvspan(plot_freq_mhz[s], plot_freq_mhz[e], + color='k', alpha=.1) + ax[1].axvspan(plot_freq_mhz[s], plot_freq_mhz[e], + color='k', alpha=.1) for pp in peak: if plot_freq_mhz[pp] > sbf - plot_width/2. and \ @@ -1035,9 +868,10 @@ def find_peak(self, freq, resp, rolling_med=True, window=5000, ax[1].plot(ff+sbc[1][sb], np.abs(dd)/2.5E6) if save_plot: - save_name = '{}_find_freq_b{}_sb{:03}.png'.format(timestamp, band, sb) - plt.savefig(os.path.join(self.plot_dir, save_name), - bbox_inches='tight') + save_name = f'{timestamp}_find_freq_b{band}_sb{sb:03}.png' + os.path.join(self.plot_dir, save_name) + plt.savefig(path, bbox_inches='tight') + self.pub.register_file(path, 'find_freq', plot=True) plt.close() else: self.log('No data for subband {}'.format(sb)) @@ -1087,8 +921,11 @@ def find_flag_blocks(self, flag, minimum=None, min_gap=None): else: return start,end + def pad_flags(self, f, before_pad=0, after_pad=0, min_gap=0, min_length=0): """ + Adds and combines flagging. + Args: ----- f (bool array): The flag array to pad @@ -1137,17 +974,17 @@ def plot_find_peak(self, freq, resp, peak_ind, save_plot=True, save_plot (bool): Whether to save the plot save_name (str): THe name of the plot """ - import matplotlib.pyplot as plt - if save_plot: plt.ioff() else: plt.ion() + # Break out components Idat = np.real(resp) Qdat = np.imag(resp) phase = np.unwrap(np.arctan2(Qdat, Idat)) + # Plot fig, ax = plt.subplots(2, sharex=True, figsize=(6,4)) ax[0].plot(freq, np.abs(resp), label='amp', color='b') ax[0].plot(freq, Idat, label='I', color='r', linestyle=':', alpha=.5) @@ -1174,10 +1011,14 @@ def plot_find_peak(self, freq, resp, peak_ind, save_plot=True, save_name = 'find_peak.png' else: self.log('Plotting saved to {}'.format(save_name)) - plt.savefig(os.path.join(self.plot_dir, save_name), - bbox_inches='tight') + + path = os.path.join(self.plot_dir, save_name) + plt.savefig(path, bbox_inches='tight') + self.pub.register_file(path, 'find_freq', plot=True) + plt.close() + def eta_fit(self, freq, resp, peak_freq, delta_freq, make_plot=False, plot_chans=[], save_plot=True, band=None, timestamp=None, res_num=None, use_slow_eta=False): @@ -1257,13 +1098,9 @@ def eta_fit(self, freq, resp, peak_freq, delta_freq, peak_freq*1.0E-6+band_center) # Get eta parameters - # w = 5 - # eta = (np.mean(freq[right-w:right+w]) - np.mean(freq[left-w:left+w]))/ \ - # (np.mean(resp[right-w:right+w]) - np.mean(resp[left-w:left+w])) latency = (np.unwrap(np.angle(resp))[-1] - \ np.unwrap(np.angle(resp))[0]) / (freq[-1] - freq[0])/2/np.pi eta_mag = np.abs(eta) - # eta_mag /= (10*np.log10( uc_att / 2 ) ) eta_angle = np.angle(eta) eta_scaled = eta_mag / subband_half_width eta_phase_deg = eta_angle * 180 / np.pi @@ -1327,9 +1164,6 @@ def plot_eta_fit(self, freq, resp, eta=None, eta_mag=None, peak_freq=None, band (int): The band number to label the plot sk_fit (flot array): The fit parameters for the skewe lorentzian """ - import matplotlib.pyplot as plt - from matplotlib.gridspec import GridSpec - if timestamp is None: timestamp = self.get_timestamp() @@ -1337,7 +1171,6 @@ def plot_eta_fit(self, freq, resp, eta=None, eta_mag=None, peak_freq=None, plt.ion() else: plt.ioff() - I = np.real(resp) @@ -1377,12 +1210,12 @@ def plot_eta_fit(self, freq, resp, eta=None, eta_mag=None, peak_freq=None, # phase plot, since we typically look at it when trying to # optimize them. bbox = dict(boxstyle="round", ec='w', fc='w', alpha=.65) - ax1.text(.03, .15, 'refPhaseDelay={}'.format(self.get_ref_phase_delay(band)), - transform=ax1.transAxes, fontsize=8, - bbox=bbox) - ax1.text(.03, .05, 'refPhaseDelayFine={}'.format(self.get_ref_phase_delay_fine(band)), - transform=ax1.transAxes, fontsize=8, - bbox=bbox) + ax1.text(.03, .15, + 'refPhaseDelay={}'.format(self.get_ref_phase_delay(band)), + transform=ax1.transAxes, fontsize=8, bbox=bbox) + ax1.text(.03, .05, + 'refPhaseDelayFine={}'.format(self.get_ref_phase_delay_fine(band)), + transform=ax1.transAxes, fontsize=8, bbox=bbox) # IQ circle ax2.axhline(0, color='k', linestyle=':', alpha=.5) @@ -1453,8 +1286,10 @@ def plot_eta_fit(self, freq, resp, eta=None, eta_mag=None, peak_freq=None, res_num) else: save_name = '{}_eta.png'.format(timestamp) - plt.savefig(os.path.join(self.plot_dir, save_name), - bbox_inches='tight') + + path = os.path.join(self.plot_dir, save_name) + plt.savefig(path, bbox_inches='tight') + self.pub.register_file(path, 'eta', plot=True) if not show_plot: plt.close() @@ -1524,6 +1359,10 @@ def get_master_assignment(self, band): """ Returns the master assignment list. + Args: + ----- + band (int) : The band number + Ret: ---- freqs (float array): The frequency of the resonators @@ -1531,13 +1370,14 @@ def get_master_assignment(self, band): channels (int array): The channels the resonators are assigned to groups (int array): The bias group the channel is in """ - fn = self.channel_assignment_files['band_%i' % (band)] - self.log('Drawing channel assignments from {}'.format(fn)) - d = np.loadtxt(fn,delimiter=',') + fn = self.channel_assignment_files[f'band_{band}'] + self.log(f'Drawing channel assignments from {fn}') + d = np.loadtxt(fn, delimiter=',') freqs = d[:,0] subbands = d[:,1].astype(int) channels = d[:,2].astype(int) groups = d[:,3].astype(int) + return freqs, subbands, channels, groups @@ -1595,16 +1435,19 @@ def assign_channels(self, freq, band=None, bandcenter=None, sb = subbands_master[i] subbands[idx] = sb g = groups_master[i] - sb_center = self.get_subband_centers(band,as_offset=as_offset)[1][sb] + sb_center = self.get_subband_centers(band, + as_offset=as_offset)[1][sb] offsets[idx] = f-sb_center - self.log('Matching {:.2f} MHz to {:.2f} MHz in master channel list: assigning to subband {}, ch. {}, group {}'.format(f,f_master,\ - sb,ch,g)) + self.log(f'Matching {f:.2f} MHz to {f_master:.2f} MHz' + + ' in master channel list: assigning to ' + + f'subband {sb}, ch. {ch}, group {g}') found_match = True break if not found_match: n_unmatched += 1 self.log('No match found for {:.2f} MHz'.format(f)) - self.log('No channel assignment for {} of {} resonances.'.format(n_unmatched,n_freqs)) + self.log(f'No channel assignment for {n_unmatched} of {n_freqs}'+ + ' resonances.') else: d_freq = np.diff(freq) close_idx = d_freq > min_offset @@ -1632,6 +1475,7 @@ def assign_channels(self, freq, band=None, bandcenter=None, channels[mask[:len(chans)]] = chans # Prune channels that are too close + print(close_idx) channels[~close_idx] = -1 # write the channel assignments to file @@ -1640,30 +1484,44 @@ def assign_channels(self, freq, band=None, bandcenter=None, return subbands, channels, offsets - def write_master_assignment(self, band, freqs, subbands, channels, groups=None): + def write_master_assignment(self, band, freqs, subbands, channels, + groups=None): ''' - writes a comma-separated list in the form band, freq (MHz), subband, channel, group. - Group number defaults to -1. + writes a comma-separated list in the form band, freq (MHz), subband, + channel, group. Group number defaults to -1. ''' timestamp = self.get_timestamp() if groups is None: groups = -np.ones(len(freqs),dtype=int) - #fn = self.channel_assignment_files['band_%i' % (band)] fn = os.path.join(self.tune_dir, - '{}_channel_assignment_b{}.txt'.format(timestamp, int(band))) + f'{timestamp}_channel_assignment_b{band}.txt') self.log('Writing new channel assignment to {}'.format(fn)) f = open(fn,'w') for i in range(len(channels)): - f.write('%.4f,%i,%i,%i\n' % (freqs[i],subbands[i],channels[i],groups[i])) + f.write('%.4f,%i,%i,%i\n' % (freqs[i],subbands[i],channels[i], + groups[i])) f.close() - #self.channel_assignment_files['band_{}'.format(band)] = fn self.load_master_assignment(band, fn) def make_master_assignment_from_file(self, band, tuning_filename): - self.log('Drawing band-{} tuning data from {}'.format(band,tuning_filename)) + """ + Makes a master assignment file + + Args: + ----- + band (int) : The band number + tuning_filename : The tuning file to use for generating the + master_assignemnt + """ + self.log('Drawing band-{} tuning data from {}'.format(band, + tuning_filename)) + + # Load the tuning file d = np.load(tuning_filename).item()[band]['resonances'] + + # Extrac the values from the tuning file freqs = [] subbands = [] channels = [] @@ -1671,6 +1529,7 @@ def make_master_assignment_from_file(self, band, tuning_filename): freqs.append(d[i]['freq']) subbands.append(d[i]['subband']) channels.append(d[i]['channel']) + self.write_master_assignment(band, freqs, subbands, channels) @@ -1691,15 +1550,17 @@ def get_group_number(self,band,ch): def write_group_assignment(self,band,group,ch_list): ''' - Combs master channel assignment and assigns group number to all channels in ch_list. Does not affect other channels in the master file. + Combs master channel assignment and assigns group number to all channels + in ch_list. Does not affect other channels in the master file. ''' - freqs_master,subbands_master,channels_master,groups_master = self.get_master_assignment(band) + freqs_master, subbands_master, channels_master, groups_master = self.get_master_assignment(band) for i in range(len(ch_list)): for j in range(len(channels_master)): if ch_list[i] == channels_master[j]: groups_master[j] = group break - self.write_master_assignment(band,freqs_master,subbands_master,channels_master,groups=groups_master) + self.write_master_assignment(band,freqs_master,subbands_master, + channels_master,groups=groups_master) def compare_tune(self, tune, ref_tune=None, make_plot=False): """ @@ -1713,8 +1574,6 @@ def compare_tune(self, tune, ref_tune=None, make_plot=False): res2 = self.freq_resp if make_plot: - import matplotlib.pyplot as plt - plt_freq = freq * 1.0E-6 fig, ax = plt.subplots(2, sharex=True, figsize=(6,5)) ax[0].plot(plt_freq, np.abs(resp)) @@ -2065,7 +1924,7 @@ def eta_scan(self, band, subband, freq, drive, write_log=False, return rr, ii - def flux_ramp_check(self, band, reset_rate_khz=4, + def flux_ramp_check(self, band, reset_rate_khz=None, fraction_full_scale=None, flux_ramp=True, save_plot=True, show_plot=False): """ @@ -2086,13 +1945,15 @@ def flux_ramp_check(self, band, reset_rate_khz=4, save_plot (bool) : Whether to save the plot. Default True. show_plot (bool) : Whether to show the plot. Default False. """ - import matplotlib.pyplot as plt - from matplotlib.gridspec import GridSpec if show_plot: plt.ion() else: plt.ioff() + if reset_rate_khz is None: + reset_rate_khz = self.reset_rate_khz + self.log('reset_rate_khz is None. ', + f'Using default: {reset_rate_khz}') n_channels = self.get_number_channels(band) old_fb = self.get_feedback_enable_array(band) @@ -2179,27 +2040,34 @@ def flux_ramp_check(self, band, reset_rate_khz=4, save_name = save_name + '_no_FR' save_name = save_name+ \ '_b{}_sb{:03}_flux_ramp_check.png'.format(band, sb) - plt.savefig(os.path.join(self.plot_dir, save_name), - bbox_inches='tight') + path = os.path.join(self.plot_dir, save_name) + plt.savefig(path, bbox_inches='tight') + self.pub.register_file(path, 'flux_ramp', plot=True) + if not show_plot: plt.close() return d, df, sync - def tracking_setup(self, band, channel=None, reset_rate_khz=4., write_log=False, - make_plot=False, save_plot=True, show_plot=True, nsamp=2**19, - lms_freq_hz=None, meas_lms_freq=False, flux_ramp=True, fraction_full_scale=None, - lms_enable1=True, lms_enable2=True, lms_enable3=True, lms_gain=7, - return_data=True, new_epics_root=None, + def tracking_setup(self, band, channel=None, reset_rate_khz=None, + write_log=False, make_plot=False, save_plot=True, show_plot=True, + nsamp=2**19, lms_freq_hz=None, meas_lms_freq=False, flux_ramp=True, + fraction_full_scale=None, lms_enable1=True, lms_enable2=True, + lms_enable3=True, lms_gain=None, return_data=True, new_epics_root=None, feedback_start_frac=None, feedback_end_frac=None): """ + The function to start tracking. Starts the flux ramp and if requested + attempts to measure the lms (demodulation) frequency. Otherwise this + just tracks at the input lms frequency. This will also make plots for + the channels listed in {channel} input. + Args: ----- band (int) : The band number - channel (int) : The channel to check Opt Args: --------- + channel (int) : The channel to check reset_rate_khz (float) : The flux ramp frequency write_log (bool) : Whether to write output to the log. Default False. make_plot (bool) : Whether to make plots. Default False. @@ -2216,7 +2084,8 @@ def tracking_setup(self, band, channel=None, reset_rate_khz=4., write_log=False, Default True. lms_enable3 (bool) : Whether to use the third harmonic for tracking. Default True. - lms_gain (int) : The tracking gain parameters. Default 7. + lms_gain (int) : The tracking gain parameters. Default is the value + in the config table. feedback_start_frac (float) : The fraction of the full flux ramp at which to stop applying feedback in each flux ramp cycle. Must be in [0,1). Defaults to whatever's in the cfg @@ -2228,7 +2097,11 @@ def tracking_setup(self, band, channel=None, reset_rate_khz=4., write_log=False, carrier rate using the flux_mod2 function. Default false. lms_freq_hz must be None. """ - + if reset_rate_khz is None: + reset_rate_khz = self.reset_rate_khz + if lms_gain is None: + lms_gain = self.lms_gain[band] + ## ## Load unprovided optional args from cfg if feedback_start_frac is None: @@ -2260,7 +2133,6 @@ def tracking_setup(self, band, channel=None, reset_rate_khz=4., write_log=False, self.log('WARNING: THIS WILL NOT TURN ON FLUX RAMP!') if make_plot: - import matplotlib.pyplot as plt if show_plot: plt.ion() else: @@ -2335,7 +2207,6 @@ def tracking_setup(self, band, channel=None, reset_rate_khz=4., write_log=False, df_std = np.std(df, 0) - #downselect_channels = self.get_downselect_channels() df_channels = np.ravel(np.where(df_std >0)) channels_on = list(set(df_channels) & set(self.which_on(band))) @@ -2348,57 +2219,74 @@ def tracking_setup(self, band, channel=None, reset_rate_khz=4., write_log=False, timestamp = self.get_timestamp() fig,ax = plt.subplots(1,3,figsize = (12,5)) - fig.suptitle('LMS freq = {:.0f} Hz, n_channels = {}'.format(lms_freq_hz,len(channels_on))) + fig.suptitle('LMS freq = {:.0f} Hz, n_channels = {}'.format(lms_freq_hz, + len(channels_on))) + # Histogram the stddev ax[0].hist(df_std[channels_on] * 1e3,bins = 20,edgecolor = 'k') ax[0].set_xlabel('Flux ramp demod error std (kHz)') ax[0].set_ylabel('number of channels') + # Histogram the max-min flux ramp amplitude response ax[1].hist(f_span[channels_on] * 1e3,bins = 20,edgecolor='k') ax[1].set_xlabel('Flux ramp amplitude (kHz)') ax[1].set_ylabel('number of channels') + # Plot df vs resp amplitude ax[2].plot(f_span[channels_on]*1e3, df_std[channels_on]*1e3, '.') ax[2].set_xlabel('FR Amp (kHz)') ax[2].set_ylabel('RF demod error (kHz)') x = np.array([0, np.max(f_span[channels_on])*1.0E3]) + + # useful line to guide the eye y_factor = 100 y = x/y_factor - ax[2].plot(x,y, color='k', linestyle=':',label='1:%i' % (y_factor)) + ax[2].plot(x, y, color='k', linestyle=':',label=f'1:{y_factor}') ax[2].legend(loc='best') fig.tight_layout(rect=[0, 0.03, 1, 0.95]) if save_plot: - plt.savefig(os.path.join(self.plot_dir, timestamp + - '_FR_amp_v_err.png'),bbox_inches='tight') + path = os.path.join(self.plot_dir, + timestamp + '_FR_amp_v_err.png') + plt.savefig(path, bbox_inches='tight') + self.pub.register_file(path, 'amp_vs_err', plot=True) + if not show_plot: + # If we don't want a live view, close the plot plt.close() if channel is not None: channel = np.ravel(np.array(channel)) - self.log("Taking data on single channel number {}".format(channel), - self.LOG_USER) sync_idx = self.make_sync_flag(sync) bbox = dict(boxstyle="round", ec='w', fc='w', alpha=.65) for ch in channel: - fig, ax = plt.subplots(2, sharex=True, figsize=(9,4.75)) + # Setup plotting + fig, ax = plt.subplots(2, sharex=True, figsize=(9, 4.75)) + + # Plot tracked component ax[0].plot(f[:, ch]*1e3) ax[0].set_ylabel('Tracked Freq [kHz]') - ax[0].text(.025, .9, 'LMS Freq {:.0f} Hz'.format(lms_freq_hz), fontsize=10, - transform=ax[0].transAxes, bbox=bbox, ha='left', va='top') + ax[0].text(.025, .9, + 'LMS Freq {:.0f} Hz'.format(lms_freq_hz), fontsize=10, + transform=ax[0].transAxes, bbox=bbox, ha='left', + va='top') - ax[0].text(.95, .9, 'Band {} Ch {:03}'.format(band, ch), fontsize=10, - transform=ax[0].transAxes, ha='right', va='top', bbox=bbox) + ax[0].text(.95, .9, 'Band {} Ch {:03}'.format(band, ch), + fontsize=10, transform=ax[0].transAxes, ha='right', + va='top', bbox=bbox) + # Plot the untracking part ax[1].plot(df[:, ch]*1e3) ax[1].set_ylabel('Freq Error [kHz]') ax[1].set_xlabel('Samp Num') - ax[1].text(.025, .9, 'RMS error = {:.2f} kHz\n'.format(df_std[ch]*1e3) + - 'FR frac. full scale = {:.2f}'.format(fraction_full_scale), - fontsize=10, transform=ax[1].transAxes, bbox=bbox, ha='left', va='top') + ax[1].text(.025, .9, + f'RMS error = {df_std[ch]*1e3:.2f} kHz\n' + + f'FR frac. full scale = {fraction_full_scale:.2f}', + fontsize=10, transform=ax[1].transAxes, bbox=bbox, + ha='left', va='top') n_sync_idx = len(sync_idx) for i, s in enumerate(sync_idx): @@ -2417,9 +2305,11 @@ def tracking_setup(self, band, channel=None, reset_rate_khz=4., write_log=False, plt.tight_layout() if save_plot: - plt.savefig(os.path.join(self.plot_dir, timestamp + - '_FRtracking_band{}_ch{:03}.png'.format(band,ch)), - bbox_inches='tight') + path = os.path.join(self.plot_dir, timestamp + + '_FRtracking_band{}_ch{:03}.png'.format(band,ch)) + plt.savefig(path, bbox_inches='tight') + self.pub.register_file(path, 'tracking', plot=True) + if not show_plot: plt.close() @@ -2428,14 +2318,17 @@ def tracking_setup(self, band, channel=None, reset_rate_khz=4., write_log=False, if return_data: return f, df, sync - def track_and_check(self, band, channel=None, reset_rate_khz=4., + def track_and_check(self, band, channel=None, reset_rate_khz=None, make_plot=False, save_plot=True, show_plot=True, lms_freq_hz=None, flux_ramp=True, fraction_full_scale=None, - lms_enable1=True, lms_enable2=True, lms_enable3=True, lms_gain=7, + lms_enable1=True, lms_enable2=True, lms_enable3=True, lms_gain=None, f_min=.015, f_max=.2, df_max=.03, toggle_feedback=True, - relock=True,tracking_setup=True): + relock=True, tracking_setup=True, + feedback_start_frac=None, feedback_end_frac=None): """ - This runs tracking setup and check_lock to prune bad channels. + This runs tracking setup and check_lock to prune bad channels. This has + all the same inputs and tracking_setup and check_lock. In particular the + cut parameters are f_min, f_max, and df_max. Args: ----- @@ -2443,46 +2336,87 @@ def track_and_check(self, band, channel=None, reset_rate_khz=4., Opt Args: --------- - reset_rate_khz (float); The flux ramp reset rate. channel (int or int array): List of channels to plot. - toggle_feedback (bool): Whether or not to reset feedback (both - the global band feedbackEnable and the - lmsEnables between tracking_setup and - check_lock. - relock (bool): Whether or not to relock at the start. - Default True. - tracking_setup (bool): Whether or not to run tracking_setup. - Default True. + toggle_feedback (bool): Whether or not to reset feedback (both the + global band feedbackEnable and the lmsEnables between tracking_setup + and check_lock. + relock (bool): Whether or not to relock at the start. Default True. + tracking_setup (bool): Whether or not to run tracking_setup. Default + True. + reset_rate_khz (float) : The flux ramp frequency + write_log (bool) : Whether to write output to the log. Default False. + make_plot (bool) : Whether to make plots. Default False. + save_plot (bool) : Whether to save plots. Default True. + show_plot (bool) : Whether to display the plot. Default True. + lms_freq_hz (float) : The frequency of the tracking algorithm. + Default is 4000 + flux_ramp (bool) : Whether to turn on flux ramp. Default True. + fraction_full_scale (float) : The flux ramp amplitude, as a + fraction of the maximum. Default is .4950. + lms_enable1 (bool) : Whether to use the first harmonic for tracking. + Default True. + lms_enable2 (bool) : Whether to use the second harmonic for tracking. + Default True. + lms_enable3 (bool) : Whether to use the third harmonic for tracking. + Default True. + lms_gain (int) : The tracking gain parameters. Default is the value + in the config file + feedback_start_frac (float) : The fraction of the full flux + ramp at which to stop applying feedback in each flux ramp + cycle. Must be in [0,1). Defaults to whatever's in the cfg + file. + feedback_end_frac (float) : The fraction of the full flux ramp + at which to stop applying feedback in each flux ramp cycle. + Must be >0. Defaults to whatever's in the cfg file. + meas_lms_freq (bool) : Whether or not to try to estimate the + carrier rate using the flux_mod2 function. Default false. + lms_freq_hz must be None. + f_min (float) : The maximum frequency swing. + f_max (float) : The minimium frequency swing + df_max (float) : The maximum value of the stddev of df """ + if reset_rate_khz is None: + reset_rate_khz = self.reset_rate_khz + if lms_gain is None: + lms_gain = self.lms_gain[band] + if relock: self.relock(band) + # Start tracking if tracking_setup: self.tracking_setup(band, channel=channel, - reset_rate_khz=reset_rate_khz, - make_plot=make_plot, save_plot=save_plot, - show_plot=show_plot, - lms_freq_hz=lms_freq_hz, flux_ramp=flux_ramp, - fraction_full_scale=fraction_full_scale, - lms_enable1=lms_enable1, lms_enable2=lms_enable2, - lms_enable3=lms_enable3, - lms_gain=lms_gain, return_data=False) - + reset_rate_khz=reset_rate_khz, make_plot=make_plot, + save_plot=save_plot, show_plot=show_plot, + lms_freq_hz=lms_freq_hz, flux_ramp=flux_ramp, + fraction_full_scale=fraction_full_scale, lms_enable1=lms_enable1, + lms_enable2=lms_enable2, lms_enable3=lms_enable3, + lms_gain=lms_gain, return_data=False, + feedback_start_frac=feedback_start_frac, + feedback_end_frac=feedback_end_frac) + + # Toggle the feedback because sometimes tracking exits in a bad state. + # I'm not sure if this is still the case, but no reason to stop doing + # this. -EY 20191001 if toggle_feedback: self.toggle_feedback(band) + # Check the lock status and cut channels based on inputs. self.check_lock(band, f_min=f_min, f_max=f_max, df_max=df_max, - make_plot=make_plot, flux_ramp=flux_ramp, - fraction_full_scale=fraction_full_scale, - lms_freq_hz=lms_freq_hz, - reset_rate_khz=reset_rate_khz) + make_plot=make_plot, flux_ramp=flux_ramp, + fraction_full_scale=fraction_full_scale, lms_freq_hz=lms_freq_hz, + reset_rate_khz=reset_rate_khz, + feedback_start_frac=feedback_start_frac, + feedback_end_frac=feedback_end_frac) + def eta_phase_check(self, band, rot_step_size=30, rot_max=360, - reset_rate_khz=4., - fraction_full_scale=None, - flux_ramp=True): + reset_rate_khz=None, fraction_full_scale=None, flux_ramp=True): """ """ + if reset_rate_khz is None: + reset_rate_khz = self.reset_rate_khz + ret = {} eta_phase0 = self.get_eta_phase_array(band) @@ -2503,12 +2437,13 @@ def eta_phase_check(self, band, rot_step_size=30, rot_max=360, eta_phase[c] = tools.limit_phase_deg(eta_phase0[c] + r) self.set_eta_phase_array(band, eta_phase) - d, df, sync = self.tracking_setup(band,0, reset_rate_khz=reset_rate_khz, - fraction_full_scale=fraction_full_scale, - make_plot=False, - save_plot=False, show_plot=False, - lms_enable1=False, lms_enable2=False, - lms_enable3=False, flux_ramp=flux_ramp) + d, df, sync = self.tracking_setup(band,0, + reset_rate_khz=reset_rate_khz, + fraction_full_scale=fraction_full_scale, + make_plot=False, save_plot=False, show_plot=False, + lms_enable1=False, lms_enable2=False, lms_enable3=False, + flux_ramp=flux_ramp) + ret['data'][r] = {} ret['data'][r]['df'] = df ret['data'][r]['sync'] = sync @@ -2521,8 +2456,6 @@ def eta_phase_check(self, band, rot_step_size=30, rot_max=360, def analyze_eta_phase_check(self, dat, channel): """ """ - import matplotlib.pyplot as plt - keys = dat['data'].keys() band = dat['band'] n_keys = len(keys) @@ -2589,7 +2522,8 @@ def unset_fixed_flux_ramp_bias(self,acCouple=True): time.sleep(self._cryo_card_relay_wait) - def set_fixed_flux_ramp_bias(self,fractionFullScale,debug=True, do_config=True): + def set_fixed_flux_ramp_bias(self,fractionFullScale,debug=True, + do_config=True): """ ??? @@ -2651,12 +2585,27 @@ def set_fixed_flux_ramp_bias(self,fractionFullScale,debug=True, do_config=True): self.set_flux_ramp_dac(LTC1668RawDacData) def flux_ramp_setup(self, reset_rate_khz, fraction_full_scale, df_range=.1, - do_read=False, band=2, write_log=False, new_epics_root=None): + band=2, write_log=False, new_epics_root=None): """ Set flux ramp sawtooth rate and amplitude. If there are errors, check that you are using an allowed reset rate! Not all rates are allowed. Allowed rates: 1, 2, 3, 4, 5, 6, 8, 10, 12, 15 kHz + + Args: + ----- + reset_rate_khz (int) : The flux ramp rate to set in kHz. The allowable + values are 1, 2, 3, 4, 5, 6, 8, 10, 12, 15 kHz + fraction_full_scale (float) : The amplitude of the flux ramp as a + fraction of the maximum possible value. + + Opt Args: + --------- + df_range (float) : + band (int) : The band to setup the flux ramp on. + write_log (bool) : Whether to write output to the log + new_epics_root (str) : Override the original epics root. + """ # Disable flux ramp @@ -2758,16 +2707,28 @@ def flux_ramp_setup(self, reset_rate_khz, fraction_full_scale, df_range=.1, def get_fraction_full_scale(self, new_epics_root=None): """ - Returns the fraction_full_scale + Returns the fraction_full_scale. + + Opt Args: + --------- + new_epics_root (str) : Overrides the initialized epics root. + + Ret: + ---- + fraction_full_scale (float) : The fraction of the flux ramp amplitude """ return 1-2*(self.get_fast_slow_rst_value(new_epics_root=new_epics_root)/ 2**self.num_flux_ramp_counter_bits) + def check_lock(self, band, f_min=.015, f_max=.2, df_max=.03, make_plot=False, flux_ramp=True, fraction_full_scale=None, - lms_freq_hz=None, reset_rate_khz=4., **kwargs): + lms_freq_hz=None, reset_rate_khz=None, feedback_start_frac=None, + feedback_end_frac=None, **kwargs): """ - Checks the bad resonators + Takes a tracking setup and turns off channels that have bad + tracking. The limits are set by the variables f_min, f_max, + and df_max. The output is stored to freq_resp[band]['lock_status'] dict. Args: ----- @@ -2782,9 +2743,18 @@ def check_lock(self, band, f_min=.015, f_max=.2, df_max=.03, flux_ramp (bool) : Whether to flux ramp or not. Default True faction_full_scale (float): Number between 0 and 1. The amplitude of the flux ramp. + lms_freq_hz (float) : The tracking frequency in Hz. Default is None + reset_rate_khz (float) : The flux ramp reset rate in kHz. + feedback_start_frac (float) : What fraction of the flux ramp to + skip before feedback. Float between 0 and 1. + feedback_end_frac (float) : What fraction of the flux ramp to skip + at the end of feedback. Float between 0 and 1. """ self.log('Checking lock on band {}'.format(band)) + if reset_rate_khz is None: + reset_rate_khz = self.reset_rate_khz + if fraction_full_scale is None: fraction_full_scale = self.fraction_full_scale @@ -2797,29 +2767,22 @@ def check_lock(self, band, f_min=.015, f_max=.2, df_max=.03, self.log('Currently {} channels on'.format(n_chan)) # Tracking setup returns information on all channels in a band - f, df, sync = self.tracking_setup(band, 0, make_plot=False, + f, df, sync = self.tracking_setup(band, make_plot=False, flux_ramp=flux_ramp, fraction_full_scale=fraction_full_scale, - lms_freq_hz=lms_freq_hz, reset_rate_khz=reset_rate_khz) + lms_freq_hz=lms_freq_hz, reset_rate_khz=reset_rate_khz, + feedback_start_frac=feedback_start_frac, + feedback_end_frac=feedback_end_frac) high_cut = np.array([]) low_cut = np.array([]) df_cut = np.array([]) - if make_plot: - import matplotlib.pyplot as plt - + # Make cuts for ch in channels: f_chan = f[:,ch] f_span = np.max(f_chan) - np.min(f_chan) df_rms = np.std(df[:,ch]) - # self.log('Ch {} f_span {} df_rms {}'.format(ch, f_span, df_rms)) - - if make_plot: - plt.figure() - plt.plot(f_chan) - plt.title(ch) - if f_span > f_max: self.set_amplitude_scale_channel(band, ch, 0, **kwargs) high_cut = np.append(high_cut, ch) @@ -2829,8 +2792,6 @@ def check_lock(self, band, f_min=.015, f_max=.2, df_max=.03, elif df_rms > df_max: self.set_amplitude_scale_channel(band, ch, 0, **kwargs) df_cut = np.append(df_cut, ch) - #else: - # self.log('Ch {:03} acceptable: {:4.3f}'.format(ch, f_span)) chan_after = self.which_on(band) @@ -2843,6 +2804,7 @@ def check_lock(self, band, f_min=.015, f_max=.2, df_max=.03, self.log('df cut count: {}'.format(len(df_cut))) self.log('Started with {}. Now {}'.format(n_chan, len(chan_after))) + # Store the data in freq_resp timestamp = self.get_timestamp(as_int=True) self.freq_resp[band]['lock_status'][timestamp] = { 'action' : 'check_lock', @@ -2896,7 +2858,8 @@ def find_freq(self, band, subband=np.arange(13,115), drive_power=None, if drive_power is None: drive_power = self.config.get('init')['band_{}'.format(band)].get('amplitude_scale') - self.log('No drive_power given. Using value in config file: {}'.format(drive_power)) + self.log(f'No drive_power given. Using value in config ' + + 'file: {drive_power}') self.log('Sweeping across frequencies') f, resp = self.full_band_ampl_sweep(band, subband, drive_power, n_read) @@ -2905,10 +2868,14 @@ def find_freq(self, band, subband=np.arange(13,115), drive_power=None, # Save data save_name = '{}_amp_sweep_{}.txt' - np.savetxt(os.path.join(self.output_dir, - save_name.format(timestamp, 'freq')), f) - np.savetxt(os.path.join(self.output_dir, - save_name.format(timestamp, 'resp')), resp) + + path = os.path.join(self.output_dir, save_name.format(timestamp, 'freq')) + np.savetxt(path, f) + self.pub.register_file(path, 'sweep_response', format='txt') + + path = os.path.join(self.output_dir, save_name.format(timestamp, 'resp')) + np.savetxt(path, resp) + self.pub.register_file(path, 'sweep_response', format='txt') # Place in dictionary - dictionary declared in smurf_control self.freq_resp[band]['find_freq'] = {} @@ -2921,16 +2888,18 @@ def find_freq(self, band, subband=np.arange(13,115), drive_power=None, else: self.freq_resp[band]['find_freq']['timestamp'] = np.array([timestamp]) - # Find resonances + # Find resonator peaks res_freq = self.find_all_peak(self.freq_resp[band]['find_freq']['f'], - self.freq_resp[band]['find_freq']['resp'], subband, make_plot=make_plot, - band=band, rolling_med=rolling_med, window=window, make_subband_plot=make_subband_plot, amp_cut=0.1) + self.freq_resp[band]['find_freq']['resp'], subband, + make_plot=make_plot, band=band, rolling_med=rolling_med, + window=window, make_subband_plot=make_subband_plot) self.freq_resp[band]['find_freq']['resonance'] = res_freq # Save resonances - np.savetxt(os.path.join(self.output_dir, - save_name.format(timestamp, 'resonance')), - self.freq_resp[band]['find_freq']['resonance']) + path = os.path.join(self.output_dir, + save_name.format(timestamp, 'resonance')) + np.savetxt(path, self.freq_resp[band]['find_freq']['resonance']) + self.pub.register_file(path, 'resonances', format='txt') # Call plotting if make_plot: @@ -2950,8 +2919,8 @@ def plot_find_freq(self, f=None, resp=None, subband=None, filename=None, To do: Add ability to use timestamp and multiple plots - Optional Args: - -------------- + Opt Args: + --------- save_plot (bool) : save the plot. Default True. save_name (string) : What to name the plot. default find_freq.png ''' @@ -2966,7 +2935,6 @@ def plot_find_freq(self, f=None, resp=None, subband=None, filename=None, if filename is not None: f, resp = np.load(filename) - import matplotlib.pyplot as plt cm = plt.cm.get_cmap('viridis') fig = plt.figure(figsize=(10,4)) @@ -2979,8 +2947,9 @@ def plot_find_freq(self, f=None, resp=None, subband=None, filename=None, plt.ylabel("Normalized Amplitude") if save_plot: - plt.savefig(os.path.join(self.plot_dir, save_name), - bbox_inches='tight') + path = os.path.join(self.plot_dir, save_name) + plt.savefig(path, bbox_inches='tight') + self.pub.register_file(path, 'response', plot=True) if show_plot: plt.show() @@ -3029,156 +2998,6 @@ def full_band_ampl_sweep(self, band, subband, drive, n_read, n_step=121): return freq, resp - def peak_finder(self, x, y, threshold): - """finds peaks in x,y data with some threshhold - - Not currently being used - """ - in_peak = 0 - - peakstruct_max = [] - peakstruct_nabove = [] - peakstruct_freq = [] - - for idx in range(len(y)): - freq = x[idx] - amp = y[idx] - - if in_peak == 0: - pk_max = 0 - pk_freq = 0 - pk_nabove = 0 - - if amp > threshold: - if in_peak == 0: # start a new peak - n_peaks = n_peaks + 1 - - in_peak = 1 - pk_nabove = pk_nabove + 1 - - if amp > pk_max: # keep moving until find the top - pk_max = amp - pk_freq = freq - - if idx == len(y) or y[idx + 1] < threshhold: - peakstruct_max.append(pk_max) - peakstruct_nabove.append(pk_nabove) - peakstruct_freq.append(pk_freq) - in_peak = 0 - return peakstruct_max, peakstruct_nabove, peakstruct_freq - - def find_peak_2(self, freq, resp, normalize=False, - n_samp_drop=1, threshold=.5, margin_factor=1., phase_min_cut=1, - phase_max_cut=1, make_plot=False, save_plot=True, save_name=None): - """find the peaks within a given subband - - Args: - ----- - freq (vector): should be a single row of the broader freq array - response (complex vector): complex response for just this subband - - Optional Args: - -------------- - normalize (bool) : - n_samp_drop (int) : - threshold (float) : - margin_factor (float): - phase_min_cut (int) : - phase_max_cut (int) : - - Returns: - -------_ - resonances (list of floats) found in this subband - """ - resp_input = np.copy(resp) - if np.isnan(resp).any(): - if np.isnan(resp).all(): - self.log("Warning - All values are NAN. Skipping", - self.LOG_ERROR) - return - self.log("Warning - at least one NAN. Interpolating...", - self.LOG_ERROR) - idx = ~np.isnan(resp) - resp = np.interp(freq, freq[idx], resp[idx]) - - # This was what was in Cyndia and Shawns code. Im deprecating this - # for now. - # df = freq[1] - freq[0] - # Idat = np.real(resp) - # Qdat = np.imag(resp) - # phase = np.unwrap(np.arctan2(Qdat, Idat)) - - # diff_phase = np.diff(phase) - # diff_freq = np.add(freq[:-1], df / 2) # lose an index from diff - - # if normalize==True: - # norm_min = min(diff_phase[nsampdrop:-nsampdrop]) - # norm_max = max(diff_phase[nsampdrop:-nsampdrop]) - - # diff_phase = (diff_phase - norm_min) / (norm_max - norm_min) - # - # peakstruct_max, peakstruct_nabove, peakstruct_freq = \ - # self.peak_finder(diff_freq, diff_phase, threshold) - - # return peakstruct_max, peakstruct_nabove, peakstruct_freq - - # For now use scipy - needs scipy - # hardcoded values should be exposed in some meaningful way - - import scipy.signal as signal - peak_ind, props = signal.find_peaks(-np.abs(resp), distance=10, - prominence=.025) - - if make_plot: - self.plot_find_peak(freq, resp_input, peak_ind, save_plot=save_plot, - save_name=save_name) - - return freq[peak_ind] - - def plot_find_peak(self, freq, resp, peak_ind, save_plot=True, - save_name=None): - """ - """ - import matplotlib.pyplot as plt - if save_plot: - plt.ioff() - else: - plt.ion() - - Idat = np.real(resp) - Qdat = np.imag(resp) - phase = np.unwrap(np.arctan2(Qdat, Idat)) - - fig, ax = plt.subplots(2, sharex=True, figsize=(6,4)) - ax[0].plot(freq, np.abs(resp), label='amp', color='b') - ax[0].plot(freq, Idat, label='I', color='r', linestyle=':', alpha=.5) - ax[0].plot(freq, Qdat, label='Q', color='g', linestyle=':', alpha=.5) - ax[0].legend(loc='lower right') - ax[1].plot(freq, phase, color='b') - ax[1].set_ylim((-np.pi, np.pi)) - - if len(peak_ind): # empty array returns False - ax[0].plot(freq[peak_ind], np.abs(resp[peak_ind]), 'x', color='k') - ax[1].plot(freq[peak_ind], phase[peak_ind], 'x', color='k') - else: - self.log('No peak_ind values.', self.LOG_USER) - - fig.suptitle("Peak Finding") - ax[1].set_xlabel("Frequency offset from Subband Center (MHz)") - ax[0].set_ylabel("Response") - ax[1].set_ylabel("Phase [rad]") - - if save_plot: - if save_name is None: - self.log('Using default name for saving: find_peak.png \n' + - 'Highly recommended that you input a non-default name') - save_name = 'find_peak.png' - else: - self.log('Plotting saved to {}'.format(save_name)) - plt.savefig(os.path.join(self.plot_dir, save_name), - bbox_inches='tight') - plt.close() - def find_all_peak(self, freq, resp, subband=None, rolling_med=False, window=500, grad_cut=0.05, amp_cut=0.25, freq_min=-2.5E8, freq_max=2.5E8, make_plot=False, save_plot=True, band=None, make_subband_plot=False, @@ -3195,7 +3014,7 @@ def find_all_peak(self, freq, resp, subband=None, rolling_med=False, Optional Args: -------------- - see find_peak for optional arguments. Used the same defaults here. + see find_peak for optional arguments. Used the same defaults here. """ peaks = np.array([]) subbands = np.array([]) @@ -3212,13 +3031,13 @@ def find_all_peak(self, freq, resp, subband=None, rolling_med=False, f_stack = f_stack[s] r_stack = r_stack[s] - peaks = self.find_peak(f_stack, r_stack, - rolling_med=rolling_med, window=window, grad_cut=grad_cut, - amp_cut=amp_cut, freq_min=freq_min, freq_max=freq_max, - make_plot=make_plot, save_plot=save_plot, band=band, - make_subband_plot=make_subband_plot, - subband_plot_with_slow=subband_plot_with_slow, - timestamp=timestamp, pad=pad, min_gap=min_gap) + # Now find the peaks + peaks = self.find_peak(f_stack, r_stack, rolling_med=rolling_med, + window=window, grad_cut=grad_cut, amp_cut=amp_cut, freq_min=freq_min, + freq_max=freq_max, make_plot=make_plot, save_plot=save_plot, + band=band, make_subband_plot=make_subband_plot, + subband_plot_with_slow=subband_plot_with_slow, timestamp=timestamp, + pad=pad, min_gap=min_gap) return peaks @@ -3281,8 +3100,8 @@ def fast_eta_scan(self, band, subband, freq, n_read, drive, response[index] = Ielem + 1j*Qelem if make_plot: - import matplotlib.pyplot as plt # To do : make plotting + self.log('Plotting does not work in this function yet...') return freq, response @@ -3410,6 +3229,8 @@ def save_tune(self, update_last_tune=True): savedir = os.path.join(self.tune_dir, timestamp+"_tune") self.log('Saving to : {}.npy'.format(savedir)) np.save(savedir, self.freq_resp) + self.pub.register_file(savedir, 'tune', format='npy') + self.tune_file = savedir+'.npy' return savedir + ".npy" @@ -3469,8 +3290,8 @@ def last_tune(self): '*_tune.npy')))[-1] - def parallel_scan(self, band, channels, drive, - scan_freq=np.arange(-3, 3, .1)): + def parallel_scan(self, band, channels, drive, + scan_freq=np.arange(-3, 3, .1)): """ Does all the eta scans at once. The center frequency array must already be populated. @@ -3505,10 +3326,12 @@ def parallel_scan(self, band, channels, drive, self.log('Starting parallel scan') for j in np.arange(2): - self.set_eta_phase_array(band, eta_phase[j] * np.ones(n_channels, dtype=int)) + self.set_eta_phase_array(band, + eta_phase[j] * np.ones(n_channels, dtype=int)) for i in np.arange(len(scan_freq)): self.log('scan {}'.format(i)) - self.set_center_frequency_array(band, scan_freq[i]*np.ones(n_channels, dtype=int)) + self.set_center_frequency_array(band, + scan_freq[i]*np.ones(n_channels, dtype=int)) freq_error[i] = freq_error[i] + real_imag[j] * self.get_frequency_error_array(band) return scan_freq, freq_error @@ -3608,9 +3431,6 @@ def flux_mod2(self, band, df, sync, min_scale=0, make_plot=False, # Only for plotting channel = np.ravel(np.array(channel)) - if make_plot: - import matplotlib.pyplot as plt - peaks = np.zeros(n_chan)*np.nan band_chans=list(self.which_on(band)) @@ -3648,8 +3468,6 @@ def flux_mod2(self, band, df, sync, min_scale=0, make_plot=False, elif s[0] == e[0]: peaks[ch] = s[0] else: - #peaks[ch] = np.ravel(np.where(corr_amp[s[0]:e[0]] == - # np.max(corr_amp[s[0]:e[0]])))[0] + s[0] peaks[ch] = np.argmax(corr_amp[s[0]:e[0]]) + s[0] #polyfit @@ -3669,7 +3487,8 @@ def flux_mod2(self, band, df, sync, min_scale=0, make_plot=False, template_mean) ax[0].plot(template, color='k') ax[1].plot(corr_amp) - ax[1].plot(peaks[ch], corr_amp[int(peaks[ch])], 'x' ,color='k') + ax[1].plot(peaks[ch], corr_amp[int(peaks[ch])], 'x' , + color='k') return max_len/np.nanmedian(peaks) @@ -3773,7 +3592,6 @@ def flux_mod(self, df, sync, threshold=.4, minscale=.02, result[ch] = dn / peak if make_plot: # plotting routine to show sin fit - import matplotlib.pyplot as plt rs = 0 rc = 0 r = pts * [0] @@ -3803,27 +3621,36 @@ def flux_mod(self, df, sync, threshold=.4, minscale=.02, return mod_median - def find_bad_pairs(self, band, reset_rate_khz=4., write_log=False, + def find_bad_pairs(self, band, reset_rate_khz=None, write_log=False, make_plot=False, save_plot=True, show_plot=True, lms_freq_hz=None, flux_ramp=True, fraction_full_scale=.4950, - lms_enable1=True, lms_enable2=True, lms_enable3=True, lms_gain=7): + lms_enable1=True, lms_enable2=True, lms_enable3=True, lms_gain=None): """ """ + if reset_rate_khz is None: + reset_rate_khz = self.reset_rate_khz + if lms_gain is None: + lms_gain = self.lms_gain[band] + + # Extract the resonators resonators = self.freq_resp[band]['resonances'] keys = resonators.keys() + # Get the frequencies and channel information freqs = np.array([resonators[k]['freq'] for k in keys]) channels = np.array([resonators[k]['channel'] for k in keys]) + # Sort data by frequency idx = np.argsort(freqs) freqs = freqs[idx] channels = channels[idx] res_nums = np.arange(len(keys)) - df_err = np.zeros((len(keys), 2)) - f_span = np.zeros((len(keys), 2)) + n_chan = len(keys) + df_err = np.zeros((n_chan, 2)) + f_span = np.zeros((n_chan, 2)) - for i in np.arange(len(keys)-1): + for i in np.arange(n_chan-1): f1 = freqs[i] ch1 = channels[i] rn1 = res_nums[i] @@ -3836,12 +3663,12 @@ def find_bad_pairs(self, band, reset_rate_khz=4., write_log=False, self.band_off(band) self.relock(band, res_num=np.array([rn1, rn2])) - d, df, sync = self.tracking_setup(band, 0, reset_rate_khz=reset_rate_khz, - lms_freq_hz=lms_freq_hz, flux_ramp=flux_ramp, - lms_enable1=lms_enable1, lms_enable2=lms_enable2, - lms_enable3=lms_enable3, lms_gain=lms_gain, - fraction_full_scale=fraction_full_scale, - make_plot=False) + d, df, sync = self.tracking_setup(band, 0, + reset_rate_khz=reset_rate_khz, lms_freq_hz=lms_freq_hz, + flux_ramp=flux_ramp, lms_enable1=lms_enable1, + lms_enable2=lms_enable2, lms_enable3=lms_enable3, + lms_gain=lms_gain, fraction_full_scale=fraction_full_scale, + make_plot=False) df_err[i,0] = np.std(df[:,ch1]) df_err[i,1] = np.std(df[:,ch2]) f_span[i,0] = np.max(d[:,ch1]) - np.min(d[:,ch1]) @@ -3849,21 +3676,25 @@ def find_bad_pairs(self, band, reset_rate_khz=4., write_log=False, return f_span, df_err + def dump_state(self, output_file=None, return_screen=False): """ Dump the current tuning info to config file and write to disk Args: ----- - output_file (str): path to output file location. Defaults to the config file status dir and timestamp - return_screen (bool): whether to also return the contents of the config file in addition to writing to file. Defaults False. + output_file (str): path to output file location. Defaults to the config + file status dir and timestamp + return_screen (bool): whether to also return the contents of the config + file in addition to writing to file. Defaults False. """ # get the HEMT info because why not self.add_output('hemt_status', self.get_amplifier_biases()) # get jesd status for good measure - self.add_output('jesd_status', self.check_jesd()) + for bay in self.bays: + self.add_output('jesd_status bay ' + str(bay), self.check_jesd(bay)) # get TES bias info self.add_output('tes_biases', list(self.get_tes_bias_bipolar_array())) @@ -3897,6 +3728,7 @@ def dump_state(self, output_file=None, return_screen=False): if return_screen: return self.config.config + def fake_resonance_dict(self, freqs, save_sweeps=False): """ Takes a list of resonance frequencies and fakes a resonance dictionary @@ -3952,9 +3784,11 @@ def fake_resonance_dict(self, freqs, save_sweeps=False): # do we want to save? default will be false if save_sweeps: save_name = '{}_amp_sweep_b{}_{}.txt' - np.savetxt(os.path.join(self.output_dir,save_name.format(\ - timestamp, str(band), 'resonance')), \ - freq_dict[band]['find_freq']['resonance']) + + path = os.path.join(self.output_dir, + save_name.format(timestamp, str(band),'resonance')) + np.savetxt(path, freq_dict[band]['find_freq']['resonance']) + self.pub.register_file(path, 'resonances', format='txt') return freq_dict @@ -3965,11 +3799,13 @@ def freq_to_band(self, frequency, band_center_list): a duplicate but I can't find the original... Args: + ----- frequency (float): frequency in MHz band_center_list (list): frequency centers of bands we're running with. Formatted as [[band_no, band_center],[band_no, band_center],etc.] - Returns: + Ret: + ---- band_no of the frequency """ diff --git a/pysmurf/util/__init__.py b/pysmurf/util/__init__.py new file mode 100644 index 000000000..da390c18b --- /dev/null +++ b/pysmurf/util/__init__.py @@ -0,0 +1,13 @@ +#!/usr/bin/env python +#----------------------------------------------------------------------------- +# This file is part of the pysmurf software package. It is subject to +# the license terms in the LICENSE.txt file found in the top-level directory +# of this distribution and at: +# https://confluence.slac.stanford.edu/display/ppareg/LICENSE.html. +# No part of the pysmurf software package, including this file, may be +# copied, modified, propagated, or distributed except according to the terms +# contained in the LICENSE.txt file. +#----------------------------------------------------------------------------- +''' +init for util dir +''' diff --git a/util/aphorism.txt b/pysmurf/util/aphorism.txt similarity index 100% rename from util/aphorism.txt rename to pysmurf/util/aphorism.txt diff --git a/util/listen.py b/pysmurf/util/listen.py similarity index 53% rename from util/listen.py rename to pysmurf/util/listen.py index 6593dc0e5..91a495c81 100644 --- a/util/listen.py +++ b/pysmurf/util/listen.py @@ -1,3 +1,13 @@ +#!/usr/bin/env python +#----------------------------------------------------------------------------- +# This file is part of the pysmurf software package. It is subject to +# the license terms in the LICENSE.txt file found in the top-level directory +# of this distribution and at: +# https://confluence.slac.stanford.edu/display/ppareg/LICENSE.html. +# No part of the pysmurf software package, including this file, may be +# copied, modified, propagated, or distributed except according to the terms +# contained in the LICENSE.txt file. +#----------------------------------------------------------------------------- import socket import json diff --git a/util/pub.py b/pysmurf/util/pub.py similarity index 81% rename from util/pub.py rename to pysmurf/util/pub.py index e2bc95483..26d90c28f 100644 --- a/util/pub.py +++ b/pysmurf/util/pub.py @@ -1,3 +1,4 @@ +#!/usr/bin/env python # Copyright 2019 Matthew Hasselfield. # Redistribution and use of this code are permitted under the terms # of the LICENSE in this repository. @@ -8,6 +9,7 @@ import json import os, sys import time +import pysmurf DEFAULT_ENV_ROOT = 'SMURFPUB_' DEFAULT_UDP_PORT = 8200 @@ -127,13 +129,40 @@ def log(self, message): return self.publish({'message': message}, 'log') def log_start(self): + """Publishes start message""" return self.publish({}, 'start') def log_stop(self): + """Publishes stop message""" return self.publish({}, 'stop') - def register_data(self, filename): - return self.publish({'filename': filename}, 'datafile') + def register_file(self, path, type, format='', timestamp=None, plot=False): + """ + Publishes file info so it can be picked up by the pysmurf-archiver. + + Args: + ----- + path (str): + full path to file. + type (str): + Type of data file, e.g. "tuning" or "config_snapshot" + format (str): + File extension. E.g. "npy" or "txt" + timestamp (float): + Unix timestamp when file was created. + plot (bool): + True if file is a plot + """ + if timestamp is None: + timestamp = time.time() + + file_data = { + 'path': path, + 'type': type, + 'format': format, + 'timestamp': timestamp, + 'plot': plot, + 'pysmurf_version': pysmurf.__version__ + } - def register_plot(self, filename): - return self.publish({'filename': filename}, 'plotfile') \ No newline at end of file + return self.publish(file_data, 'data_file') diff --git a/util/smurf_util.py b/pysmurf/util/smurf_util.py similarity index 82% rename from util/smurf_util.py rename to pysmurf/util/smurf_util.py index 211603310..4811f7fc3 100644 --- a/util/smurf_util.py +++ b/pysmurf/util/smurf_util.py @@ -1,3 +1,18 @@ +#!/usr/bin/env python +#----------------------------------------------------------------------------- +# Title : pysmurf util module - SmurfUtilMixin class +#----------------------------------------------------------------------------- +# File : pysmurf/util/smurf_util.py +# Created : 2018-08-29 +#----------------------------------------------------------------------------- +# This file is part of the pysmurf software package. It is subject to +# the license terms in the LICENSE.txt file found in the top-level directory +# of this distribution and at: +# https://confluence.slac.stanford.edu/display/ppareg/LICENSE.html. +# No part of the pysmurf software package, including this file, may be +# copied, modified, propagated, or distributed except according to the terms +# contained in the LICENSE.txt file. +#----------------------------------------------------------------------------- import numpy as np from pysmurf.base import SmurfBase from pysmurf.command.sync_group import SyncGroup as SyncGroup @@ -8,14 +23,14 @@ from scipy import signal import shutil import glob +import matplotlib.pyplot as plt # for hardware logging import threading class SmurfUtilMixin(SmurfBase): - def take_debug_data(self, band, channel=None, nsamp=2**19, filename=None, - IQstream=1, single_channel_readout=1, debug=False, - write_log=True): + def take_debug_data(self, band, channel=None, nsamp=2**19, filename=None, + IQstream=1, single_channel_readout=1, debug=False, write_log=True): """ Takes raw debugging data @@ -30,7 +45,8 @@ def take_debug_data(self, band, channel=None, nsamp=2**19, filename=None, nsamp (int) : The number of samples to take filename (str) : The name of the file to save to. IQstream (int) : Whether to take the raw IQ stream. - debug (bool) : + debug (bool) : + write_log (bool) : Whether to write lowlevel commands to the log file. Ret: ---- @@ -42,12 +58,14 @@ def take_debug_data(self, band, channel=None, nsamp=2**19, filename=None, if channel is not None: if single_channel_readout == 1: self.set_single_channel_readout(band, 1, write_log=write_log) - self.set_single_channel_readout_opt2(band, 0, write_log=write_log) + self.set_single_channel_readout_opt2(band, 0, + write_log=write_log) elif single_channel_readout == 2: self.set_single_channel_readout(band, 0, write_log=write_log) - self.set_single_channel_readout_opt2(band, 1, write_log=write_log) + self.set_single_channel_readout_opt2(band, 1, + write_log=write_log) else: - self.log('single_channel_readout must be 1 or 2', + self.log('single_channel_readout must be 1 or 2', self.LOG_ERROR) raise ValueError('single_channel_readout must be 1 or 2') self.set_readout_channel_select(band, channel, write_log=write_log) @@ -95,7 +113,7 @@ def take_debug_data(self, band, channel=None, nsamp=2**19, filename=None, done=False while not done: done=True - for k in range(4): + for k in range(2): wr_addr = self.get_waveform_wr_addr(bay, engine=0) empty = self.get_waveform_empty(bay, engine=k) if not empty: @@ -104,7 +122,7 @@ def take_debug_data(self, band, channel=None, nsamp=2**19, filename=None, time.sleep(1) # do we need all of these? self.log('Finished acquisition', self.LOG_USER) - + self.log('Closing file...', self.LOG_USER) self.set_streamdatawriter_open('False') @@ -125,190 +143,21 @@ def start_jesd_watchdog(self): import sys pid = subprocess.Popen([sys.executable,JesdWatchdog.__file__]) - # this function needs work...we're probably planning to transition - # to calling the ipmi commands directly, instead of parsing the - # output of commands like amc_dump_bsi. - def get_amcc_dump_bsi(self,shm_ip='shm-smrf-sp01',slot=None): - """ - Attempts to parse the output of amcc_dump_bsi. Right now, - just gets the FW git hash, details about the FW build and - build string, and details on the AMCs. - - Optional Args: - -------------- - slot (int): Which slot to run the amcc_dump_bsi query on. If - none provided, will parse epics_root for the - slot number, assuming epics_root is - `smurf_server_s#` with # the slot number. - shm_ip (str): The ip of the shelf manager. Default is - 'shm-smrf-sp01'. - - Returns: - ------- - result_dict (dict): A dictionary of parsed results from amcc_dump_bsi. - """ - - if slot is None: - # attempt to guess from epics prefix - import re - p = re.compile('smurf_server_s([0-9])') - m = p.match(self.epics_root) - assert (m is not None),'Unable to determine slot number from epics_root={}'.format(self.epics_root) - slot=int(m.group(1)) - - import subprocess - result=subprocess.check_output(['amcc_dump_bsi','--all','%s/%d'%(shm_ip,slot)]) - result_string=result.decode('utf-8') - - print(result_string) - - # E.g.: - # AMC 0 info: Aux: 01 Ser: 9f0000011d036a70 Type: 0a Ver: C03 BOM: 00 Tag: C03-A01- - result_dict={} - patterns={} - patterns['AMC']=re.compile('AMC\s*([0-1])\s*info:\s*Aux:\s*(\d+)\s*Ser:\s*([a-z0-9]+)\s*Type:\s*([a-z0-9]+)\s*Ver:\s*(C[0-9][0-9])\s*BOM:\s*([0-9]+)\s*Tag:\s*([A-Z0-9a-z\-]+)') - # E.g.: - #"FW bld string: 'MicrowaveMuxBpEthGen2: Vivado v2018.3, pc95590 (x86_64), Built Tue Apr 30 13:35:05 PDT 2019 by mdewart'" - patterns['FW']=re.compile('FW bld string:\s*\'(MicrowaveMuxBpEthGen2):\s*(Vivado)\s*(v2018.3),\s*(pc95590)\s*\((x86_64)\),\s*Built\s*(Tue)\s*(Apr)\s*(30)\s*(13):(35):(05)\s*(PDT)\s*(2019)\s*by\s*(mdewart)\'') - - # E.g.: - patterns['FWGIThash']=re.compile('GIT hash:\s*([0-9a-z]+)') - #' GIT hash: 0000000000000000000000000000000000000000' - - for s in result_string.split('\n'): - s=s.rstrip().lstrip() - for key, p in patterns.items(): - m=p.match(s) - if m is not None: - if key not in result_dict.keys(): - result_dict[key]={} - - if key is 'AMC': - bay=int(m.group(1)) - result_dict[key][bay]={} - result_dict[key][bay]['Aux']=m.group(2) - result_dict[key][bay]['Ser']=m.group(3) - result_dict[key][bay]['Type']=m.group(4) - result_dict[key][bay]['Ver']=m.group(5) - result_dict[key][bay]['BOM']=m.group(6) - result_dict[key][bay]['Tag']=m.group(7) - - if key is 'FWGIThash': - result_dict[key]['GIThash']=m.group(1) - - if key is 'FW': - result_dict[key]['FWBranch']=m.group(1) - result_dict[key]['BuildSuite']=m.group(2) - result_dict[key]['BuildSuiteVersion']=m.group(3) - result_dict[key]['BuildPC']=m.group(4) - result_dict[key]['BuildArch']=m.group(5) - # skipping day spelled out - result_dict[key]['Month']=m.group(7) - result_dict[key]['Day']=m.group(8) - result_dict[key]['Hour']=m.group(9) - result_dict[key]['Minute']=m.group(10) - result_dict[key]['Second']=m.group(11) - result_dict[key]['TimeZone']=m.group(12) - result_dict[key]['Year']=m.group(13) - result_dict[key]['BuiltBy']=m.group(14) - - return result_dict - - - def get_amcc_dump(self, ip='10.0.1.4',show_result=True): - import subprocess - result=subprocess.check_output(['amcc_dump','--all','10.0.1.4']) - result_string=result.decode('utf-8') - - tablebreak='================================================================================' - ipslotbreak='--------------------------------------------------------------------------------' - - ## break into tables - split_result_string=result_string.split(tablebreak) - # drop white space - split_result_string = list(filter(None,[s for s in split_result_string if not s.isspace()])) - - amcc_dump_dict = {} - # loop over tables in returned data - for ii in range(0,len(split_result_string),2): - header = split_result_string[ii] - table = split_result_string[ii+1] - - split_header=header.split('|') - split_header = list(filter(None,[s.lstrip().rstrip() for s in split_header if not s.isspace()])) - sh0=split_header[0] - - ipslotbreakcnt=[] - ipslotbreakcntr=0 - split_table=table.split('\n') - for s in split_table: - if ipslotbreak in s: - ipslotbreakcntr+=1 - ipslotbreakcnt.append(ipslotbreakcntr) - - # loop over ip/slot combinations in returned data - for jj in range(0,max(ipslotbreakcnt),2): - this_ipslot_idxs=[ll for ll, xx in enumerate(ipslotbreakcnt) if xx in [jj,jj+1]] - split_table_subset=np.array(split_table)[this_ipslot_idxs[1:]] - split_table_subset=list(filter(None,[s.lstrip().rstrip() for s in split_table_subset if not s.isspace()])) - ipslot=split_table_subset[0] - table2=split_table_subset[2:] - - if 'RTM' in sh0 or 'Bay Raw GPIO' in sh0: - continue - - split_ipslot=ipslot.split('|') - split_ipslot = list(filter(None,[s.lstrip().rstrip() for s in split_ipslot if not s.isspace()])) - ip=split_ipslot[0].split('/')[0] - slot=split_ipslot[0].split('/')[1] - - if ip not in amcc_dump_dict.keys(): - amcc_dump_dict[ip]={} - if int(slot) not in amcc_dump_dict[ip].keys(): - amcc_dump_dict[ip][int(slot)]={} - - if sh0 not in amcc_dump_dict[ip][int(slot)].keys(): - amcc_dump_dict[ip][int(slot)][sh0]={} - - #if sh0 is 'BAY': - if sh0=="BAY": - split_table2=table2 - split_table2=list(filter(None,[s.lstrip().rstrip() for s in split_table2])) - for split_table3 in split_table2: - split_table3=split_table3.split('|') - split_table3 = list(filter(None,[s for s in split_table3])) - st3k=split_table3[0].lstrip().rstrip() - if st3k not in amcc_dump_dict[ip][int(slot)][sh0].keys(): - amcc_dump_dict[ip][int(slot)][sh0][st3k]={} - #add data - for kk in range(1,len(split_header)-1): - shkk=split_header[kk] - st3kk=split_table3[kk].lstrip().rstrip() - if shkk not in amcc_dump_dict[ip][int(slot)][sh0][st3k].keys(): - amcc_dump_dict[ip][int(slot)][sh0][st3k][shkk]=st3kk - - if show_result: - import json - print(json.dumps(amcc_dump_dict, indent = 4)) - - return amcc_dump_dict - - # Shawn needs to make this better and add documentation. - def estimate_phase_delay(self,band,n_samples=2**19,make_plot=True,show_plot=True, - save_plot=True,save_data=True,n_scan=5,timestamp=None, - uc_att=24,dc_att=0,freq_min=-2.5E8,freq_max=2.5E8): + def estimate_phase_delay(self, band, n_samples=2**19, make_plot=True, + show_plot=True, save_plot=True, save_data=True, n_scan=5, + timestamp=None, uc_att=24, dc_att=0, freq_min=-2.5E8, freq_max=2.5E8): # For some reason, pyrogue flips out if you try to set refPhaseDelay # to zero in 071150b0. This allows an offset ; the offset just gets # subtracted off the delay measurement with DSP after it's made. refPhaseDelay0=1 refPhaseDelayFine0=0 - + uc_att0=self.get_att_dc(band) dc_att0=self.get_att_uc(band) - self.set_att_uc(band,uc_att,write_log=True) - self.set_att_dc(band,dc_att,write_log=True) + self.set_att_uc(band,uc_att, write_log=True) + self.set_att_dc(band,dc_att, write_log=True) # only loop over dsp subbands in requested frequency range (to # save time) @@ -334,7 +183,6 @@ def estimate_phase_delay(self,band,n_samples=2**19,make_plot=True,show_plot=True timestamp=self.get_timestamp() if make_plot: - import matplotlib.pyplot as plt if show_plot: plt.ion() else: @@ -353,28 +201,8 @@ def estimate_phase_delay(self,band,n_samples=2**19,make_plot=True,show_plot=True ff_corr_ctime=1562053274 bay=int(band/4) - amcc_dump_bsi_dict=self.get_amcc_dump_bsi() - amc_dict=amcc_dump_bsi_dict['AMC'][bay] - amc_sn=amc_dict['Tag']+amc_dict['Ver'] - - fw_abbrev_sha=amcc_dump_bsi_dict['FWGIThash']['GIThash'][:7] - #fw_dict=amcc_dump_bsi_dict['FW'] - #fw_build_date="Built {} {} {}:{}:{} {} {} by {}".format(fw_dict['Month'], - # fw_dict['Day'], - # fw_dict['Hour'], - # fw_dict['Minute'], - # fw_dict['Second'], - # fw_dict['TimeZone'], - # fw_dict['Year'], - # fw_dict['BuiltBy']) - - # some special cases - #if fw_build_date=='Built Apr 30 13:35:05 PDT 2019 by mdewart': - # fw_abbrev_sha='0eea5630' - - print('amc_sn={}'.format(amc_sn)) - print('fw_abbrev_sha={}'.format(fw_abbrev_sha)) - #print('fw_build_date={}'.format(fw_build_date)) + + fw_abbrev_sha=self.get_fpga_git_hash_short() self.band_off(band) self.flux_ramp_off() @@ -443,7 +271,7 @@ def estimate_phase_delay(self,band,n_samples=2**19,make_plot=True,show_plot=True freq_dsp_subset=np.array(freq_dsp_subset) resp_dsp_subset=np.array(resp_dsp_subset) - idx_dsp = np.where( (freq_dsp_subset > freq_min) & (freq_dsp_subset < freq_max) ) + idx_dsp = np.where( (freq_dsp_subset > freq_min) & (freq_dsp_subset < freq_max) ) # restrict to requested frequencies only freq_dsp_subset=freq_dsp_subset[idx_dsp] @@ -458,7 +286,7 @@ def estimate_phase_delay(self,band,n_samples=2**19,make_plot=True,show_plot=True dsp_delay_us=np.abs(1.e6*dsp_z[0]/2/np.pi) # if refPhaseDelay0 or refPhaseDelayFine0 aren't zero, must add into - # delay here + # delay here dsp_delay_us+=refPhaseDelay0/(subband_half_width_mhz/2.) dsp_delay_us-=refPhaseDelayFine0/(digitizer_frequency_mhz/2) @@ -508,11 +336,11 @@ def estimate_phase_delay(self,band,n_samples=2**19,make_plot=True,show_plot=True resp_dsp_corr_subset=np.array(resp_dsp_corr_subset) # restrict to requested frequency subset - idx_dsp_corr = np.where( (freq_dsp_corr_subset > freq_min) & (freq_dsp_corr_subset < freq_max) ) + idx_dsp_corr = np.where( (freq_dsp_corr_subset > freq_min) & (freq_dsp_corr_subset < freq_max) ) # restrict to requested frequencies only freq_dsp_corr_subset=freq_dsp_corr_subset[idx_dsp_corr] - resp_dsp_corr_subset=resp_dsp_corr_subset[idx_dsp_corr] + resp_dsp_corr_subset=resp_dsp_corr_subset[idx_dsp_corr] # to Hz freq_dsp_corr_subset=(freq_dsp_corr_subset)*1.0E6 @@ -536,11 +364,11 @@ def estimate_phase_delay(self,band,n_samples=2**19,make_plot=True,show_plot=True f_dsp_corr_plot = (freq_dsp_corr_subset) / 1.0E6 dsp_corr_phase = np.unwrap(np.angle(resp_dsp_corr_subset)) - ax[0].set_title('AMC {}, Bay {}, Band {} Cable Delay'.format(amc_sn,bay,band)) + ax[0].set_title('AMC in Bay {}, Band {} Cable Delay'.format(bay,band)) ax[0].plot(f_cable_plot,cable_phase,label='Cable (full_band_resp)',c='g',lw=3) ax[0].plot(f_cable_plot,cable_p(f_cable_plot*1.0E6),'m--',label='Cable delay fit',lw=3) - ax[1].set_title('AMC {}, Bay {}, Band {} DSP Delay'.format(amc_sn,bay,band)) + ax[1].set_title('AMC in Bay {}, Band {} DSP Delay'.format(bay,band)) ax[1].plot(f_dsp_plot,dsp_phase,label='DSP (find_freq)',c='c',lw=3) ax[1].plot(f_dsp_plot,dsp_p(f_dsp_plot*1.0E6),c='orange',ls='--',label='DSP delay fit',lw=3) @@ -553,7 +381,7 @@ def estimate_phase_delay(self,band,n_samples=2**19,make_plot=True,show_plot=True ax[0].legend(loc='lower left',fontsize=8) ax[1].legend(loc='lower left',fontsize=8) - bbox = dict(boxstyle="round", ec='w', fc='w', alpha=.65) + bbox = dict(boxstyle="round", ec='w', fc='w', alpha=.65) ax[0].text(.97, .90, 'cable delay={:.5f} us'.format(cable_delay_us), transform=ax[0].transAxes, fontsize=10, bbox=bbox,horizontalalignment='right') @@ -567,7 +395,7 @@ def estimate_phase_delay(self,band,n_samples=2**19,make_plot=True,show_plot=True dsp_residuals=dsp_phase-(dsp_p(f_dsp_plot*1.0E6)) ax[2].plot(f_dsp_plot,dsp_residuals-np.median(dsp_residuals),label='DSP (find_freq)',c='c') ax[2].plot(f_dsp_corr_plot,dsp_corr_phase-np.median(dsp_corr_phase),label='DSP corrected (find_freq)',c='m') - ax[2].set_title('AMC {}, Bay {}, Band {} Residuals'.format(amc_sn,bay,band)) + ax[2].set_title('AMC in Bay {}, Band {} Residuals'.format(bay,band)) ax[2].set_ylabel("Residual [rad]") ax[2].set_xlabel('Frequency offset from band center [MHz]') ax[2].set_ylim([-5,5]) @@ -591,14 +419,17 @@ def estimate_phase_delay(self,band,n_samples=2**19,make_plot=True,show_plot=True if save_plot: save_name = '{}_b{}_delay.png'.format(timestamp,band) - plt.savefig(os.path.join(self.plot_dir, save_name), - bbox_inches='tight') + + path = os.path.join(self.plot_dir, save_name) + plt.savefig(path,bbox_inches='tight') + self.pub.register_file(path, 'delay', plot=True) + if not show_plot: plt.close() self.set_att_uc(band,uc_att0,write_log=True) - self.set_att_dc(band,dc_att0,write_log=True) - + self.set_att_dc(band,dc_att0,write_log=True) + def process_data(self, filename, dtype=np.uint32): """ reads a file taken with take_debug_data and processes it into @@ -622,7 +453,7 @@ def process_data(self, filename, dtype=np.uint32): rawdata = np.fromfile(filename, dtype=' 0: f[neg] = f[neg] - 2**24 - + if np.remainder(len(f), n_proc)!=0: if truncate: - self.log('Number of points in f not a multiple of {}. Truncating f to the nearest multiple of {}.'.format(n_proc,n_proc), - self.LOG_USER) + self.log(f'Number of points in f not a multiple of {n_proc}.' + + f' Truncating f to the nearest multiple of {n_proc}.', + self.LOG_USER) f=f[:(len(f)-np.remainder(len(f),n_proc))] else: - self.log('Number of points in f not a multiple of {}. Cannot decode'.format(n_proc), - self.LOG_ERROR) - f = np.reshape(f, (-1, n_proc)) * subband_half_width_mhz / 2**23 - + self.log(f'Number of points in f not a multiple of {n_proc}.'+ + ' Cannot decode', self.LOG_ERROR) + f = np.reshape(f, (-1, n_proc)) * subband_half_width_mhz / 2**23 + # frequency errors ch0_idx_df = np.where(ch0_strobe[:,1] == 1)[0] if len(ch0_idx_df) > 0: @@ -722,14 +554,15 @@ def decode_data(self, filename, swapFdF=False, recast=True, truncate=True): if np.remainder(len(df), n_proc)!=0: if truncate: - self.log('Number of points in df not a multiple of {}. Truncating df to the nearest multiple of {}.'.format(n_proc,n_proc), - self.LOG_USER) + self.log(f'Number of points in df not a multiple of {n_proc}.' + + f' Truncating df to the nearest multiple of {n_proc}.', + self.LOG_USER) df=df[:(len(df)-np.remainder(len(df),n_proc))] else: - self.log('Number of points in df not a multiple of {}. Cannot decode'.format(n_proc), - self.LOG_ERROR) - df = np.reshape(df, (-1, n_proc)) * subband_half_width_mhz / 2**23 - + self.log(f'Number of points in df not a multiple of {n_proc}.' + + 'Cannot decode', self.LOG_ERROR) + df = np.reshape(df, (-1, n_proc)) * subband_half_width_mhz / 2**23 + else: df = [] @@ -738,19 +571,19 @@ def decode_data(self, filename, swapFdF=False, recast=True, truncate=True): nsamp_df, _ = np.shape(df) if nsamp != nsamp_df: self.log('f and df are different sizes. Choosing the smaller' - ' value. Not sure why this is happening.') + ' value. Not sure why this is happening.') nsamp = np.min([nsamp, nsamp_df]) - + ftmp = np.zeros((nsamp, n_chan)) dftmp = np.zeros_like(ftmp) processed_ind = self.get_processed_channels() ftmp[:, processed_ind] = f[:nsamp] dftmp[:, processed_ind] = df[:nsamp] - + f = ftmp df = dftmp - + return f, df, flux_ramp_strobe def decode_single_channel(self, filename, swapFdF=False): @@ -818,7 +651,7 @@ def take_stream_data(self, meas_time, gcp_mode=True, Opt Args: --------- - gcp_mode (bool) : Determines whether to write data using the + gcp_mode (bool) : Determines whether to write data using the smurf2mce (gcp) mode. Default is True. num_averages (int) : The number of 4kHz frames to average before writing to disk. @@ -843,7 +676,7 @@ def stream_data_on(self, write_config=False, gcp_mode=True, Opt Args: --------- - gcp_mode (bool) : Determines whether to write data using the + gcp_mode (bool) : Determines whether to write data using the smurf2mce (gcp) mode. Default is True. num_averages (int) : The number of 4kHz frames to average before writing to disk. @@ -853,11 +686,11 @@ def stream_data_on(self, write_config=False, gcp_mode=True, data_filename (string): The fullpath to where the data is stored """ bands = self.config.get('init').get('bands') - + # Check if flux ramp is non-zero ramp_max_cnt = self.get_ramp_max_cnt() if ramp_max_cnt == 0: - self.log('Flux ramp frequency is zero. Cannot take data.', + self.log('Flux ramp frequency is zero. Cannot take data.', self.LOG_ERROR) else: # check which flux ramp relay state we're in @@ -873,7 +706,7 @@ def stream_data_on(self, write_config=False, gcp_mode=True, self.log("flux_ramp_ac_dc_relay_status = " + "{} - NOT A VALID STATE.".format(flux_ramp_ac_dc_relay_status), self.LOG_ERROR) - + # start streaming before opening file to avoid transient filter step self.set_stream_enable(1, write_log=False) time.sleep(.1) @@ -885,14 +718,14 @@ def stream_data_on(self, write_config=False, gcp_mode=True, # Optionally write PyRogue configuration if write_config: config_filename=os.path.join(self.output_dir, timestamp+'.yml') - self.log('Writing PyRogue configuration to file : {}'.format(config_filename), + self.log('Writing PyRogue configuration to file : {}'.format(config_filename), self.LOG_USER) self.write_config(config_filename) # short wait time.sleep(5.) - self.log('Writing to file : {}'.format(data_filename), + self.log('Writing to file : {}'.format(data_filename), self.LOG_USER) if gcp_mode: ret = self.make_smurf_to_gcp_config(filename=data_filename, @@ -913,15 +746,15 @@ def stream_data_on(self, write_config=False, gcp_mode=True, self.set_streaming_file_open(1) # Open the file return data_filename - + def stream_data_off(self, gcp_mode=True): """ - Turns off streaming data on specified band + Turns off streaming data on all bands - Args: - ----- - bands (int array) : The band to turn off stream data + Opt Args: + --------- + gcp_mode (bool) : Whether to stream the data in a GCP consistent mode """ bands = self.config.get('init').get('bands') if gcp_mode: @@ -930,7 +763,7 @@ def stream_data_off(self, gcp_mode=True): self.set_streaming_file_open(0) # Close the file - def read_stream_data(self, datafile, channel=None, + def read_stream_data(self, datafile, channel=None, unwrap=True, gcp_mode=True, n_samp=None): """ Loads data taken with the fucntion stream_data_on @@ -943,7 +776,16 @@ def read_stream_data(self, datafile, channel=None, --------- channel (int or int array): The channels to load. If None, loads all channels - unwrap (bool): Whether to unwrap the data + unwrap (bool): Whether to unwrap the data. + gcp_mode (bool): Whether the data was saved in the GCP mode. + n_samp (int) : The number of samples to load + + Ret: + ---- + timestamp (int) : The time data associated with the data. + phase (float) : The resonator phase response. + mask (int) : If using GCP mode, also returns a mask that maps output + channel to band/channel number. """ if gcp_mode: self.log('Treating data as GCP file') @@ -970,7 +812,7 @@ def read_stream_data(self, datafile, channel=None, # Convert binary file to int array. The < indicates little-endian - raw_dat = np.asarray(struct.unpack("<" + "i" * + raw_dat = np.asarray(struct.unpack("<" + "i" * ((len(file_content)) // 4), file_content)) # To do : add bad frame check @@ -991,14 +833,14 @@ def read_stream_data(self, datafile, channel=None, phase = np.arctan2(Q, I) elif version == 1: - # this works if we've already remove dropped frames. + # this works if we've already remove dropped frames. # Use timestamp/frame counter to look for drops - keys = ['h0', 'h1', 'version', 'crate_id', 'slot_number', - 'number_of_channels', 'rtm_dac_config0', 'rtm_dac_config1', - 'rtm_dac_config2', 'rtm_dac_config3', 'rtm_dac_config4', - 'rtm_dac_config5', 'flux_ramp_increment', 'flux_ramp_start', - 'base_rate_since_1_Hz', 'base_rate_since_TM', 'timestamp_ns', - 'timestamp_s', 'fixed_rate_marker', 'sequence_counter', + keys = ['h0', 'h1', 'version', 'crate_id', 'slot_number', + 'number_of_channels', 'rtm_dac_config0', 'rtm_dac_config1', + 'rtm_dac_config2', 'rtm_dac_config3', 'rtm_dac_config4', + 'rtm_dac_config5', 'flux_ramp_increment', 'flux_ramp_start', + 'base_rate_since_1_Hz', 'base_rate_since_TM', 'timestamp_ns', + 'timestamp_s', 'fixed_rate_marker', 'sequence_counter', 'tes_relay','mce_word' ] @@ -1008,16 +850,16 @@ def read_stream_data(self, datafile, channel=None, keys_dict = dict(zip(keys, range(len(keys)))) - frames = [i for i in + frames = [i for i in struct.Struct('2I2BHI6Q6IH2xI2Q24x4096h').iter_unpack(file_content)] - + if channel is None: phase = np.zeros((512, len(frames))) for i in range(512): k = i + 1024 - phase[i,:] = np.asarray([j[keys_dict[f'data{k}']] for j in + phase[i,:] = np.asarray([j[keys_dict[f'data{k}']] for j in frames]) else: print('Loading only channel {}'.format(channel)) @@ -1044,7 +886,7 @@ def read_stream_data_gcp_save(self, datafile, channel=None, Args: ----- datafile (str): The full path to the data made by stream_data_on - + Opt Args: --------- channel (int or int array): Channels to load. @@ -1069,11 +911,11 @@ def read_stream_data_gcp_save(self, datafile, channel=None, keys = ['protocol_version','crate_id','slot_number','number_of_channels', - 'rtm_dac_config0', 'rtm_dac_config1', 'rtm_dac_config2', + 'rtm_dac_config0', 'rtm_dac_config1', 'rtm_dac_config2', 'rtm_dac_config3', 'rtm_dac_config4', 'rtm_dac_config5', - 'flux_ramp_increment','flux_ramp_start', 'rate_since_1Hz', + 'flux_ramp_increment','flux_ramp_start', 'rate_since_1Hz', 'rate_since_TM', 'nanoseconds', 'seconds', 'fixed_rate_marker', - 'sequence_counter', 'tes_relay_config', 'mce_word', + 'sequence_counter', 'tes_relay_config', 'mce_word', 'user_word0', 'user_word1', 'user_word2' ] @@ -1116,7 +958,7 @@ def read_stream_data_gcp_save(self, datafile, channel=None, elif eval_n_samp: if counter >= n_samp: phase = np.hstack((phase, tmp_phase[:,:counter%n])) - timestamp2 = np.append(timestamp2, + timestamp2 = np.append(timestamp2, tmp_timestamp2[:counter%n]) break frame = struct.Struct('3BxI6Q8I5Q528i').unpack(chunk) @@ -1144,7 +986,7 @@ def read_stream_data_gcp_save(self, datafile, channel=None, filename = os.path.basename(datafile) timestamp = filename.split('.')[0] - mask = self.make_mask_lookup(os.path.join(rootpath, + mask = self.make_mask_lookup(os.path.join(rootpath, '{}_mask.txt'.format(timestamp))) return timestamp2, phase, mask @@ -1162,7 +1004,7 @@ def make_mask_lookup(self, mask_file, mask_channel_offset=0): Opt Args: --------- - mask_channel_offset (int) : Offset to remove from channel + mask_channel_offset (int) : Offset to remove from channel numbers in GCP mask file after loading. Default is 0. Ret: @@ -1171,14 +1013,14 @@ def make_mask_lookup(self, mask_file, mask_channel_offset=0): """ if self.config.get('smurf_to_mce').get('mask_channel_offset') is not None: mask_channel_offset=int(self.config.get('smurf_to_mce').get('mask_channel_offset')) - + mask = np.atleast_1d(np.loadtxt(mask_file)) bands = np.unique(mask // 512).astype(int) ret = np.ones((np.max(bands)+1, 512), dtype=int) * -1 - + for gcp_chan, smurf_chan in enumerate(mask): ret[int(smurf_chan//512), int((smurf_chan-mask_channel_offset)%512)] = gcp_chan - + return ret @@ -1193,7 +1035,7 @@ def read_stream_data_daq(self, data_length, bay=0, else: stream0 = self.epics_root + ":AMCc:Stream4" stream1 = self.epics_root + ":AMCc:Stream5" - + pvs = [stream0, stream1] sg = SyncGroup(pvs, skip_first=True) @@ -1210,7 +1052,7 @@ def read_stream_data_daq(self, data_length, bay=0, r0 = vals[pvs[0]] r1 = vals[pvs[1]] - + return r0, r1 def read_adc_data(self, band, data_length=2**19, @@ -1259,20 +1101,19 @@ def read_adc_data(self, band, data_length=2**19, dat = res[1] + 1.j * res[0] if do_plot: - import matplotlib.pyplot as plt if show_plot: plt.ion() else: plt.ioff() import scipy.signal as signal - digitizer_frequency_mhz = self.get_digitizer_frequency_mhz() - f, p_adc = signal.welch(dat, fs=digitizer_frequency_mhz, nperseg=data_length/2, return_onesided=False,detrend=False) + digitizer_frequency_mhz = self.get_digitizer_frequency_mhz() + f, p_adc = signal.welch(dat, fs=digitizer_frequency_mhz, nperseg=data_length/2, return_onesided=False,detrend=False) f_plot = f / 1.0E6 idx = np.argsort(f) f_plot = f_plot[idx] - p_adc = p_adc[idx] + p_adc = p_adc[idx] fig = plt.figure(figsize=(9,4.5)) ax=plt.gca() @@ -1282,20 +1123,23 @@ def read_adc_data(self, band, data_length=2**19, plt.ylim(plt.ylim()[0],plot_ylimits[1]) ax.set_ylabel('ADC{}'.format(band)) ax.set_xlabel('Frequency [MHz]') - ax.set_title(timestamp) + ax.set_title(timestamp) ax.semilogy(f_plot, p_adc) plt.grid() if save_plot: - plot_fn = '{}/{}_adc{}.png'.format(self.plot_dir,timestamp,adc_number) + plot_fn = '{}/{}_adc{}.png'.format(self.plot_dir,timestamp,band) plt.savefig(plot_fn) - self.log('ADC plot saved to %s' % (plot_fn)) - + self.pub.register_file(plot_fn, 'adc', plot=True) + self.log('ADC plot saved to %s' % (plot_fn)) + if save_data: - outfn=os.path.join(self.output_dir,'{}_adc{}'.format(timestamp,adc_number)) + outfn=os.path.join(self.output_dir,'{}_adc{}'.format(timestamp,band)) self.log('Saving raw adc data to {}'.format(outfn), self.LOG_USER) - np.save(outfn, res) - + + np.save(outfn, res) + self.pub.register_file(outfn, 'adc', format='npy') + return dat def read_dac_data(self, band, data_length=2**19, @@ -1307,7 +1151,7 @@ def read_dac_data(self, band, data_length=2**19, Args: ----- - band (int) : Which band. Assumes adc number is band%4. + band (int) : Which band. Assumes dac number is band%4. data_length (int): The number of samples Opt Args: @@ -1333,30 +1177,30 @@ def read_dac_data(self, band, data_length=2**19, """ if timestamp is None: timestamp = self.get_timestamp() - + bay=self.band_to_bay(band) - dac_number=band%4 - + dac_number=band%4 + self.setup_daq_mux('dac', dac_number, data_length, band=band) res = self.read_stream_data_daq(data_length, bay=bay, hw_trigger=hw_trigger) dat = res[1] + 1.j * res[0] if do_plot: - import matplotlib.pyplot as plt if show_plot: plt.ion() else: plt.ioff() import scipy.signal as signal - digitizer_frequency_mhz = self.get_digitizer_frequency_mhz() - f, p_dac = signal.welch(dat, fs=digitizer_frequency_mhz, nperseg=data_length/2, return_onesided=False,detrend=False) + digitizer_frequency_mhz = self.get_digitizer_frequency_mhz() + f, p_dac = signal.welch(dat, fs=digitizer_frequency_mhz, + nperseg=data_length/2, return_onesided=False, detrend=False) f_plot = f / 1.0E6 idx = np.argsort(f) f_plot = f_plot[idx] - p_dac = p_dac[idx] + p_dac = p_dac[idx] fig = plt.figure(figsize=(9,4.5)) ax=plt.gca() @@ -1366,22 +1210,26 @@ def read_dac_data(self, band, data_length=2**19, plt.ylim(plt.ylim()[0],plot_ylimits[1]) ax.set_ylabel('DAC{}'.format(band)) ax.set_xlabel('Frequency [MHz]') - ax.set_title(timestamp) + ax.set_title(timestamp) ax.semilogy(f_plot, p_dac) plt.grid() if save_plot: - plot_fn = '{}/{}_dac{}.png'.format(self.plot_dir,timestamp,dac_number) + plot_fn = '{}/{}_dac{}.png'.format(self.plot_dir,timestamp,band) plt.savefig(plot_fn) - self.log('DAC plot saved to %s' % (plot_fn)) - + self.pub.register_file(plot_fn, 'dac', plot=True) + self.log('DAC plot saved to %s' % (plot_fn)) + if save_data: - outfn=os.path.join(self.output_dir,'{}_dac{}'.format(timestamp,dac_number)) + outfn = os.path.join(self.output_dir,'{}_dac{}'.format(timestamp,band)) self.log('Saving raw dac data to {}'.format(outfn), self.LOG_USER) + np.save(outfn, res) + self.pub.register_file(outfn, 'dac', format='npy') return dat + def setup_daq_mux(self, converter, converter_number, data_length, band=0, debug=False, write_log=False): """ @@ -1389,7 +1237,7 @@ def setup_daq_mux(self, converter, converter_number, data_length, Args: ----- - converter (str) : Whether it is the ADC or DAC. choices are 'adc', + converter (str) : Whether it is the ADC or DAC. choices are 'adc', 'dac', or 'debug'. The last one takes data on a single band. converter_number (int) : The ADC or DAC number to take data on. data_length (int) : The amount of data to take. @@ -1412,7 +1260,7 @@ def setup_daq_mux(self, converter, converter_number, data_length, # setup buffer size self.set_buffer_size(bay, data_length, debug) - + # input mux select self.set_input_mux_sel(bay, 0, daq_mux_channel0, write_log=write_log) @@ -1420,7 +1268,8 @@ def setup_daq_mux(self, converter, converter_number, data_length, write_log=write_log) # which f,df stream to route to MUX, maybe? - self.set_debug_select(bay, band, write_log=write_log) + self.set_debug_select(bay, band%4, write_log=True) + def set_buffer_size(self, bay, size, debug=False, write_log=False): @@ -1434,17 +1283,18 @@ def set_buffer_size(self, bay, size, debug=False, # Change DAQ data buffer size # Change waveform engine buffer size - self.set_data_buffer_size(bay, size, write_log=write_log) - for daq_num in np.arange(4): - s = self.get_waveform_start_addr(bay, daq_num, convert=True, + self.set_data_buffer_size(bay, size, write_log=True) + for daq_num in np.arange(2): + s = self.get_waveform_start_addr(bay, daq_num, convert=True, write_log=debug) e = s + 4*size - self.set_waveform_end_addr(bay, daq_num, e, convert=True, + self.set_waveform_end_addr(bay, daq_num, e, convert=True, write_log=debug) if debug: self.log('DAQ number {}: start {} - end {}'.format(daq_num, s, e)) - def config_cryo_channel(self, band, channel, frequencyMHz, amplitude, + + def config_cryo_channel(self, band, channel, frequencyMHz, amplitude, feedback_enable, eta_phase, eta_mag): """ Set parameters on a single cryo channel @@ -1456,7 +1306,7 @@ def config_cryo_channel(self, band, channel, frequencyMHz, amplitude, frequencyMHz (float) : the frequency offset from the subband center in MHz amplitude (int) : amplitude scale to set for the channel (0..15) feedback_enable (bool) : whether to enable feedback for the channel - eta_phase (float) : feedback eta phase, in degrees (-180..180) + eta_phase (float) : feedback eta phase, in degrees (-180..180) eta_mag (float) : feedback eta magnitude """ @@ -1497,6 +1347,7 @@ def config_cryo_channel(self, band, channel, frequencyMHz, amplitude, self.set_eta_phase_degree_channel(band, channel, phase) self.set_eta_mag_scaled_channel(band, channel, eta_mag) + def which_on(self, band): ''' Finds all detectors that are on. @@ -1512,6 +1363,7 @@ def which_on(self, band): amps = self.get_amplitude_scale_array(band) return np.ravel(np.where(amps != 0)) + def toggle_feedback(self, band, **kwargs): ''' Toggles feedbackEnable (->0->1) and lmsEnables1-3 (->0->1) for @@ -1524,21 +1376,24 @@ def toggle_feedback(self, band, **kwargs): ''' # current vals? - old_feedback_enable=self.get_feedback_enable(band) - old_lms_enable1=self.get_lms_enable1(band) - old_lms_enable2=self.get_lms_enable2(band) + old_feedback_enable=self.get_feedback_enable(band) + old_lms_enable1=self.get_lms_enable1(band) + old_lms_enable2=self.get_lms_enable2(band) old_lms_enable3=self.get_lms_enable3(band) - self.log('Before toggling feedback on band {}, feedbackEnable={}, lmsEnable1={}, lmsEnable2={}, and lmsEnable3={}.'.format(band, old_feedback_enable, old_lms_enable1, old_lms_enable2, old_lms_enable3), - self.LOG_USER) - + self.log(f'Before toggling feedback on band {band}, ' + + f'feedbackEnable={old_feedback_enable}, ' + + f'lmsEnable1={old_lms_enable1}, '+ + f'lmsEnable2={old_lms_enable2}, and lmsEnable3={old_lms_enable3}.', + self.LOG_USER) + # -> 0 - self.log('Setting feedbackEnable=lmsEnable1=lmsEnable2=lmsEnable3=0 (in that order).', - self.LOG_USER) + self.log('Setting feedbackEnable=lmsEnable1=lmsEnable2=lmsEnable3=0'+ + ' (in that order).', self.LOG_USER) self.set_feedback_enable(band,0) self.set_lms_enable1(band,0) self.set_lms_enable2(band,0) - self.set_lms_enable3(band,0) + self.set_lms_enable3(band,0) # -> 1 logstr='Set ' @@ -1550,18 +1405,22 @@ def toggle_feedback(self, band, **kwargs): logstr+='lmsEnable1=' if old_lms_enable2: self.set_lms_enable2(band,1) - logstr+='lmsEnable2=' + logstr+='lmsEnable2=' if old_lms_enable3: self.set_lms_enable3(band,1) - logstr+='lmsEnable3=' - + logstr+='lmsEnable3=' + logstr+='1 (in that order).' self.log(logstr, - self.LOG_USER) + self.LOG_USER) def band_off(self, band, **kwargs): ''' Turns off all tones in a band + + Args: + ----- + band (int) : The band that is to be turned off. ''' self.set_amplitude_scales(band, 0, **kwargs) self.set_feedback_enable_array(band, np.zeros(512, dtype=int), **kwargs) @@ -1569,15 +1428,28 @@ def band_off(self, band, **kwargs): def channel_off(self, band, channel, **kwargs): """ - Turns off the tone for a single channel by setting the amplitude to zero and disabling feedback. + Turns off the tone for a single channel by setting the amplitude to + zero and disabling feedback. + + Args: + ----- + band (int) : The band that is to be turned off. + channel (int) : The channel to turn off. """ - self.log('Turning off band {} channel {}'.format(band, channel), + self.log('Turning off band {} channel {}'.format(band, channel), self.LOG_USER) self.set_amplitude_scale_channel(band, channel, 0, **kwargs) self.set_feedback_enable_channel(band, channel, 0, **kwargs) + def set_feedback_limit_khz(self, band, feedback_limit_khz, **kwargs): ''' + Sets the feedback limit + + Args: + ----- + band (int) : The band that is to be turned off. + feedback_limit_khz (float) : The feedback rate in units of kHz. ''' digitizer_freq_mhz = self.get_digitizer_frequency_mhz(band) bandcenter = self.get_band_center_mhz(band) @@ -1606,22 +1478,26 @@ def recover_jesd(self,bay,recover_jesd_rx=True,recover_jesd_tx=True): self.set_jesd_tx_enable(bay,0x0) self.set_jesd_tx_enable(bay,0x3CF) - #2. Toggle AMCcc:FpgaTopLevel:AppTop:AppCore:MicrowaveMuxCore[0]:DAC[0]:JesdRstN 0x1 -> 0x0 -> 0x1 + #2. Toggle AMCcc:FpgaTopLevel:AppTop:AppCore:MicrowaveMuxCore[0]: + # DAC[0]:JesdRstN 0x1 -> 0x0 -> 0x1 self.set_jesd_reset_n(bay,0,0x0) self.set_jesd_reset_n(bay,0,0x1) - #3. Toggle AMCcc:FpgaTopLevel:AppTop:AppCore:MicrowaveMuxCore[0]:DAC[1]:JesdRstN 0x1 -> 0x0 -> 0x1 + #3. Toggle AMCcc:FpgaTopLevel:AppTop:AppCore:MicrowaveMuxCore[0]: + # DAC[1]:JesdRstN 0x1 -> 0x0 -> 0x1 self.set_jesd_reset_n(bay,1,0x0) self.set_jesd_reset_n(bay,1,0x1) - # probably overkill...shouldn't call this function if you're not going to do anything + # probably overkill...shouldn't call this function if you're not going + # to do anything if (recover_jesd_rx or recover_jesd_tx): - # powers up the SYSREF which is required to sync fpga and adc/dac jesd + # powers up the SYSREF which is required to sync fpga and + # adc/dac jesd self.run_pwr_up_sys_ref(bay) # check if Jesds recovered - enable printout (jesd_tx_ok,jesd_rx_ok)=self.check_jesd(bay,silent_if_valid=False) - + # raise exception if failed to recover if (jesd_rx_ok and jesd_tx_ok): self.log('Recovered Jesd.', self.LOG_USER) @@ -1637,27 +1513,32 @@ def jesd_decorator(decorated): def jesd_decorator_function(self): # check JESDs (jesd_tx_ok0,jesd_rx_ok0)=self.check_jesd(silent_if_valid=True) - + # if either JESD is down, try to fix if not (jesd_rx_ok0 and jesd_tx_ok0): which_jesd_down0='Jesd Rx and Tx are both down' if (jesd_rx_ok0 or jesd_tx_ok0): - which_jesd_down0 = ('Jesd Rx is down' if jesd_tx_ok0 else 'Jesd Tx is down') - - self.log('%s ... will attempt to recover.'%which_jesd_down0, self.LOG_ERROR) + which_jesd_down0 = ('Jesd Rx is down' if jesd_tx_ok0 + else 'Jesd Tx is down') + + self.log('%s ... will attempt to recover.'%which_jesd_down0, + self.LOG_ERROR) # attempt to recover ; if it fails it will assert - self.recover_jesd(recover_jesd_rx=(not jesd_rx_ok0),recover_jesd_tx=(not jesd_tx_ok0)) + self.recover_jesd(recover_jesd_rx=(not jesd_rx_ok0), + recover_jesd_tx=(not jesd_tx_ok0)) # rely on recover to assert if it failed - self.log('Successfully recovered Jesd but may need to redo some setup ... rerun command at your own risk.', self.LOG_USER) + self.log('Successfully recovered Jesd but may need to redo' + + ' some setup ... rerun command at your own risk.', + self.LOG_USER) - # don't continue running the desired command by default. + # don't continue running the desired command by default. # just because Jesds are back doesn't mean we're in a sane # state. User may need to relock/etc. if (jesd_rx_ok0 and jesd_tx_ok0): decorated() - + return jesd_decorator_function def check_jesd(self, bay, silent_if_valid=False): @@ -1683,7 +1564,7 @@ def check_jesd(self, bay, silent_if_valid=False): # JESD Rx jesd_rx_enable = self.get_jesd_rx_enable(bay) jesd_rx_valid = self.get_jesd_rx_data_valid(bay) - jesd_rx_ok = (jesd_rx_enable==jesd_rx_valid) + jesd_rx_ok = (jesd_rx_enable==jesd_rx_valid) if not jesd_rx_ok: self.log("JESD Rx DOWN", self.LOG_ERROR) else: @@ -1745,7 +1626,7 @@ def which_bands(self): build_dsp_g=self.get_build_dsp_g() bands=[b for b,x in enumerate(bin(build_dsp_g)[2:]) if x=='1'] return bands - + def freq_to_subband(self, band, freq): '''Look up subband number of a channel frequency, and its subband frequency offset. @@ -1765,8 +1646,9 @@ def freq_to_subband(self, band, freq): num_subband = self.get_number_sub_bands(band) band_center = self.get_band_center_mhz(band) subband_width = 2*dig_freq/num_subband - - subbands, subband_centers = self.get_subband_centers(band, as_offset=False) + + subbands, subband_centers = self.get_subband_centers(band, + as_offset=False) df = np.abs(freq - subband_centers) idx = np.ravel(np.where(df == np.min(df)))[0] @@ -1794,7 +1676,7 @@ def channel_to_freq(self, band, channel, yml=None): subband = self.get_subband_from_channel(band, channel, yml=yml) _, sbc = self.get_subband_centers(band, as_offset=False, yml=yml) - offset = float(self.get_center_frequency_mhz_channel(band, channel, + offset = float(self.get_center_frequency_mhz_channel(band, channel, yml=yml)) return sbc[subband] + offset @@ -1823,7 +1705,7 @@ def get_channel_order(self, band=None, channel_orderfile=None): # the list of bands specified in experiment.cfg. bands = self.config.get('init').get('bands') band = bands[0] - + tone_freq_offset = self.get_tone_frequency_offset_mhz(band) freqs = np.sort(np.unique(tone_freq_offset)) @@ -1831,11 +1713,11 @@ def get_channel_order(self, band=None, channel_orderfile=None): n_channels = self.get_number_channels(band) n_chanpersubband = int(n_channels / n_subbands) - + channel_order = np.zeros(len(tone_freq_offset), dtype=int) for i, f in enumerate(freqs): channel_order[n_chanpersubband*i:n_chanpersubband*(i+1)] = np.ravel(np.where(tone_freq_offset == f)) - + return channel_order def get_processed_channels(self, channel_orderfile=None): @@ -1847,7 +1729,7 @@ def get_processed_channels(self, channel_orderfile=None): Optional Args: -------------- channelorderfile (str): path to a file that contains one channel per line - + Ret: ---- processed_channels (int array) @@ -1855,8 +1737,9 @@ def get_processed_channels(self, channel_orderfile=None): n_proc = self.get_number_processed_channels() n_chan = self.get_number_channels() n_cut = (n_chan - n_proc)//2 - return np.sort(self.get_channel_order(channel_orderfile=channel_orderfile)[n_cut:-n_cut]) - + return np.sort(self.get_channel_order( + channel_orderfile=channel_orderfile)[n_cut:-n_cut]) + def get_subband_from_channel(self, band, channel, channelorderfile=None, yml=None): """ returns subband number given a channel number @@ -1890,24 +1773,25 @@ def get_subband_from_channel(self, band, channel, channelorderfile=None, idx = np.where(chanOrder == channel)[0] subband = idx // n_chanpersubband - + return int(subband) - def get_subband_centers(self, band, as_offset=True, hardcode=False, + def get_subband_centers(self, band, as_offset=True, hardcode=False, yml=None): """ returns frequency in MHz of subband centers Args: ----- band (int): which band - as_offset (bool): whether to return as offset from band center + as_offset (bool): whether to return as offset from band center (default is no, which returns absolute values) """ - #hardcode defaults - digitizer_frequency_mhz = 614.4 - n_subbands = 128 - if not hardcode: - digitizer_frequency_mhz = self.get_digitizer_frequency_mhz(band, + if hardcode: + bandCenterMHz = 3.75 + 0.5*(band + 1) + digitizer_frequency_mhz = 614.4 + n_subbands = 128 + else: + digitizer_frequency_mhz = self.get_digitizer_frequency_mhz(band, yml=yml) n_subbands = self.get_number_sub_bands(band, yml=yml) @@ -1933,7 +1817,7 @@ def get_channels_in_subband(self, band, subband, channelorderfile=None): Opt Args: --------- channelorderfile (str): path to file specifying channel order - + Returns: -------- subband_chans (int array): The channels in the subband @@ -1966,7 +1850,7 @@ def iq_to_phase(self, i, q): Returns: -------- - phase (float array) : + phase (float array) : """ return np.unwrap(np.arctan2(q, i)) @@ -2007,25 +1891,34 @@ def int_to_hex_string(self, i): return s - def set_tes_bias_bipolar(self, bias_group, volt, do_enable=True, flip_polarity=False, - **kwargs): + def set_tes_bias_bipolar(self, bias_group, volt, do_enable=True, + flip_polarity=False, **kwargs): """ + Set an individual TES bias group to the specified voltage, in + volts. Asserts if the requested bias group is not defined in + the pysmurf configuration file. The positive DAC in the bias + group is set to +volt/2, while the negative DAC in the bias + group is set to -volt/2. + + Args: + ----- bias_group (int): The bias group - volt (float): The TES bias to command in voltage. + volt (float): The TES bias to command in volts. Opt args: -------- - do_enable (bool) : Sets the enable bit. Default is True. + do_enable (bool) : Sets the enable bit. Only must be done + once. Default is True. + flip_polarity (bool) : Sets the voltage to volt*-1. Default + is False. """ - # bias_order = np.array([9, 11, 13, 15, 16, 14, 12, 10, 7, 5, 3, 1, 8, 6, - # 4, 2]) - 1 # -1 because bias_groups are 0 indexed. Chips are 1 - # dac_positives = np.array([2, 4, 6, 8, 10, 12, 14, 16, 18, 20, 22, 24, - # 26, 28, 30, 32]) - # dac_negatives = np.array([1, 3, 5, 7, 9, 11, 13, 15, 17, 19, 21, 23, - # 25, 27, 29, 31]) - - bias_order = self.bias_group_to_pair[:,0] + # Make sure the requested bias group is in the list of defined + # bias groups. + bias_groups = self.bias_group_to_pair[:,0] + assert (bias_group in bias_groups),f'Bias group {bias_group} is not defined (available bias groups are {bias_groups}). Doing nothing!' + + bias_order = bias_groups dac_positives = self.bias_group_to_pair[:,1] dac_negatives = self.bias_group_to_pair[:,2] @@ -2041,125 +1934,125 @@ def set_tes_bias_bipolar(self, bias_group, volt, do_enable=True, flip_polarity=F volts_pos *= -1 volts_neg *= -1 - if do_enable: - self.set_tes_bias_enable(dac_positive, 2, **kwargs) - self.set_tes_bias_enable(dac_negative, 2, **kwargs) + self.set_rtm_slow_dac_enable(dac_positive, 2, **kwargs) + self.set_rtm_slow_dac_enable(dac_negative, 2, **kwargs) - self.set_tes_bias_volt(dac_positive, volts_pos, **kwargs) - self.set_tes_bias_volt(dac_negative, volts_neg, **kwargs) + self.set_rtm_slow_dac_volt(dac_positive, volts_pos, **kwargs) + self.set_rtm_slow_dac_volt(dac_negative, volts_neg, **kwargs) - def set_tes_bias_bipolar_array(self, volt_array, do_enable=True, **kwargs): + def set_tes_bias_bipolar_array(self, bias_group_volt_array, do_enable=True, **kwargs): """ - Set TES bipolar values for all DACs at once + Set TES bipolar values for all DACs at once. Set using a + pyrogue array write, so should be much more efficient than + setting each TES bias one at a time (a single register + transaction vs. many). Only DACs assigned to TES bias groups + are touched by this function. The enable status and output + voltage of all DACs not assigned to a TES bias group are + maintained. Args: ----- - volt_array (float array): the TES bias to command in voltage. Should be (8,) + bias_group_volt_array (float array): the TES bias to command + in voltage for each + bipolar TES bias + group. Should be + (n_bias_groups,) Opt args: ----- - do_enable (bool): Set the enable bit. Defaults to True + do_enable (bool): Set the enable bit for both DACs for every + TES bias group. Defaults to True. """ - bias_order = self.bias_group_to_pair[:,0] - dac_positives = self.bias_group_to_pair[:,1] - dac_negatives = self.bias_group_to_pair[:,2] - - n_bias_groups = 8 - - # initialize arrays of 0's - do_enable_array = np.zeros((32,), dtype=int) - bias_volt_array = np.zeros((32,)) + n_bias_groups = self._n_bias_groups - if len(volt_array) != n_bias_groups: - self.log("Received the wrong number of biases. Expected " + - "n_bias_groups={}".format(n_bias_groups), self.LOG_ERROR) + # in this function we're only touching the DACs defined in TES + # bias groups. Need to make sure we carry along the setting + # and enable of any DACs that are being used for something + # else. + dac_enable_array = self.get_rtm_slow_dac_enable_array() + dac_volt_array = self.get_rtm_slow_dac_volt_array() + + if len(bias_group_volt_array) != n_bias_groups: + self.log("Received the wrong number of biases. Expected an array of " + + "n_bias_groups={} voltages".format(n_bias_groups), self.LOG_ERROR) else: - # user may be using a DAC not in the 16x this is coded - # for for another purpose. Protect their enable state. - # It turns out if you set the Ctrl (enable) register - # to zero for one of these DACs, it rails negative, - # which sucks if, for instance, you're using it to - # bias the gate of a cold RF amplifier. FOR INSTANCE. - dacs_in_use=[] - for idx in np.arange(n_bias_groups): - dac_idx = np.ravel(np.where(bias_order == idx)) - - dac_positive = dac_positives[dac_idx][0] - 1 # freakin Mitch - dacs_in_use.append(dac_positive) - dac_negative = dac_negatives[dac_idx][0] - 1 # 1 vs 0 indexing - dacs_in_use.append(dac_negative) - - volts_pos = volt_array[idx] / 2 - volts_neg = - volt_array[idx] / 2 + for bg in np.arange(n_bias_groups): + bias_order = self.bias_group_to_pair[:,0] + dac_positives = self.bias_group_to_pair[:,1] + dac_negatives = self.bias_group_to_pair[:,2] + + bias_group_idx = np.ravel(np.where(bias_order == bg)) + + dac_positive = dac_positives[bias_group_idx][0] - 1 # freakin Mitch + dac_negative = dac_negatives[bias_group_idx][0] - 1 # 1 vs 0 indexing - if do_enable: - do_enable_array[dac_positive] = 2 - do_enable_array[dac_negative] = 2 + volts_pos = bias_group_volt_array[bg] / 2 + volts_neg = - bias_group_volt_array[bg] / 2 - bias_volt_array[dac_positive] = volts_pos - bias_volt_array[dac_negative] = volts_neg + if do_enable: + dac_enable_array[dac_positive] = 2 + dac_enable_array[dac_negative] = 2 - # before mucking with enables, make sure to carry the current - # values of any DACs that shouldn't be accessed by this call. - current_enable_array=self.get_tes_bias_enable_array() - current_tes_bias_array_volt=self.get_tes_bias_array_volt() - for idx in np.where(current_enable_array!=do_enable_array)[0]: - if idx not in dacs_in_use: - do_enable_array[idx]=current_enable_array[idx] - bias_volt_array[idx]=current_tes_bias_array_volt[idx] + dac_volt_array[dac_positive] = volts_pos + dac_volt_array[dac_negative] = volts_neg if do_enable: - self.set_tes_bias_enable_array(do_enable_array, **kwargs) + self.set_rtm_slow_dac_enable_array(dac_enable_array, **kwargs) - self.set_tes_bias_array_volt(bias_volt_array, **kwargs) + self.set_rtm_slow_dac_volt_array(dac_volt_array, **kwargs) def set_tes_bias_off(self, **kwargs): - """ - Turns off all TES biases - """ - - bias_array = np.zeros((32,), dtype=int) - self.set_tes_bias_array(bias_array, **kwargs) - - def tes_bias_dac_ramp(self, dac, volt_min=-9.9, volt_max=9.9, step_size=.01, wait_time=.05): - """ - """ - bias = volt_min - while True: - self.set_tes_bias_volt(dac, bias, wait_after=wait_time) - bias += step_size - if bias > volt_max: - bias = volt_min - + ''' + Turns off all of the DACs assigned to a TES bias group in the + pysmurf configuration file. + ''' + bias_groups=self.bias_group_to_pair[:,0] + self.set_tes_bias_bipolar_array(np.zeros(self._n_bias_groups), **kwargs) def get_tes_bias_bipolar(self, bias_group, return_raw=False, **kwargs): """ - Returns the bias voltage in units of Volts + Returns the bias voltage in units of Volts for the requested + TES bias group. Args: ----- - bias_group (int) : The number of the bias group + bias_group (int) : The number of the bias group. Asserts if + bias_group requested is not defined in the + pysmurf configuration file. Opt Args: --------- - return_raw (bool) : Default is False. If True, returns pos and neg - terminal values. - """ - bias_order = self.bias_group_to_pair[:,0] + return_raw (bool) : Default is False. If True, returns pos and + neg terminal values. + + Returns: + -------- + val (float) : The bipolar output TES bias voltage for the + requested bias group. If return_raw=True, then + returns a two element float array containing the + output voltages of the two DACs assigned to the + requested TES bias group. + """ + # Make sure the requested bias group is in the list of defined + # bias groups. + bias_groups = self.bias_group_to_pair[:,0] + assert (bias_group in bias_groups),f'Bias group {bias_group} is not defined (available bias groups are {bias_groups}). Doing nothing!' + + bias_order = bias_groups dac_positives = self.bias_group_to_pair[:,1] dac_negatives = self.bias_group_to_pair[:,2] dac_idx = np.ravel(np.where(bias_order == bias_group)) + dac_positive = dac_positives[dac_idx][0]-1 + dac_negative = dac_negatives[dac_idx][0]-1 - dac_positive = dac_positives[dac_idx][0] - dac_negative = dac_negatives[dac_idx][0] + volt_array = self.get_rtm_slow_dac_volt_array(**kwargs) + volts_pos = volt_array[dac_positive] + volts_neg = volt_array[dac_negative] - volts_pos = self.get_tes_bias_volt(dac_positive, **kwargs) - volts_neg = self.get_tes_bias_volt(dac_negative, **kwargs) - if return_raw: return volts_pos, volts_neg else: @@ -2181,12 +2074,12 @@ def get_tes_bias_bipolar_array(self, return_raw=False, **kwargs): dac_positives = self.bias_group_to_pair[:,1] dac_negatives = self.bias_group_to_pair[:,2] - n_bias_groups = 8 # fix this later! + n_bias_groups = self._n_bias_groups bias_vals_pos = np.zeros((n_bias_groups,)) bias_vals_neg = np.zeros((n_bias_groups,)) - volts_array = self.get_tes_bias_array_volt(**kwargs) + volts_array = self.get_rtm_slow_dac_volt_array(**kwargs) for idx in np.arange(n_bias_groups): dac_idx = np.ravel(np.where(bias_order == idx)) @@ -2222,7 +2115,7 @@ def set_amplifier_bias(self, bias_hemt=None, bias_50k=None, **kwargs): ######################################################################## ### 4K HEMT self.set_hemt_enable(**kwargs) - # if nothing specified take default from cfg file, if + # if nothing specified take default from cfg file, if # it's specified there bias_hemt_from_cfg=False if bias_hemt is None and hasattr(self,'hemt_Vg'): @@ -2232,25 +2125,25 @@ def set_amplifier_bias(self, bias_hemt=None, bias_50k=None, **kwargs): # set it and tell the user if not bias_hemt is None: if bias_hemt_from_cfg: - self.log('Setting HEMT LNA Vg from config file to Vg={0:.{1}f}'.format(bias_hemt, 4), + self.log('Setting HEMT LNA Vg from config file to Vg={0:.{1}f}'.format(bias_hemt, 4), self.LOG_USER) else: - self.log('Setting HEMT LNA Vg to requested Vg={0:.{1}f}'.format(bias_hemt, 4), + self.log('Setting HEMT LNA Vg to requested Vg={0:.{1}f}'.format(bias_hemt, 4), self.LOG_USER) self.set_hemt_gate_voltage(bias_hemt, override=True, **kwargs) # otherwise do nothing and warn the user else: - self.log('No value specified for 50K LNA Vg and didn\'t find a default in cfg (amplifier[\'hemt_Vg\']).', - self.LOG_ERROR) + self.log('No value specified for 50K LNA Vg and didn\'t find a ' + + 'default in cfg (amplifier[\'hemt_Vg\']).', self.LOG_ERROR) ### done with 4K HEMT ######################################################################## ######################################################################## ### 50K LNA (if present - could make this smarter and more general) self.set_50k_amp_enable(**kwargs) - # if nothing specified take default from cfg file, if + # if nothing specified take default from cfg file, if # it's specified there bias_50k_from_cfg=False if bias_50k is None and hasattr(self,'LNA_Vg'): @@ -2260,27 +2153,39 @@ def set_amplifier_bias(self, bias_hemt=None, bias_50k=None, **kwargs): # set it and tell the user if not bias_50k is None: if bias_50k_from_cfg: - self.log('Setting 50K LNA Vg from config file to Vg={0:.{1}f}'.format(bias_50k, 4), + self.log('Setting 50K LNA Vg from config file to Vg={0:.{1}f}'.format(bias_50k, 4), self.LOG_USER) else: - self.log('Setting 50K LNA Vg to requested Vg={0:.{1}f}'.format(bias_50k, 4), + self.log('Setting 50K LNA Vg to requested Vg={0:.{1}f}'.format(bias_50k, 4), self.LOG_USER) self.set_50k_amp_gate_voltage(bias_50k, **kwargs) # otherwise do nothing and warn the user else: - self.log('No value specified for 50K LNA Vg and didn\'t find a default in cfg (amplifier[\'LNA_Vg\']).', - self.LOG_ERROR) + self.log('No value specified for 50K LNA Vg and didn\'t find a ' + + 'default in cfg (amplifier[\'LNA_Vg\']).', self.LOG_ERROR) ### done with 50K LNA ############################################################################ - - # add some latency in case PIC needs it + + # add some latency in case PIC needs it time.sleep(1) # print amplifier biases after setting Vgs amplifier_biases=self.get_amplifier_biases() def get_amplifier_biases(self, write_log=True): + """ + Queries the amplifier biases + + Opt Args: + --------- + write_log (bool) : Whether to write to the log. Default is True. + + Ret: + ---- + amplifier_bias (dict) : Returns a dict with the hemt and 50K gate + voltage and drain current. + """ # 4K hemt_Id_mA=self.get_hemt_drain_current() hemt_gate_bias_volts=self.get_hemt_gate_voltage() @@ -2288,7 +2193,7 @@ def get_amplifier_biases(self, write_log=True): # 50K fiftyk_Id_mA=self.get_50k_amp_drain_current() fiftyk_amp_gate_bias_volts=self.get_50k_amp_gate_voltage() - + ret = { 'hemt_Vg' : hemt_gate_bias_volts, 'hemt_Id' : hemt_Id_mA, @@ -2311,8 +2216,7 @@ def get_hemt_drain_current(self): cur (float): Drain current in mA """ - # These values are hard coded and empirically found by Shawn - # hemt_offset=0.100693 #Volts + # on cryostat card hemt_Vd_series_resistor=200 #Ohm hemt_Id_mA=2.*1000.*(self.get_cryo_card_hemt_bias())/hemt_Vd_series_resistor - self._hemt_Id_offset @@ -2324,11 +2228,14 @@ def get_50k_amp_drain_current(self): -------- cur (float): The drain current in mA """ - asu_amp_Vd_series_resistor=10 #Ohm - asu_amp_Id_mA=2.*1000.*(self.get_cryo_card_50k_bias()/ - asu_amp_Vd_series_resistor) - return asu_amp_Id_mA + # on cryostat card + fiftyK_amp_Vd_series_resistor=10 #Ohm + fiftyK_amp_Id_mA=2.*1000.*(self.get_cryo_card_50k_bias()/ + fiftyK_amp_Vd_series_resistor) + + return fiftyK_amp_Id_mA + def overbias_tes(self, bias_group, overbias_voltage=19.9, overbias_wait=5., tes_bias=19.9, cool_wait=20., high_current_mode=True, flip_polarity=False): @@ -2337,7 +2244,8 @@ def overbias_tes(self, bias_group, overbias_voltage=19.9, overbias_wait=5., Args: ----- - bias_group (int): The bias group to overbias + bias_group (int): The bias group to overbias. Asserts if not + a valid bias group. Opt Args: --------- @@ -2347,14 +2255,17 @@ def overbias_tes(self, bias_group, overbias_voltage=19.9, overbias_wait=5., Default is .5 tes_bias (float): The value of the TES bias when put back in low current mode. Default is 19.9. - cool_wait (float): The time to wait after setting the TES bias for + cool_wait (float): The time to wait after setting the TES bias for transients to die off. """ + bias_groups = self.bias_group_to_pair[:,0] + assert (bias_group in bias_groups),f'Bias group {bias_group} is not defined (available bias groups are {bias_groups}). Doing nothing!' + # drive high current through the TES to attempt to drive normal self.set_tes_bias_bipolar(bias_group, overbias_voltage, flip_polarity=flip_polarity) time.sleep(.1) - + self.set_tes_bias_high_current(bias_group) self.log('Driving high current through TES. ' + \ 'Waiting {}'.format(overbias_wait), self.LOG_USER) @@ -2367,34 +2278,40 @@ def overbias_tes(self, bias_group, overbias_voltage=19.9, overbias_wait=5., time.sleep(cool_wait) self.log('Done waiting.', self.LOG_USER) - def overbias_tes_all(self, bias_groups=None, overbias_voltage=19.9, - overbias_wait=1.0, tes_bias=19.9, cool_wait=20., + + def overbias_tes_all(self, bias_groups=None, overbias_voltage=19.9, + overbias_wait=1.0, tes_bias=19.9, cool_wait=20., high_current_mode=True): """ - Warning: This is horribly hardcoded. Needs a fix soon. - CY edit 20181119 to make it even worse lol - EY edit 20181112 made it slightly better... - - Args: - ----- + Overbiases all requested bias groups (specified by the + bias_groups array) at overbias_voltage in high current mode + for overbias_wait seconds. If high_current_mode=False, + returns to low current mode, after which it biases the TESs at + tes_bias. Then waits cool_wait seconds before returning + control. Opt Args: --------- - bias_groups (array): which bias groups to overbias. defaults to all_groups - overbias_voltage (float): The value of the TES bias in the high current - mode. Default 19.9. - overbias_wait (float): The time to stay in high current mode in seconds. - Default is .5 - tes_bias (float): The value of the TES bias when put back in low current - mode. Default is 19.9. - cool_wait (float): The time to wait after setting the TES bias for - transients to die off. - """ + bias_groups (array): which bias groups to overbias. defaults + to all_groups. Asserts if any of the + bias groups listed is not a defined bias + group. + overbias_voltage (float): The value of the TES bias in the + high current mode. Default 19.9. + overbias_wait (float): The time to stay in high current mode + in seconds. Default is .5 + tes_bias (float): The value of the TES bias when put back in + low current mode. Default is 19.9. + cool_wait (float): The time to wait after setting the TES bias + for transients to die off. + """ # drive high current through the TES to attempt to drive normal if bias_groups is None: bias_groups = self.all_groups - #voltage_overbias_array = np.zeros((8,)) # currently hardcoded for 8 bias groups + valid_bias_groups = self.bias_group_to_pair[:,0] + assert (all(bg in valid_bias_groups for bg in bias_groups)),f'Some of the bias groups requested are not valid (available bias groups are {valid_bias_groups}). Doing nothing!' + voltage_overbias_array = self.get_tes_bias_bipolar_array() voltage_overbias_array[bias_groups] = overbias_voltage self.set_tes_bias_bipolar_array(voltage_overbias_array) @@ -2408,12 +2325,11 @@ def overbias_tes_all(self, bias_groups=None, overbias_voltage=19.9, self.log('setting to low current') self.set_tes_bias_low_current(bias_groups) - # voltage_bias_array = np.zeros((8,)) # currently hardcoded for 8 bias groups voltage_bias_array = self.get_tes_bias_bipolar_array() voltage_bias_array[bias_groups] = tes_bias self.set_tes_bias_bipolar_array(voltage_bias_array) - self.log('Waiting {:3.2f} seconds to cool'.format(cool_wait), + self.log('Waiting {:3.2f} seconds to cool'.format(cool_wait), self.LOG_USER) time.sleep(cool_wait) self.log('Done waiting.', self.LOG_USER) @@ -2423,11 +2339,11 @@ def set_tes_bias_high_current(self, bias_group, write_log=False): """ Sets all bias groups to high current mode. Note that the bias group number is not the same as the relay number. It also does not matter, - because Joe's code secretly flips all the relays when you flip one. + because Joe's code secretly flips all the relays when you flip one. Args: ----- - bias_group (int): The bias group(s) to set to high current mode REMOVED + bias_group (int): The bias group(s) to set to high current mode REMOVED 20190101 BECAUSE JOE'S CODE SECRETLY FLIPS ALL OF THEM ANYWAYS -CY """ old_relay = self.get_cryo_card_relays() @@ -2435,13 +2351,10 @@ def set_tes_bias_high_current(self, bias_group, write_log=False): new_relay = np.copy(old_relay) self.log('Old relay {}'.format(bin(old_relay))) - # bias_group = 0 # just pick the first one arbitrarily - #self.log('Flipping bias group 0 relay only; Joe code will secretly' + - # 'flip all of them') - + n_bias_groups = self._n_bias_groups bias_group = np.ravel(np.array(bias_group)) for bg in bias_group: - if bg < 16: + if bg < n_bias_groups: r = np.ravel(self.pic_to_bias_group[np.where( self.pic_to_bias_group[:,1]==bg)])[0] else: @@ -2451,16 +2364,17 @@ def set_tes_bias_high_current(self, bias_group, write_log=False): self.set_cryo_card_relays(new_relay, write_log=write_log) self.get_cryo_card_relays() + def set_tes_bias_low_current(self, bias_group, write_log=False): """ Sets all bias groups to low current mode. Note that the bias group - number is not the same as the relay number. It also does not matter, + number is not the same as the relay number. It also does not matter, because Joe's code secretly flips all the relays when you flip one Args: ----- bias_group (int): The bias group to set to low current mode REMOVED - 20190101 BECAUSE JOE'S CODE WILL FLIP ALL BIAS GROUPS WHEN ONE IS + 20190101 BECAUSE JOE'S CODE WILL FLIP ALL BIAS GROUPS WHEN ONE IS COMMANDED -CY """ old_relay = self.get_cryo_card_relays() @@ -2471,10 +2385,11 @@ def set_tes_bias_low_current(self, bias_group, write_log=False): #self.log('Flipping bias group 0 relay only; PIC code will flip all ' + # 'of them') + n_bias_groups = self._n_bias_groups bias_group = np.ravel(np.array(bias_group)) self.log('Old relay {}'.format(bin(old_relay))) for bg in bias_group: - if bg < 16: + if bg < n_bias_groups: r = np.ravel(self.pic_to_bias_group[np.where( self.pic_to_bias_group[:,1]==bg)])[0] else: @@ -2485,6 +2400,7 @@ def set_tes_bias_low_current(self, bias_group, write_log=False): self.set_cryo_card_relays(new_relay, write_log=write_log) self.get_cryo_card_relays() + def set_mode_dc(self, write_log=False): """ Sets it DC coupling @@ -2503,6 +2419,7 @@ def set_mode_dc(self, write_log=False): self.set_cryo_card_relays(new_relay, write_log=write_log) self.get_cryo_card_relays() + def set_mode_ac(self, write_log=False): """ Sets it to AC coupling @@ -2538,16 +2455,6 @@ def band_to_att(self, band): return self.att_to_band['att'][np.ravel( np.where(self.att_to_band['band']==band))[0]] - -# def make_gcp_mask_file(self, bands=[2,3], channels_per_band=512): -# """ -# """ -# chs = np.array([]) -# for b in bands: -# chs = np.append(chs, self.which_on(b)+b*channels_per_band) - -# return chs - def flux_ramp_rate_to_PV(self, val): """ Convert between the desired flux ramp reset rate and the PV number @@ -2578,18 +2485,17 @@ def flux_ramp_PV_to_rate(self, val): """ rates_kHz = [15, 12, 10, 8, 6, 5, 4, 3, 2, 1] - return rates_kHz[val] + return rates_kHz[val] def why(self): """ Why not? """ util_dir = os.path.dirname(__file__) - aphorisms = np.loadtxt(os.path.join(util_dir, 'aphorism.txt'), + aphorisms = np.loadtxt(os.path.join(util_dir, 'aphorism.txt'), dtype='str', delimiter='\n') self.log(np.random.choice(aphorisms)) - return def read_smurf_to_gcp_config(self): @@ -2608,7 +2514,7 @@ def make_smurf_to_gcp_config(self, num_averages=None, filename=None, address, port number, data file name, etc. The IP and port are set in the config file. They cannot be updated - in runtime. + in runtime. Opt args: --------- @@ -2618,10 +2524,10 @@ def make_smurf_to_gcp_config(self, num_averages=None, filename=None, number of smurf frames. filename (str): The filename to save the data to. If not provided, automatically uses the current timestamp. - file_name_extend (bool): If True, appends the data file name with + file_name_extend (bool): If True, appends the data file name with the current timestamp. This is a relic of Joes original code. Default is False and should probably always be False. - data_frames (int): The number of frames to store. Works up to + data_frames (int): The number of frames to store. Works up to 2000000, which is about a 5GB file. Default is 2000000 gain (float): The number to multiply the data by. Default is 255.5 which makes it match GCP units. @@ -2642,7 +2548,7 @@ def make_smurf_to_gcp_config(self, num_averages=None, filename=None, if filename is None: filename = self.get_timestamp() + '.dat' data_file_name = os.path.join(self.data_dir, filename) - + flux_ramp_freq = self.get_flux_ramp_freq() * 1E3 # in Hz if flux_ramp_freq < 1000: flux_ramp_freq = 4000 @@ -2684,7 +2590,67 @@ def make_smurf_to_gcp_config(self, num_averages=None, filename=None, return ret - def make_gcp_mask(self, band=None, smurf_chans=None, gcp_chans=None, + + def get_smurf_to_mce_file(self): + """ + Reads in the most recent smurf_to_mce file and returns + everything in it as a dict. + + Ret: + ---- + smurf_to_mce_dict (dict) : A dict with all the information + in smurf_to_mce + """ + # Load data + cfg = np.loadtxt(self.smurf_to_mce_file, dtype='str') + n_params, _ = np.shape(cfg) + ret = {} + + # Cast into dict + for i in np.arange(n_params): + ret[cfg[i,0]] = cfg[i,1] + + return ret + + def get_filter_params(self): + """ + Get the downsample filter parameters: filter order, + filter gain, num averages, and the actual filter + parameters. This reads the most recent smurf_to_mce_file + to get the parameters. + + Ret: + ---- + filter_params (dict) : A dictionary with the filter + parameters. + """ + # Load cfg file + cfg = self.get_smurf_to_mce_file() + + # Get filter order + filter_order = int(cfg['filter_order']) + filter_gain = float(cfg['filter_gain']) + num_averages = int(cfg['num_averages']) + + # Get filter parameters + a = np.zeros(filter_order, dtype=float) + b = np.zeros(filter_order, dtype=float) + for i in range(filter_order): + a[i] = cfg[f'filter_a{i}'] + b[i] = cfg[f'filter_b{i}'] + + ret = { + 'filter_order' : filter_order, + 'filter_gain': filter_gain, + 'num_averages' : num_averages, + 'filter_a' : a, + 'filter_b' : b + } + + return ret + + + def make_gcp_mask(self, band=None, smurf_chans=None, gcp_chans=None, read_gcp_mask=True, mask_channel_offset=0): """ Makes the gcp mask. Only the channels in this mask will be stored @@ -2704,12 +2670,12 @@ def make_gcp_mask(self, band=None, smurf_chans=None, gcp_chans=None, on as GCP channels. read_gcp_mask (bool) : Whether to read in the new GCP mask file. If not read in, it will take no effect. Default is True. - mask_channel_offset (int) : Offset to add to channel numbers in GCP + mask_channel_offset (int) : Offset to add to channel numbers in GCP mask file. Default is 0. """ if self.config.get('smurf_to_mce').get('mask_channel_offset') is not None: mask_channel_offset=int(self.config.get('smurf_to_mce').get('mask_channel_offset')) - + gcp_chans = np.array([], dtype=int) if smurf_chans is None and band is not None: band = np.ravel(np.array(band)) @@ -2728,8 +2694,8 @@ def make_gcp_mask(self, band=None, smurf_chans=None, gcp_chans=None, if (ch+channel_offset)<0: channel_offset+=n_chan if (ch+channel_offset+1)>n_chan: - channel_offset-=n_chan - + channel_offset-=n_chan + gcp_chans = np.append(gcp_chans, ch + n_chan*k + channel_offset) if len(gcp_chans) > 512: @@ -2742,8 +2708,10 @@ def make_gcp_mask(self, band=None, smurf_chans=None, gcp_chans=None, 'IN CFG TO DYNAMICALLY GENERATE MASKS!!!') else: self.log('Generating gcp mask file. {} channels added'.format(len(gcp_chans))) + np.savetxt(self.smurf_to_mce_mask_file, gcp_chans, fmt='%i') - + self.pub.register_file(self.smurf_to_mce_mask_file, 'mask', format='txt') + if read_gcp_mask: self.read_smurf_to_gcp_config() else: @@ -2760,7 +2728,7 @@ def bias_bump(self, bias_group, wait_time=.5, step_size=.001, duration=5, and resistance. This is optimized for high_current_mode. For low current mode, you will need - to step much slower. Try wait_time=1, step_size=.015, duration=10, + to step much slower. Try wait_time=1, step_size=.015, duration=10, skip_samp_start=50, skip_samp_end=50. Note that only the resistance is well defined now because the phase response @@ -2770,7 +2738,7 @@ def bias_bump(self, bias_group, wait_time=.5, step_size=.001, duration=5, ----- bias_group (int of int array): The bias groups to toggle. The response will return every detector that is on. - + Opt Args: -------- wait_time (float) : The time to wait between steps @@ -2788,7 +2756,7 @@ def bias_bump(self, bias_group, wait_time=.5, step_size=.001, duration=5, Default is True. make_plot (bool) : Whether to make plots. Must set some channels in plot_channels. plot_channels (int array) : The channels to plot. - dat_file (str) : filename to read bias-bump data from; if provided, data is read + dat_file (str) : filename to read bias-bump data from; if provided, data is read from file instead of being measured live Ret: @@ -2811,7 +2779,7 @@ def bias_bump(self, bias_group, wait_time=.5, step_size=.001, duration=5, if start_bias is None: start_bias = np.array([]) for bg in bias_group: - start_bias = np.append(start_bias, + start_bias = np.append(start_bias, self.get_tes_bias_bipolar(bg)) else: start_bias = np.ravel(np.array(start_bias)) @@ -2819,7 +2787,7 @@ def bias_bump(self, bias_group, wait_time=.5, step_size=.001, duration=5, n_step = int(np.floor(duration / wait_time / 2)) i_bias = start_bias[0] / self.bias_line_resistance - + if high_current_mode: self.set_tes_bias_high_current(bias_group) i_bias *= self.high_low_current_ratio @@ -2865,8 +2833,8 @@ def bias_bump(self, bias_group, wait_time=.5, step_size=.001, duration=5, return t, d, m = self.read_stream_data(filename) - d *= self.pA_per_phi0/(2*np.pi*1.0E6) # Convert to microamps - i_amp = step_size / self.bias_line_resistance * 1.0E6 # also uA + d *= self.pA_per_phi0/(2*np.pi*1.0E6) # Convert to microamps + i_amp = step_size / self.bias_line_resistance * 1.0E6 # also uA if high_current_mode: i_amp *= self.high_low_current_ratio @@ -2880,17 +2848,15 @@ def bias_bump(self, bias_group, wait_time=.5, step_size=.001, duration=5, # The vector to multiply by to get the DC offset n_tile = int(duration/wait_time/2)-1 - high = np.tile(np.append(np.append(np.nan*np.zeros(skip_samp_start), + high = np.tile(np.append(np.append(np.nan*np.zeros(skip_samp_start), np.ones(n_demod-skip_samp_start-skip_samp_end)), np.nan*np.zeros(skip_samp_end+n_demod)),n_tile) - low = np.tile(np.append(np.append(np.nan*np.zeros(n_demod+skip_samp_start), + low = np.tile(np.append(np.append(np.nan*np.zeros(n_demod+skip_samp_start), np.ones(n_demod-skip_samp_start-skip_samp_end)), np.nan*np.zeros(skip_samp_end)),n_tile) timestamp = filename.split('/')[-1].split('.')[0] - if make_plot: - import matplotlib.pyplot as plt - + for i, (b, c) in enumerate(zip(bands, channels)): mm = m[b, c] # Convolve to find the start of the bias step @@ -2920,6 +2886,8 @@ def bias_bump(self, bias_group, wait_time=.5, step_size=.001, duration=5, plot_fn = '%s/%s_biasBump_b%d_ch%03d' % (self.plot_dir,\ timestamp,b,c) plt.savefig(plot_fn) + self.pub.register_file(plot_fn, 'bias_bump', plot=True) + self.log('Response plot saved to %s' % (plot_fn)) resistance = np.abs(self.R_sh * (1-1/sib)) @@ -2939,9 +2907,10 @@ def bias_bump(self, bias_group, wait_time=.5, step_size=.001, duration=5, #return bands, channels, resistance, sib, siq return ret + def all_off(self): """ - Turns off EVERYTHING + Turns off everything. Does band off, flux ramp off, then TES bias off. """ self.log('Turning off tones') bands = self.config.get('init').get('bands') @@ -2952,7 +2921,8 @@ def all_off(self): self.flux_ramp_off() self.log('Turning off all TES biases') - for bg in np.arange(8): + n_bias_groups = self._n_bias_groups + for bg in np.arange(n_bias_groups): self.set_tes_bias_bipolar(bg, 0) @@ -2990,6 +2960,21 @@ def gcp_num_to_mask_num(self, gcp_num): def smurf_channel_to_gcp_num(self, band, channel, mask_file=None): """ + Converts from smurf channel (band and channel) to a gcp number + + Args: + ----- + band (int) : The smurf band number + channel (int) : The smurf channel number + + Opt Args: + --------- + mask_file (int array) : The mask file to convert between smurf channel + and GCP number. + + Ret: + ---- + gcp_num (int) : The GCP number """ if mask_file is None: mask_file = self.smurf_to_mce_mask_file @@ -3005,11 +2990,26 @@ def smurf_channel_to_gcp_num(self, band, channel, mask_file=None): def gcp_num_to_smurf_channel(self, gcp_num, mask_file=None): """ + Converts from gcp number to smurf channel (band and channel). + + Args: + ----- + gcp_num (int) : The GCP number + + Opt Args: + --------- + mask_file (int array) : The mask file to convert between smurf channel + and GCP number. + + Ret: + ---- + band (int) : The smurf band number + channel (int) : The smurf channel number """ if mask_file is None: mask_file = self.smurf_to_mce_mask_file mask = np.loadtxt(mask_file) - + mask_num = self.gcp_num_to_mask_num(gcp_num) return int(mask[mask_num]//512), int(mask[mask_num]%512) @@ -3029,21 +3029,21 @@ def play_tone_file(self, band, tone_file=None, load_tone_file=True): tone_file (str) : Path (including csv file name) to tone file. If none given, uses whatever's already been loaded. load_tone_file (bool) : Whether or not to load the tone file. - The tone file is loaded per DAC, so if you - already loaded the tone file for this DAC you + The tone file is loaded per DAC, so if you + already loaded the tone file for this DAC you don't have to do it again. """ # the bay corresponding to this band. bay=self.band_to_bay(band) - + # load the tone file if load_tone_file: self.load_tone_file(bay,tone_file) # play it! self.log('Playing tone file {} on band {}'.format(tone_file,band), - self.LOG_USER) + self.LOG_USER) self.set_waveform_select(band,1) def stop_tone_file(self, band): @@ -3060,8 +3060,8 @@ def stop_tone_file(self, band): # may need to do this, not sure. Try without # for now. - #self.set_dsp_enable(band,1) - + #self.set_dsp_enable(band,1) + def get_gradient_descent_params(self, band): """ @@ -3087,7 +3087,7 @@ def get_gradient_descent_params(self, band): ret['step_hz'] = self.get_gradient_descent_step_hz(band) return ret - + def set_fixed_tone(self,freq_mhz,drive,quiet=False): """ @@ -3119,21 +3119,21 @@ def set_fixed_tone(self,freq_mhz,drive,quiet=False): # Confirm that the requested frequency falls into a 500 MHz # band that's usable in this fw. If not, assert. assert (np.abs(freq_mhz-band_center_mhz)<250),'! Requested frequency (=%0.1f MHz) outside of the 500 MHz band with the closest band center (=%0.0f MHz). Doing nothing!'%(freq_mhz,band_center_mhz) - + # Find subband this frequency falls in, and its channels. subband,foff=self.freq_to_subband(band,freq_mhz) subband_channels=self.get_channels_in_subband(band,subband) - + # Which channels in the subband are unallocated? allocated_channels=self.which_on(band) unallocated_channels=[chan for chan in subband_channels if chan not in allocated_channels] # If no unallocated channels available in the subband, assert. assert (len(unallocated_channels)),'! No unallocated channels available in subband (=%d). Doing nothing!'%(subband) - + # Take lowest channel number in the list of unallocated # channels for this subband. channel=sorted(unallocated_channels)[0] - + # Put a fixed tone at the requested frequency self.set_center_frequency_mhz_channel(band,channel,foff) self.set_amplitude_scale_channel(band,channel,drive) @@ -3143,7 +3143,7 @@ def set_fixed_tone(self,freq_mhz,drive,quiet=False): # tone. if not quiet: self.log('Setting a fixed tone at {0:.2f} MHz'.format(freq_mhz) + \ - ' and amplitude {}'.format(drive), self.LOG_USER) + ' and amplitude {}'.format(drive), self.LOG_USER) # SHOULD MAKE A GET FIXED TONE CHANNELS FUNCTION - WOULD MAKE IT # EASIER TO CHANGE THINGS FAST USING THE ARRAY GET/SETS @@ -3161,7 +3161,7 @@ def turn_off_fixed_tones(self,band): --------- quiet (bool) : Whether to look at one channel - """ + """ amplitude_scale_array=self.get_amplitude_scale_array(band) feedback_enable_array=self.get_feedback_enable_array(band) @@ -3174,17 +3174,17 @@ def turn_off_fixed_tones(self,band): # set by array, not by channel self.set_amplitude_scale_array(band,new_amplitude_scale_array) - __hardware_logging_pause_event=None + __hardware_logging_pause_event=None def pause_hardware_logging(self): self.__hardware_logging_pause_event.set() def resume_hardware_logging(self): self.__hardware_logging_pause_event.clear() - __hardware_log_file=None + __hardware_log_file=None def get_hardware_log_file(self): return self.__hardware_log_file - + _hardware_logging_thread=None __hardware_logging_stop_event=None def start_hardware_logging(self,filename=None): @@ -3195,7 +3195,7 @@ def start_hardware_logging(self,filename=None): self.log('Starting hardware logging to file : {}'.format(self.__hardware_log_file), self.LOG_USER) self.__hardware_logging_stop_event=threading.Event() - self.__hardware_logging_pause_event=threading.Event() + self.__hardware_logging_pause_event=threading.Event() self._hardware_logging_thread = threading.Thread(target=self._hardware_logger, args=(self.__hardware_logging_pause_event,self.__hardware_logging_stop_event,)) self._hardware_logging_thread.daemon = True self._hardware_logging_thread.start() @@ -3225,7 +3225,7 @@ def _hardware_logger(self,pause_event,stop_event,wait_btw_sec=5): with open(filename) as logf: hdr2=logf.readline() if not hdr.rstrip().split() == hdr2.rstrip().split(): - self.log('Attempting to temperature log to an incompatible file. Giving up without logging any data!', + self.log('Attempting to temperature log to an incompatible file. Giving up without logging any data!', self.LOG_ERROR) return @@ -3247,16 +3247,16 @@ def get_hardware_log_entry(self): d['fpgca_vccint']=self.get_fpga_vccint d['fpgca_vccaux']=self.get_fpga_vccaux d['fpgca_vccbram']=self.get_fpga_vccbram - d['cc_temp']=self.get_cryo_card_temp - + d['cc_temp']=self.get_cryo_card_temp + # probably should check for which AMCs are in in a smarter way bays=[] bands=self.which_bands() if 0 in bands: bays.append(0) if 4 in bands: - bays.append(1) - + bays.append(1) + for bay in bays: for dac in [0,1]: d['bay%d_dac%d_temp'%(bay,dac)]=lambda:self.get_dac_temp(bay,dac) @@ -3265,13 +3265,19 @@ def get_hardware_log_entry(self): # keep track of how many tones are on in each band #for band in bands: # d['chans_b%d'%band]=lambda:len(self.which_on(band)) - + # atca monitor d['atca_temp_fpga']=self.get_board_temp_fpga d['atca_temp_rtm']=self.get_board_temp_rtm d['atca_temp_amc0']=self.get_board_temp_amc0 d['atca_temp_amc2']=self.get_board_temp_amc2 d['atca_jct_temp_fpga']=self.get_junction_temp_fpga + + # regulator + d['regulator_iout']=self.get_regulator_iout + d['regulator_temp1']=self.get_regulator_temp1 + d['regulator_temp2']=self.get_regulator_temp2 + columns=[] names=[] fmt='' @@ -3282,11 +3288,59 @@ def get_hardware_log_entry(self): fmt+='{0[%d]:<20}'%counter counter+=1 fmt+='\n' - + hdr=fmt.format(names) row=fmt.format(columns) return hdr,row - - - - + + def play_tes_bipolar_waveform(self, bias_group, waveform, do_enable=True, **kwargs): + """ + bias_group (int): The bias group + """ + bias_order = self.bias_group_to_pair[:,0] + dac_positives = self.bias_group_to_pair[:,1] + dac_negatives = self.bias_group_to_pair[:,2] + + dac_idx = np.ravel(np.where(bias_order == bias_group)) + + dac_positive = dac_positives[dac_idx][0] + dac_negative = dac_negatives[dac_idx][0] + + # https://confluence.slac.stanford.edu/display/SMuRF/SMuRF+firmware#SMuRFfirmware-RTMDACarbitrarywaveforms + # Target the two bipolar DACs assigned to this bias group: + self.set_dac_axil_addr(0,dac_positive) + self.set_dac_axil_addr(1,dac_negative) + + # Enable waveform generation (3=on both DACs) + self.set_rtm_arb_waveform_enable(3) + + # Must enable the DACs (if not enabled already) + if do_enable: + self.set_rtm_slow_dac_enable(dac_positive, 2, **kwargs) + self.set_rtm_slow_dac_enable(dac_negative, 2, **kwargs) + + # Load waveform into each DAC's LUT table. Opposite sign so + # they combine coherently + self.set_rtm_arb_waveform_lut_table(0,waveform) + self.set_rtm_arb_waveform_lut_table(1,-waveform) + + # Continous mode to play the waveform continuously + self.set_rtm_arb_waveform_continuous(1) + + # Readback on which DACs are selected is broken right now, + # so has to be specified. + def stop_tes_bipolar_waveform(self, bias_group, zero=0, **kwargs): + """ + bias_group (int): The bias group + """ + # https://confluence.slac.stanford.edu/display/SMuRF/SMuRF+firmware#SMuRFfirmware-RTMDACarbitrarywaveforms + # Target the two bipolar DACs assigned to this bias group: + self.set_dac_axil_addr(0,0) # Disabled + self.set_dac_axil_addr(1,0) # Disabled + + # Enable waveform generation (3=on both DACs) + self.set_rtm_arb_waveform_enable(0) + + # Zero TES biases on this bias group + self.set_tes_bias_bipolar(bias_group, 0) + diff --git a/util/tools.py b/pysmurf/util/tools.py similarity index 82% rename from util/tools.py rename to pysmurf/util/tools.py index 8074a7a27..8f7454ebf 100644 --- a/util/tools.py +++ b/pysmurf/util/tools.py @@ -1,3 +1,13 @@ +#!/usr/bin/env python +#----------------------------------------------------------------------------- +# This file is part of the pysmurf software package. It is subject to +# the license terms in the LICENSE.txt file found in the top-level directory +# of this distribution and at: +# https://confluence.slac.stanford.edu/display/ppareg/LICENSE.html. +# No part of the pysmurf software package, including this file, may be +# copied, modified, propagated, or distributed except according to the terms +# contained in the LICENSE.txt file. +#----------------------------------------------------------------------------- import numpy as np from scipy.optimize import curve_fit diff --git a/watchdog/JesdWatchdog.py b/pysmurf/watchdog/JesdWatchdog.py similarity index 82% rename from watchdog/JesdWatchdog.py rename to pysmurf/watchdog/JesdWatchdog.py index 6976c1673..0fdddde2e 100644 --- a/watchdog/JesdWatchdog.py +++ b/pysmurf/watchdog/JesdWatchdog.py @@ -1,5 +1,18 @@ #!/usr/bin/env python - +#----------------------------------------------------------------------------- +# Title : pysmurf watchdog module - JesdWatchdog class +#----------------------------------------------------------------------------- +# File : pysmurf/watchdog/JesdWatchdog.py +# Created : 2018-12-06 +#----------------------------------------------------------------------------- +# This file is part of the pysmurf software package. It is subject to +# the license terms in the LICENSE.txt file found in the top-level directory +# of this distribution and at: +# https://confluence.slac.stanford.edu/display/ppareg/LICENSE.html. +# No part of the pysmurf software package, including this file, may be +# copied, modified, propagated, or distributed except according to the terms +# contained in the LICENSE.txt file. +#----------------------------------------------------------------------------- import logging import sys import os diff --git a/requirements.txt b/requirements.txt new file mode 100644 index 000000000..3f12e9eb4 --- /dev/null +++ b/requirements.txt @@ -0,0 +1,3 @@ +numpy +scipy +pyepics diff --git a/scratch/eyy/test_scripts/generic_test.py b/scratch/eyy/test_scripts/generic_test.py new file mode 100644 index 000000000..91be61b45 --- /dev/null +++ b/scratch/eyy/test_scripts/generic_test.py @@ -0,0 +1,39 @@ +import numpy as np +import pysmurf + +status = {} + +# Initialize +S = pysmurf.SmurfControl() + +# Get amplifier biases + +# Turn on one tone + +# read ADC/DAC + +# Turn off tone + +# read ADC/DAC + +# full band response + +# find_freq + +# setup notches + +# Actually take a tuning serial gradient descent using tune_band_serial + +# track + +# now track and check + +# take data + +# read back data + +# now take data using take_noise_psd and plot stuff + +# Command and IV. + +# Play TES tone file \ No newline at end of file diff --git a/scratch/shawn/arb_waveform.py b/scratch/shawn/arb_waveform.py new file mode 100644 index 000000000..f16db5491 --- /dev/null +++ b/scratch/shawn/arb_waveform.py @@ -0,0 +1,6 @@ +multiplier=1/100. +scale = 2**17; +sig = multiplier*scale*np.cos(2*np.pi*np.array(range(2048))/2048); + +S.play_tes_bipolar_waveform(7,sig) +S.stop_tes_bipolar_waveform(7) diff --git a/scratch/shawn/full_band_test.py b/scratch/shawn/full_band_test.py new file mode 100644 index 000000000..6b545ead6 --- /dev/null +++ b/scratch/shawn/full_band_test.py @@ -0,0 +1,54 @@ +# Runlike this exec(open("band_filling_test.py").read()) +# to use the pysmurf S object you've already initialized +import time +import numpy as np +import sys + +bands=S.config.get('init').get('bands') + +amplitude=10 +wait=True +wait_time_sec=0.1 + +# optional argument +timestamp=None +#if len(sys.argv)>1: +# timestamp=int(sys.argv[1]) + +freqs = ((-2.4, -1.1, 0.7, 2.1)) + + +channels=[] + +#for sb in np.arange(64,116): +for sb in np.arange(12,116): + for i in range(4): + channels.append(S.get_channels_in_subband(bands[0],sb)[i]) + +j = 0 +freq_array = np.zeros((1,512)) +amp_array = np.zeros((1,512), 'int') +for ch in channels: + freq_array[0][ch] = 0.1*np.random.rand(1)+freqs[j%4] + amp_array[0][ch] = amplitude + j = j + 1 + + +for band in bands: + print(' ') + print(' ') + print(band) + print(' ') + print(' ') + S.set_center_frequency_array(band, freq_array[0] + 0.1*np.random.rand(1,512)[0]) + S.set_amplitude_scale_array(band, amp_array[0]) + S.set_eta_mag_array(band, np.ones((1,512))[0]) + +time.sleep(2) + +# Save DAC and ADC spectra +for band in bands: + S.read_dac_data(band, show_plot=False, do_plot=True, plot_ylimits=[1e-8,1e3],timestamp=timestamp) + S.read_adc_data(band, show_plot=False, do_plot=False, plot_ylimits=[1e-8,1e3],timestamp=timestamp) + +print('Done with half-band filling test.') diff --git a/scratch/shawn/randomize_eta_mags.py b/scratch/shawn/randomize_eta_mags.py new file mode 100644 index 000000000..1984d5522 --- /dev/null +++ b/scratch/shawn/randomize_eta_mags.py @@ -0,0 +1,7 @@ +for band in range(8): + print(band) + ema=S.get_eta_mag_array(band) + S.set_eta_mag_array(band,.5*np.ones_like(ema)+np.random.rand(len(ema))/10.) + time.sleep(5) + + diff --git a/scratch/shawn/restrict_to_random_channel_subset.py b/scratch/shawn/restrict_to_random_channel_subset.py new file mode 100644 index 000000000..f80069a96 --- /dev/null +++ b/scratch/shawn/restrict_to_random_channel_subset.py @@ -0,0 +1,13 @@ +for band in range(8): + restrict_nper_band=250 + print('-> Restricting nchan to %d.'%restrict_nper_band) + import random + assigned_channels=np.where(asa!=0)[0] + ntotal=len(assigned_channels) + n2kill=(ntotal-restrict_nper_band) + channels2kill=random.sample(list(assigned_channels),n2kill) + cfa[channels2kill]=0 + asa[channels2kill]=0 + + S.set_center_frequency_array(band,cfa) + S.set_amplitude_scale_array(band,asa) diff --git a/scratch/shawn/scripts/init_rflab.py b/scratch/shawn/scripts/init_rflab.py index cadc9ae0f..40763ceac 100644 --- a/scratch/shawn/scripts/init_rflab.py +++ b/scratch/shawn/scripts/init_rflab.py @@ -14,6 +14,9 @@ else: assert False,"There isn't a SMuRF carrier in slot %d right now!"%slot + +config_file='experiment_rflab_thermal_testing_201907.cfg' config_file=os.path.join(config_file_path,config_file) + S = pysmurf.SmurfControl(epics_root=epics_prefix,cfg_file=config_file,setup=False,make_logfile=False) diff --git a/scratch/shawn/scripts/shawnhammer.sh b/scratch/shawn/scripts/shawnhammer.sh index efa69721d..25e0f0ba8 100755 --- a/scratch/shawn/scripts/shawnhammer.sh +++ b/scratch/shawn/scripts/shawnhammer.sh @@ -1,37 +1,17 @@ #!/bin/bash +startup_cfg=/data/smurf_startup_cfg/smurf_startup.cfg +if [ ! -f "$startup_cfg" ]; then + echo "$startup_cfg doesn't exist, unable to shawnhammer." + exit 1 +fi + +# didn't exit, so there must be a startup cfg file. Load it. +source ${startup_cfg} source shawnhammerfunctions ctime=`date +%s` -shelfmanager=shm-smrf-sp01 - -set_crate_fans_to_full=true -# COMTEL max fan level is 100, ASIS is 15, ELMA is 15 -## COMTEL in RF lab -#max_fan_level=100 -## ELMA in RF lab -#max_fan_level=15 -## ASIS in RF lab -max_fan_level=15 - -attach_at_end=true -screenshot_signal_analyzer=false -configure_pysmurf=true -reboot=true -using_timing_master=false -run_half_band_test=false -write_config=false -start_atca_monitor=false -# Still not completely parallel. Also doesn't work. -parallel_setup=false -cpwd=$PWD -pysmurf=/home/cryo/docker/pysmurf/pton-dspv3 -crate_id=1 -slots_in_configure_order=(2) -pysmurf_init_script=scratch/shawn/scripts/init_pton.py -tmux_session_name=smurf - # If true, forces crate fans to full speed if [ "$set_crate_fans_to_full" = true ] ; then ssh root@${shelfmanager} "clia minfanlevel ${max_fan_level}; clia setfanlevel all ${max_fan_level}" @@ -44,6 +24,8 @@ fi # kill smurf tmux, if running, and restart echo "-> Killing ${tmux_session_name} tmux session" tmux kill-session -t ${tmux_session_name} +# Small wait to prevent https://github.com/slaclab/pysmurf/issues/115 +sleep 0.1 echo "-> Starting a new ${tmux_session_name} tmux session" tmux new-session -d -s ${tmux_session_name} #tmux new -s ${tmux_session_name} -d diff --git a/scratch/shawn/thermal_test.py b/scratch/shawn/thermal_test.py index 762225555..29e0871bd 100644 --- a/scratch/shawn/thermal_test.py +++ b/scratch/shawn/thermal_test.py @@ -5,28 +5,29 @@ import epics pause_btw_stages=True -pause_btw_band_fills=True -pause_btw_eta_scans=True +pause_btw_band_fills=False +pause_btw_eta_scans=False +skip_setup=False bands=range(8) shelfmanager='shm-smrf-sp01' #slots=[2,3,4] -slots=[5] +slots=[3] -wait_before_setup_min=5 -wait_after_setup_min=5 -wait_btw_band_fills_min=1 -wait_after_band_fills_min=5 -wait_btw_eta_scans_min=1 -wait_after_eta_scans_min=10 +wait_before_setup_min=1 +wait_after_setup_min=0.5 +wait_btw_band_fills_min=0.5 +wait_after_band_fills_min=1 +wait_btw_eta_scans_min=0.5 +wait_after_eta_scans_min=1 # Dumb monitoring of FPGA temperatures #while true; do clear; awk '{print $1" "$3}' 1563924543_hwlog.dat | tail -n 3 | sort; sleep 1; done def tmux_cmd(slot_number,cmd,tmux_session_name='smurf'): os.system("""tmux send-keys -t {}:{} '{}' C-m""".format(tmux_session_name,slot_number,cmd)) - + def get_eta_scan_in_progress(slot_number,band,tmux_session_name='smurf'): etaScanInProgress=int(epics.caget('smurf_server_s{}:AMCc:FpgaTopLevel:AppTop:AppCore:SysgenCryo:Base[{}]:CryoChannels:etaScanInProgress'.format(slot_number,band))) return etaScanInProgress @@ -119,30 +120,31 @@ def wait_for_text_in_tmux(slot_number,text,tmux_session_name='smurf'): for slot in slots: start_hardware_logging(slot,hardware_logfile) -print('-> Waiting {} min before setup.'.format(wait_before_setup_min)) -wait_before_setup_sec=wait_before_setup_min*60 -time.sleep(wait_before_setup_sec) +if not skip_setup: + print('-> Waiting {} min before setup.'.format(wait_before_setup_min)) + wait_before_setup_sec=wait_before_setup_min*60 + time.sleep(wait_before_setup_sec) -# setup -add_tag_to_hardware_log(hardware_logfile,tag='setup') -for slot in slots: - carrier_setup(slot,shelfmanager) + # setup + add_tag_to_hardware_log(hardware_logfile,tag='setup') + for slot in slots: + carrier_setup(slot,shelfmanager) -print('-> Waiting for setup(s) to complete.') -for slot in slots: - wait_for_text_in_tmux(slot,"Done with setup") - -# Disable streaming -print('-> Disabling streaming') -for slot in slots: - disable_streaming(slot) + print('-> Waiting for setup(s) to complete.') + for slot in slots: + wait_for_text_in_tmux(slot,"Done with setup") + + # Disable streaming + print('-> Disabling streaming') + for slot in slots: + disable_streaming(slot) -print('-> Waiting {} min after setup.'.format(wait_after_setup_min)) -wait_after_setup_sec=wait_after_setup_min*60 -time.sleep(wait_after_setup_sec) + print('-> Waiting {} min after setup.'.format(wait_after_setup_min)) + wait_after_setup_sec=wait_after_setup_min*60 + time.sleep(wait_after_setup_sec) -if pause_btw_stages: - input('Press enter to continue ...') + if pause_btw_stages: + input('Press enter to continue ...') # fill bands, one at a time wait_btw_band_fills_sec=wait_btw_band_fills_min*60 @@ -216,4 +218,3 @@ def wait_for_text_in_tmux(slot_number,text,tmux_session_name='smurf'): stop_hardware_logging(slot) - diff --git a/scratch/shawn/trianglewave.py b/scratch/shawn/trianglewave.py index f3718b6bf..031cad5e2 100644 --- a/scratch/shawn/trianglewave.py +++ b/scratch/shawn/trianglewave.py @@ -1,6 +1,7 @@ import pysmurf -S = pysmurf.SmurfControl(make_logfile=False,setup=False,epics_root='test_epics',cfg_file='/usr/local/controls/Applications/smurf/pysmurf/pysmurf/cfg_files/experiment_fp28_smurfsrv04.cfg') +#S = pysmurf.SmurfControl(make_logfile=False,setup=False,epics_root='test_epics',cfg_file='/usr/local/controls/Applications/smurf/pysmurf/pysmurf/cfg_files/experiment_fp28_smurfsrv04.cfg') + import numpy as np import time @@ -11,6 +12,6 @@ while True: for Vtes in Vrange: - S.set_tes_bias_bipolar(3,Vtes) + S.set_tes_bias_bipolar(7,Vtes) time.sleep(0.005) diff --git a/scratch/shawn/tune_fp30_teses.py b/scratch/shawn/tune_fp30_teses.py new file mode 100644 index 000000000..bc0eadfe6 --- /dev/null +++ b/scratch/shawn/tune_fp30_teses.py @@ -0,0 +1,14 @@ +#Runlike this exec(open("scratch/shawn/tune_fp30_teses.py").read()) + + +# resonators with significant cross talk +#tes_res=[5132.81, 5190.0, 5076.23, 5257.31, 5124.64, 5287.62, 5144.13, 5069.59, 5186.70, 5255.02, 5199.44] + +tes_res=[5248.28,5286.32,5183.00,5084.63,5240.82,5250.13,5134.63,5191.79,5184.64,5085.97,5242.33,5251.41,5136.33,5193.10,5077.97,5087.33,5253.08,5180.06,5137.81,5195.12,5079.63,5071.13,5128.05,5245.19,5196.57,5081.36,5073.07,5224.99,5129.74,5246.62,5256.35,5139.83,5198.01,5074.63,5131.15,5141.47] +S.freq_resp=S.fake_resonance_dict(tes_res) + +S.setup_notches(2,new_master_assignment=True) +S.plot_tune_summary(2,eta_scan=True) +S.run_serial_gradient_descent(2) +S.run_serial_eta_scan(2) + diff --git a/setup.cfg b/setup.cfg new file mode 100644 index 000000000..e6e0cc697 --- /dev/null +++ b/setup.cfg @@ -0,0 +1,7 @@ +[versioneer] +VCS = git +style = pep440 +versionfile_source = pysmurf/_version.py +versionfile_build = pysmurf/_version.py +tag_prefix = v +parentdir_prefix = pysmurf- diff --git a/setup.py b/setup.py new file mode 100644 index 000000000..3b6f7c1a6 --- /dev/null +++ b/setup.py @@ -0,0 +1,20 @@ +#!/usr/bin/env python +#----------------------------------------------------------------------------- +# This file is part of the pysmurf software package. It is subject to +# the license terms in the LICENSE.txt file found in the top-level directory +# of this distribution and at: +# https://confluence.slac.stanford.edu/display/ppareg/LICENSE.html. +# No part of the pysmurf software package, including this file, may be +# copied, modified, propagated, or distributed except according to the terms +# contained in the LICENSE.txt file. +#----------------------------------------------------------------------------- +from setuptools import setup, find_packages + +import versioneer + +setup(name='pysmurf', + description='The python control software for SMuRF', + package_dir={'pysmurf': 'pysmurf'}, + packages=find_packages(), + version=versioneer.get_version(), + cmdclass=versioneer.get_cmdclass()) diff --git a/tune/__init__.py b/tune/__init__.py deleted file mode 100644 index 5cb931f52..000000000 --- a/tune/__init__.py +++ /dev/null @@ -1,3 +0,0 @@ -''' -init for tune dir -''' diff --git a/util/__init__.py b/util/__init__.py deleted file mode 100644 index 0ce473c44..000000000 --- a/util/__init__.py +++ /dev/null @@ -1,3 +0,0 @@ -''' -init for util dir -''' \ No newline at end of file diff --git a/versioneer.py b/versioneer.py new file mode 100644 index 000000000..909565f59 --- /dev/null +++ b/versioneer.py @@ -0,0 +1,1821 @@ +# Version: 0.18 + +"""The Versioneer - like a rocketeer, but for versions. + +The Versioneer +============== + +* like a rocketeer, but for versions! +* https://github.com/warner/python-versioneer +* Brian Warner +* License: Public Domain +* Compatible With: python2.6, 2.7, 3.2, 3.3, 3.4, 3.5, 3.6, and pypy +* [![Latest Version] +(https://pypip.in/version/versioneer/badge.svg?style=flat) +](https://pypi.python.org/pypi/versioneer/) +* [![Build Status] +(https://travis-ci.org/warner/python-versioneer.png?branch=master) +](https://travis-ci.org/warner/python-versioneer) + +This is a tool for managing a recorded version number in distutils-based +python projects. The goal is to remove the tedious and error-prone "update +the embedded version string" step from your release process. Making a new +release should be as easy as recording a new tag in your version-control +system, and maybe making new tarballs. + + +## Quick Install + +* `pip install versioneer` to somewhere to your $PATH +* add a `[versioneer]` section to your setup.cfg (see below) +* run `versioneer install` in your source tree, commit the results + +## Version Identifiers + +Source trees come from a variety of places: + +* a version-control system checkout (mostly used by developers) +* a nightly tarball, produced by build automation +* a snapshot tarball, produced by a web-based VCS browser, like github's + "tarball from tag" feature +* a release tarball, produced by "setup.py sdist", distributed through PyPI + +Within each source tree, the version identifier (either a string or a number, +this tool is format-agnostic) can come from a variety of places: + +* ask the VCS tool itself, e.g. "git describe" (for checkouts), which knows + about recent "tags" and an absolute revision-id +* the name of the directory into which the tarball was unpacked +* an expanded VCS keyword ($Id$, etc) +* a `_version.py` created by some earlier build step + +For released software, the version identifier is closely related to a VCS +tag. Some projects use tag names that include more than just the version +string (e.g. "myproject-1.2" instead of just "1.2"), in which case the tool +needs to strip the tag prefix to extract the version identifier. For +unreleased software (between tags), the version identifier should provide +enough information to help developers recreate the same tree, while also +giving them an idea of roughly how old the tree is (after version 1.2, before +version 1.3). Many VCS systems can report a description that captures this, +for example `git describe --tags --dirty --always` reports things like +"0.7-1-g574ab98-dirty" to indicate that the checkout is one revision past the +0.7 tag, has a unique revision id of "574ab98", and is "dirty" (it has +uncommitted changes. + +The version identifier is used for multiple purposes: + +* to allow the module to self-identify its version: `myproject.__version__` +* to choose a name and prefix for a 'setup.py sdist' tarball + +## Theory of Operation + +Versioneer works by adding a special `_version.py` file into your source +tree, where your `__init__.py` can import it. This `_version.py` knows how to +dynamically ask the VCS tool for version information at import time. + +`_version.py` also contains `$Revision$` markers, and the installation +process marks `_version.py` to have this marker rewritten with a tag name +during the `git archive` command. As a result, generated tarballs will +contain enough information to get the proper version. + +To allow `setup.py` to compute a version too, a `versioneer.py` is added to +the top level of your source tree, next to `setup.py` and the `setup.cfg` +that configures it. This overrides several distutils/setuptools commands to +compute the version when invoked, and changes `setup.py build` and `setup.py +sdist` to replace `_version.py` with a small static file that contains just +the generated version data. + +## Installation + +See [INSTALL.md](./INSTALL.md) for detailed installation instructions. + +## Version-String Flavors + +Code which uses Versioneer can learn about its version string at runtime by +importing `_version` from your main `__init__.py` file and running the +`get_versions()` function. From the "outside" (e.g. in `setup.py`), you can +import the top-level `versioneer.py` and run `get_versions()`. + +Both functions return a dictionary with different flavors of version +information: + +* `['version']`: A condensed version string, rendered using the selected + style. This is the most commonly used value for the project's version + string. The default "pep440" style yields strings like `0.11`, + `0.11+2.g1076c97`, or `0.11+2.g1076c97.dirty`. See the "Styles" section + below for alternative styles. + +* `['full-revisionid']`: detailed revision identifier. For Git, this is the + full SHA1 commit id, e.g. "1076c978a8d3cfc70f408fe5974aa6c092c949ac". + +* `['date']`: Date and time of the latest `HEAD` commit. For Git, it is the + commit date in ISO 8601 format. This will be None if the date is not + available. + +* `['dirty']`: a boolean, True if the tree has uncommitted changes. Note that + this is only accurate if run in a VCS checkout, otherwise it is likely to + be False or None + +* `['error']`: if the version string could not be computed, this will be set + to a string describing the problem, otherwise it will be None. It may be + useful to throw an exception in setup.py if this is set, to avoid e.g. + creating tarballs with a version string of "unknown". + +Some variants are more useful than others. Including `full-revisionid` in a +bug report should allow developers to reconstruct the exact code being tested +(or indicate the presence of local changes that should be shared with the +developers). `version` is suitable for display in an "about" box or a CLI +`--version` output: it can be easily compared against release notes and lists +of bugs fixed in various releases. + +The installer adds the following text to your `__init__.py` to place a basic +version in `YOURPROJECT.__version__`: + + from ._version import get_versions + __version__ = get_versions()['version'] + del get_versions + +## Styles + +The setup.cfg `style=` configuration controls how the VCS information is +rendered into a version string. + +The default style, "pep440", produces a PEP440-compliant string, equal to the +un-prefixed tag name for actual releases, and containing an additional "local +version" section with more detail for in-between builds. For Git, this is +TAG[+DISTANCE.gHEX[.dirty]] , using information from `git describe --tags +--dirty --always`. For example "0.11+2.g1076c97.dirty" indicates that the +tree is like the "1076c97" commit but has uncommitted changes (".dirty"), and +that this commit is two revisions ("+2") beyond the "0.11" tag. For released +software (exactly equal to a known tag), the identifier will only contain the +stripped tag, e.g. "0.11". + +Other styles are available. See [details.md](details.md) in the Versioneer +source tree for descriptions. + +## Debugging + +Versioneer tries to avoid fatal errors: if something goes wrong, it will tend +to return a version of "0+unknown". To investigate the problem, run `setup.py +version`, which will run the version-lookup code in a verbose mode, and will +display the full contents of `get_versions()` (including the `error` string, +which may help identify what went wrong). + +## Known Limitations + +Some situations are known to cause problems for Versioneer. This details the +most significant ones. More can be found on Github +[issues page](https://github.com/warner/python-versioneer/issues). + +### Subprojects + +Versioneer has limited support for source trees in which `setup.py` is not in +the root directory (e.g. `setup.py` and `.git/` are *not* siblings). The are +two common reasons why `setup.py` might not be in the root: + +* Source trees which contain multiple subprojects, such as + [Buildbot](https://github.com/buildbot/buildbot), which contains both + "master" and "slave" subprojects, each with their own `setup.py`, + `setup.cfg`, and `tox.ini`. Projects like these produce multiple PyPI + distributions (and upload multiple independently-installable tarballs). +* Source trees whose main purpose is to contain a C library, but which also + provide bindings to Python (and perhaps other langauges) in subdirectories. + +Versioneer will look for `.git` in parent directories, and most operations +should get the right version string. However `pip` and `setuptools` have bugs +and implementation details which frequently cause `pip install .` from a +subproject directory to fail to find a correct version string (so it usually +defaults to `0+unknown`). + +`pip install --editable .` should work correctly. `setup.py install` might +work too. + +Pip-8.1.1 is known to have this problem, but hopefully it will get fixed in +some later version. + +[Bug #38](https://github.com/warner/python-versioneer/issues/38) is tracking +this issue. The discussion in +[PR #61](https://github.com/warner/python-versioneer/pull/61) describes the +issue from the Versioneer side in more detail. +[pip PR#3176](https://github.com/pypa/pip/pull/3176) and +[pip PR#3615](https://github.com/pypa/pip/pull/3615) contain work to improve +pip to let Versioneer work correctly. + +Versioneer-0.16 and earlier only looked for a `.git` directory next to the +`setup.cfg`, so subprojects were completely unsupported with those releases. + +### Editable installs with setuptools <= 18.5 + +`setup.py develop` and `pip install --editable .` allow you to install a +project into a virtualenv once, then continue editing the source code (and +test) without re-installing after every change. + +"Entry-point scripts" (`setup(entry_points={"console_scripts": ..})`) are a +convenient way to specify executable scripts that should be installed along +with the python package. + +These both work as expected when using modern setuptools. When using +setuptools-18.5 or earlier, however, certain operations will cause +`pkg_resources.DistributionNotFound` errors when running the entrypoint +script, which must be resolved by re-installing the package. This happens +when the install happens with one version, then the egg_info data is +regenerated while a different version is checked out. Many setup.py commands +cause egg_info to be rebuilt (including `sdist`, `wheel`, and installing into +a different virtualenv), so this can be surprising. + +[Bug #83](https://github.com/warner/python-versioneer/issues/83) describes +this one, but upgrading to a newer version of setuptools should probably +resolve it. + +### Unicode version strings + +While Versioneer works (and is continually tested) with both Python 2 and +Python 3, it is not entirely consistent with bytes-vs-unicode distinctions. +Newer releases probably generate unicode version strings on py2. It's not +clear that this is wrong, but it may be surprising for applications when then +write these strings to a network connection or include them in bytes-oriented +APIs like cryptographic checksums. + +[Bug #71](https://github.com/warner/python-versioneer/issues/71) investigates +this question. + + +## Updating Versioneer + +To upgrade your project to a new release of Versioneer, do the following: + +* install the new Versioneer (`pip install -U versioneer` or equivalent) +* edit `setup.cfg`, if necessary, to include any new configuration settings + indicated by the release notes. See [UPGRADING](./UPGRADING.md) for details. +* re-run `versioneer install` in your source tree, to replace + `SRC/_version.py` +* commit any changed files + +## Future Directions + +This tool is designed to make it easily extended to other version-control +systems: all VCS-specific components are in separate directories like +src/git/ . The top-level `versioneer.py` script is assembled from these +components by running make-versioneer.py . In the future, make-versioneer.py +will take a VCS name as an argument, and will construct a version of +`versioneer.py` that is specific to the given VCS. It might also take the +configuration arguments that are currently provided manually during +installation by editing setup.py . Alternatively, it might go the other +direction and include code from all supported VCS systems, reducing the +number of intermediate scripts. + + +## License + +To make Versioneer easier to embed, all its code is dedicated to the public +domain. The `_version.py` that it creates is also in the public domain. +Specifically, both are released under the Creative Commons "Public Domain +Dedication" license (CC0-1.0), as described in +https://creativecommons.org/publicdomain/zero/1.0/ . + +""" + +from __future__ import print_function +try: + import configparser +except ImportError: + import ConfigParser as configparser +import errno +import json +import os +import re +import subprocess +import sys + + +class VersioneerConfig: + """Container for Versioneer configuration parameters.""" + + +def get_root(): + """Get the project root directory. + + We require that all commands are run from the project root, i.e. the + directory that contains setup.py, setup.cfg, and versioneer.py . + """ + root = os.path.realpath(os.path.abspath(os.getcwd())) + setup_py = os.path.join(root, "setup.py") + versioneer_py = os.path.join(root, "versioneer.py") + if not (os.path.exists(setup_py) or os.path.exists(versioneer_py)): + # allow 'python path/to/setup.py COMMAND' + root = os.path.dirname(os.path.realpath(os.path.abspath(sys.argv[0]))) + setup_py = os.path.join(root, "setup.py") + versioneer_py = os.path.join(root, "versioneer.py") + if not (os.path.exists(setup_py) or os.path.exists(versioneer_py)): + err = ("Versioneer was unable to run the project root directory. " + "Versioneer requires setup.py to be executed from " + "its immediate directory (like 'python setup.py COMMAND'), " + "or in a way that lets it use sys.argv[0] to find the root " + "(like 'python path/to/setup.py COMMAND').") + raise VersioneerBadRootError(err) + try: + # Certain runtime workflows (setup.py install/develop in a setuptools + # tree) execute all dependencies in a single python process, so + # "versioneer" may be imported multiple times, and python's shared + # module-import table will cache the first one. So we can't use + # os.path.dirname(__file__), as that will find whichever + # versioneer.py was first imported, even in later projects. + me = os.path.realpath(os.path.abspath(__file__)) + me_dir = os.path.normcase(os.path.splitext(me)[0]) + vsr_dir = os.path.normcase(os.path.splitext(versioneer_py)[0]) + if me_dir != vsr_dir: + print("Warning: build in %s is using versioneer.py from %s" + % (os.path.dirname(me), versioneer_py)) + except NameError: + pass + return root + + +def get_config_from_root(root): + """Read the project setup.cfg file to determine Versioneer config.""" + # This might raise EnvironmentError (if setup.cfg is missing), or + # configparser.NoSectionError (if it lacks a [versioneer] section), or + # configparser.NoOptionError (if it lacks "VCS="). See the docstring at + # the top of versioneer.py for instructions on writing your setup.cfg . + setup_cfg = os.path.join(root, "setup.cfg") + parser = configparser.SafeConfigParser() + with open(setup_cfg, "r") as f: + parser.readfp(f) + VCS = parser.get("versioneer", "VCS") # mandatory + + def get(parser, name): + if parser.has_option("versioneer", name): + return parser.get("versioneer", name) + return None + cfg = VersioneerConfig() + cfg.VCS = VCS + cfg.style = get(parser, "style") or "" + cfg.versionfile_source = get(parser, "versionfile_source") + cfg.versionfile_build = get(parser, "versionfile_build") + cfg.tag_prefix = get(parser, "tag_prefix") + if cfg.tag_prefix in ("''", '""'): + cfg.tag_prefix = "" + cfg.parentdir_prefix = get(parser, "parentdir_prefix") + cfg.verbose = get(parser, "verbose") + return cfg + + +class NotThisMethod(Exception): + """Exception raised if a method is not valid for the current scenario.""" + + +# these dictionaries contain VCS-specific tools +LONG_VERSION_PY = {} +HANDLERS = {} + + +def register_vcs_handler(vcs, method): # decorator + """Decorator to mark a method as the handler for a particular VCS.""" + def decorate(f): + """Store f in HANDLERS[vcs][method].""" + if vcs not in HANDLERS: + HANDLERS[vcs] = {} + HANDLERS[vcs][method] = f + return f + return decorate + + +def run_command(commands, args, cwd=None, verbose=False, hide_stderr=False, + env=None): + """Call the given command(s).""" + assert isinstance(commands, list) + p = None + for c in commands: + try: + dispcmd = str([c] + args) + # remember shell=False, so use git.cmd on windows, not just git + p = subprocess.Popen([c] + args, cwd=cwd, env=env, + stdout=subprocess.PIPE, + stderr=(subprocess.PIPE if hide_stderr + else None)) + break + except EnvironmentError: + e = sys.exc_info()[1] + if e.errno == errno.ENOENT: + continue + if verbose: + print("unable to run %s" % dispcmd) + print(e) + return None, None + else: + if verbose: + print("unable to find command, tried %s" % (commands,)) + return None, None + stdout = p.communicate()[0].strip() + if sys.version_info[0] >= 3: + stdout = stdout.decode() + if p.returncode != 0: + if verbose: + print("unable to run %s (error)" % dispcmd) + print("stdout was %s" % stdout) + return None, p.returncode + return stdout, p.returncode + + +LONG_VERSION_PY['git'] = ''' +# This file helps to compute a version number in source trees obtained from +# git-archive tarball (such as those provided by githubs download-from-tag +# feature). Distribution tarballs (built by setup.py sdist) and build +# directories (produced by setup.py build) will contain a much shorter file +# that just contains the computed version number. + +# This file is released into the public domain. Generated by +# versioneer-0.18 (https://github.com/warner/python-versioneer) + +"""Git implementation of _version.py.""" + +import errno +import os +import re +import subprocess +import sys + + +def get_keywords(): + """Get the keywords needed to look up the version information.""" + # these strings will be replaced by git during git-archive. + # setup.py/versioneer.py will grep for the variable names, so they must + # each be defined on a line of their own. _version.py will just call + # get_keywords(). + git_refnames = "%(DOLLAR)sFormat:%%d%(DOLLAR)s" + git_full = "%(DOLLAR)sFormat:%%H%(DOLLAR)s" + git_date = "%(DOLLAR)sFormat:%%ci%(DOLLAR)s" + keywords = {"refnames": git_refnames, "full": git_full, "date": git_date} + return keywords + + +class VersioneerConfig: + """Container for Versioneer configuration parameters.""" + + +def get_config(): + """Create, populate and return the VersioneerConfig() object.""" + # these strings are filled in when 'setup.py versioneer' creates + # _version.py + cfg = VersioneerConfig() + cfg.VCS = "git" + cfg.style = "%(STYLE)s" + cfg.tag_prefix = "%(TAG_PREFIX)s" + cfg.parentdir_prefix = "%(PARENTDIR_PREFIX)s" + cfg.versionfile_source = "%(VERSIONFILE_SOURCE)s" + cfg.verbose = False + return cfg + + +class NotThisMethod(Exception): + """Exception raised if a method is not valid for the current scenario.""" + + +LONG_VERSION_PY = {} +HANDLERS = {} + + +def register_vcs_handler(vcs, method): # decorator + """Decorator to mark a method as the handler for a particular VCS.""" + def decorate(f): + """Store f in HANDLERS[vcs][method].""" + if vcs not in HANDLERS: + HANDLERS[vcs] = {} + HANDLERS[vcs][method] = f + return f + return decorate + + +def run_command(commands, args, cwd=None, verbose=False, hide_stderr=False, + env=None): + """Call the given command(s).""" + assert isinstance(commands, list) + p = None + for c in commands: + try: + dispcmd = str([c] + args) + # remember shell=False, so use git.cmd on windows, not just git + p = subprocess.Popen([c] + args, cwd=cwd, env=env, + stdout=subprocess.PIPE, + stderr=(subprocess.PIPE if hide_stderr + else None)) + break + except EnvironmentError: + e = sys.exc_info()[1] + if e.errno == errno.ENOENT: + continue + if verbose: + print("unable to run %%s" %% dispcmd) + print(e) + return None, None + else: + if verbose: + print("unable to find command, tried %%s" %% (commands,)) + return None, None + stdout = p.communicate()[0].strip() + if sys.version_info[0] >= 3: + stdout = stdout.decode() + if p.returncode != 0: + if verbose: + print("unable to run %%s (error)" %% dispcmd) + print("stdout was %%s" %% stdout) + return None, p.returncode + return stdout, p.returncode + + +def versions_from_parentdir(parentdir_prefix, root, verbose): + """Try to determine the version from the parent directory name. + + Source tarballs conventionally unpack into a directory that includes both + the project name and a version string. We will also support searching up + two directory levels for an appropriately named parent directory + """ + rootdirs = [] + + for i in range(3): + dirname = os.path.basename(root) + if dirname.startswith(parentdir_prefix): + return {"version": dirname[len(parentdir_prefix):], + "full-revisionid": None, + "dirty": False, "error": None, "date": None} + else: + rootdirs.append(root) + root = os.path.dirname(root) # up a level + + if verbose: + print("Tried directories %%s but none started with prefix %%s" %% + (str(rootdirs), parentdir_prefix)) + raise NotThisMethod("rootdir doesn't start with parentdir_prefix") + + +@register_vcs_handler("git", "get_keywords") +def git_get_keywords(versionfile_abs): + """Extract version information from the given file.""" + # the code embedded in _version.py can just fetch the value of these + # keywords. When used from setup.py, we don't want to import _version.py, + # so we do it with a regexp instead. This function is not used from + # _version.py. + keywords = {} + try: + f = open(versionfile_abs, "r") + for line in f.readlines(): + if line.strip().startswith("git_refnames ="): + mo = re.search(r'=\s*"(.*)"', line) + if mo: + keywords["refnames"] = mo.group(1) + if line.strip().startswith("git_full ="): + mo = re.search(r'=\s*"(.*)"', line) + if mo: + keywords["full"] = mo.group(1) + if line.strip().startswith("git_date ="): + mo = re.search(r'=\s*"(.*)"', line) + if mo: + keywords["date"] = mo.group(1) + f.close() + except EnvironmentError: + pass + return keywords + + +@register_vcs_handler("git", "keywords") +def git_versions_from_keywords(keywords, tag_prefix, verbose): + """Get version information from git keywords.""" + if not keywords: + raise NotThisMethod("no keywords at all, weird") + date = keywords.get("date") + if date is not None: + # git-2.2.0 added "%%cI", which expands to an ISO-8601 -compliant + # datestamp. However we prefer "%%ci" (which expands to an "ISO-8601 + # -like" string, which we must then edit to make compliant), because + # it's been around since git-1.5.3, and it's too difficult to + # discover which version we're using, or to work around using an + # older one. + date = date.strip().replace(" ", "T", 1).replace(" ", "", 1) + refnames = keywords["refnames"].strip() + if refnames.startswith("$Format"): + if verbose: + print("keywords are unexpanded, not using") + raise NotThisMethod("unexpanded keywords, not a git-archive tarball") + refs = set([r.strip() for r in refnames.strip("()").split(",")]) + # starting in git-1.8.3, tags are listed as "tag: foo-1.0" instead of + # just "foo-1.0". If we see a "tag: " prefix, prefer those. + TAG = "tag: " + tags = set([r[len(TAG):] for r in refs if r.startswith(TAG)]) + if not tags: + # Either we're using git < 1.8.3, or there really are no tags. We use + # a heuristic: assume all version tags have a digit. The old git %%d + # expansion behaves like git log --decorate=short and strips out the + # refs/heads/ and refs/tags/ prefixes that would let us distinguish + # between branches and tags. By ignoring refnames without digits, we + # filter out many common branch names like "release" and + # "stabilization", as well as "HEAD" and "master". + tags = set([r for r in refs if re.search(r'\d', r)]) + if verbose: + print("discarding '%%s', no digits" %% ",".join(refs - tags)) + if verbose: + print("likely tags: %%s" %% ",".join(sorted(tags))) + for ref in sorted(tags): + # sorting will prefer e.g. "2.0" over "2.0rc1" + if ref.startswith(tag_prefix): + r = ref[len(tag_prefix):] + if verbose: + print("picking %%s" %% r) + return {"version": r, + "full-revisionid": keywords["full"].strip(), + "dirty": False, "error": None, + "date": date} + # no suitable tags, so version is "0+unknown", but full hex is still there + if verbose: + print("no suitable tags, using unknown + full revision id") + return {"version": "0+unknown", + "full-revisionid": keywords["full"].strip(), + "dirty": False, "error": "no suitable tags", "date": None} + + +@register_vcs_handler("git", "pieces_from_vcs") +def git_pieces_from_vcs(tag_prefix, root, verbose, run_command=run_command): + """Get version from 'git describe' in the root of the source tree. + + This only gets called if the git-archive 'subst' keywords were *not* + expanded, and _version.py hasn't already been rewritten with a short + version string, meaning we're inside a checked out source tree. + """ + GITS = ["git"] + if sys.platform == "win32": + GITS = ["git.cmd", "git.exe"] + + out, rc = run_command(GITS, ["rev-parse", "--git-dir"], cwd=root, + hide_stderr=True) + if rc != 0: + if verbose: + print("Directory %%s not under git control" %% root) + raise NotThisMethod("'git rev-parse --git-dir' returned error") + + # if there is a tag matching tag_prefix, this yields TAG-NUM-gHEX[-dirty] + # if there isn't one, this yields HEX[-dirty] (no NUM) + describe_out, rc = run_command(GITS, ["describe", "--tags", "--dirty", + "--always", "--long", + "--match", "%%s*" %% tag_prefix], + cwd=root) + # --long was added in git-1.5.5 + if describe_out is None: + raise NotThisMethod("'git describe' failed") + describe_out = describe_out.strip() + full_out, rc = run_command(GITS, ["rev-parse", "HEAD"], cwd=root) + if full_out is None: + raise NotThisMethod("'git rev-parse' failed") + full_out = full_out.strip() + + pieces = {} + pieces["long"] = full_out + pieces["short"] = full_out[:7] # maybe improved later + pieces["error"] = None + + # parse describe_out. It will be like TAG-NUM-gHEX[-dirty] or HEX[-dirty] + # TAG might have hyphens. + git_describe = describe_out + + # look for -dirty suffix + dirty = git_describe.endswith("-dirty") + pieces["dirty"] = dirty + if dirty: + git_describe = git_describe[:git_describe.rindex("-dirty")] + + # now we have TAG-NUM-gHEX or HEX + + if "-" in git_describe: + # TAG-NUM-gHEX + mo = re.search(r'^(.+)-(\d+)-g([0-9a-f]+)$', git_describe) + if not mo: + # unparseable. Maybe git-describe is misbehaving? + pieces["error"] = ("unable to parse git-describe output: '%%s'" + %% describe_out) + return pieces + + # tag + full_tag = mo.group(1) + if not full_tag.startswith(tag_prefix): + if verbose: + fmt = "tag '%%s' doesn't start with prefix '%%s'" + print(fmt %% (full_tag, tag_prefix)) + pieces["error"] = ("tag '%%s' doesn't start with prefix '%%s'" + %% (full_tag, tag_prefix)) + return pieces + pieces["closest-tag"] = full_tag[len(tag_prefix):] + + # distance: number of commits since tag + pieces["distance"] = int(mo.group(2)) + + # commit: short hex revision ID + pieces["short"] = mo.group(3) + + else: + # HEX: no tags + pieces["closest-tag"] = None + count_out, rc = run_command(GITS, ["rev-list", "HEAD", "--count"], + cwd=root) + pieces["distance"] = int(count_out) # total number of commits + + # commit date: see ISO-8601 comment in git_versions_from_keywords() + date = run_command(GITS, ["show", "-s", "--format=%%ci", "HEAD"], + cwd=root)[0].strip() + pieces["date"] = date.strip().replace(" ", "T", 1).replace(" ", "", 1) + + return pieces + + +def plus_or_dot(pieces): + """Return a + if we don't already have one, else return a .""" + if "+" in pieces.get("closest-tag", ""): + return "." + return "+" + + +def render_pep440(pieces): + """Build up version string, with post-release "local version identifier". + + Our goal: TAG[+DISTANCE.gHEX[.dirty]] . Note that if you + get a tagged build and then dirty it, you'll get TAG+0.gHEX.dirty + + Exceptions: + 1: no tags. git_describe was just HEX. 0+untagged.DISTANCE.gHEX[.dirty] + """ + if pieces["closest-tag"]: + rendered = pieces["closest-tag"] + if pieces["distance"] or pieces["dirty"]: + rendered += plus_or_dot(pieces) + rendered += "%%d.g%%s" %% (pieces["distance"], pieces["short"]) + if pieces["dirty"]: + rendered += ".dirty" + else: + # exception #1 + rendered = "0+untagged.%%d.g%%s" %% (pieces["distance"], + pieces["short"]) + if pieces["dirty"]: + rendered += ".dirty" + return rendered + + +def render_pep440_pre(pieces): + """TAG[.post.devDISTANCE] -- No -dirty. + + Exceptions: + 1: no tags. 0.post.devDISTANCE + """ + if pieces["closest-tag"]: + rendered = pieces["closest-tag"] + if pieces["distance"]: + rendered += ".post.dev%%d" %% pieces["distance"] + else: + # exception #1 + rendered = "0.post.dev%%d" %% pieces["distance"] + return rendered + + +def render_pep440_post(pieces): + """TAG[.postDISTANCE[.dev0]+gHEX] . + + The ".dev0" means dirty. Note that .dev0 sorts backwards + (a dirty tree will appear "older" than the corresponding clean one), + but you shouldn't be releasing software with -dirty anyways. + + Exceptions: + 1: no tags. 0.postDISTANCE[.dev0] + """ + if pieces["closest-tag"]: + rendered = pieces["closest-tag"] + if pieces["distance"] or pieces["dirty"]: + rendered += ".post%%d" %% pieces["distance"] + if pieces["dirty"]: + rendered += ".dev0" + rendered += plus_or_dot(pieces) + rendered += "g%%s" %% pieces["short"] + else: + # exception #1 + rendered = "0.post%%d" %% pieces["distance"] + if pieces["dirty"]: + rendered += ".dev0" + rendered += "+g%%s" %% pieces["short"] + return rendered + + +def render_pep440_old(pieces): + """TAG[.postDISTANCE[.dev0]] . + + The ".dev0" means dirty. + + Eexceptions: + 1: no tags. 0.postDISTANCE[.dev0] + """ + if pieces["closest-tag"]: + rendered = pieces["closest-tag"] + if pieces["distance"] or pieces["dirty"]: + rendered += ".post%%d" %% pieces["distance"] + if pieces["dirty"]: + rendered += ".dev0" + else: + # exception #1 + rendered = "0.post%%d" %% pieces["distance"] + if pieces["dirty"]: + rendered += ".dev0" + return rendered + + +def render_git_describe(pieces): + """TAG[-DISTANCE-gHEX][-dirty]. + + Like 'git describe --tags --dirty --always'. + + Exceptions: + 1: no tags. HEX[-dirty] (note: no 'g' prefix) + """ + if pieces["closest-tag"]: + rendered = pieces["closest-tag"] + if pieces["distance"]: + rendered += "-%%d-g%%s" %% (pieces["distance"], pieces["short"]) + else: + # exception #1 + rendered = pieces["short"] + if pieces["dirty"]: + rendered += "-dirty" + return rendered + + +def render_git_describe_long(pieces): + """TAG-DISTANCE-gHEX[-dirty]. + + Like 'git describe --tags --dirty --always -long'. + The distance/hash is unconditional. + + Exceptions: + 1: no tags. HEX[-dirty] (note: no 'g' prefix) + """ + if pieces["closest-tag"]: + rendered = pieces["closest-tag"] + rendered += "-%%d-g%%s" %% (pieces["distance"], pieces["short"]) + else: + # exception #1 + rendered = pieces["short"] + if pieces["dirty"]: + rendered += "-dirty" + return rendered + + +def render(pieces, style): + """Render the given version pieces into the requested style.""" + if pieces["error"]: + return {"version": "unknown", + "full-revisionid": pieces.get("long"), + "dirty": None, + "error": pieces["error"], + "date": None} + + if not style or style == "default": + style = "pep440" # the default + + if style == "pep440": + rendered = render_pep440(pieces) + elif style == "pep440-pre": + rendered = render_pep440_pre(pieces) + elif style == "pep440-post": + rendered = render_pep440_post(pieces) + elif style == "pep440-old": + rendered = render_pep440_old(pieces) + elif style == "git-describe": + rendered = render_git_describe(pieces) + elif style == "git-describe-long": + rendered = render_git_describe_long(pieces) + else: + raise ValueError("unknown style '%%s'" %% style) + + return {"version": rendered, "full-revisionid": pieces["long"], + "dirty": pieces["dirty"], "error": None, + "date": pieces.get("date")} + + +def get_versions(): + """Get version information or return default if unable to do so.""" + # I am in _version.py, which lives at ROOT/VERSIONFILE_SOURCE. If we have + # __file__, we can work backwards from there to the root. Some + # py2exe/bbfreeze/non-CPython implementations don't do __file__, in which + # case we can only use expanded keywords. + + cfg = get_config() + verbose = cfg.verbose + + try: + return git_versions_from_keywords(get_keywords(), cfg.tag_prefix, + verbose) + except NotThisMethod: + pass + + try: + root = os.path.realpath(__file__) + # versionfile_source is the relative path from the top of the source + # tree (where the .git directory might live) to this file. Invert + # this to find the root from __file__. + for i in cfg.versionfile_source.split('/'): + root = os.path.dirname(root) + except NameError: + return {"version": "0+unknown", "full-revisionid": None, + "dirty": None, + "error": "unable to find root of source tree", + "date": None} + + try: + pieces = git_pieces_from_vcs(cfg.tag_prefix, root, verbose) + return render(pieces, cfg.style) + except NotThisMethod: + pass + + try: + if cfg.parentdir_prefix: + return versions_from_parentdir(cfg.parentdir_prefix, root, verbose) + except NotThisMethod: + pass + + return {"version": "0+unknown", "full-revisionid": None, + "dirty": None, + "error": "unable to compute version", "date": None} +''' + + +@register_vcs_handler("git", "get_keywords") +def git_get_keywords(versionfile_abs): + """Extract version information from the given file.""" + # the code embedded in _version.py can just fetch the value of these + # keywords. When used from setup.py, we don't want to import _version.py, + # so we do it with a regexp instead. This function is not used from + # _version.py. + keywords = {} + try: + f = open(versionfile_abs, "r") + for line in f.readlines(): + if line.strip().startswith("git_refnames ="): + mo = re.search(r'=\s*"(.*)"', line) + if mo: + keywords["refnames"] = mo.group(1) + if line.strip().startswith("git_full ="): + mo = re.search(r'=\s*"(.*)"', line) + if mo: + keywords["full"] = mo.group(1) + if line.strip().startswith("git_date ="): + mo = re.search(r'=\s*"(.*)"', line) + if mo: + keywords["date"] = mo.group(1) + f.close() + except EnvironmentError: + pass + return keywords + + +@register_vcs_handler("git", "keywords") +def git_versions_from_keywords(keywords, tag_prefix, verbose): + """Get version information from git keywords.""" + if not keywords: + raise NotThisMethod("no keywords at all, weird") + date = keywords.get("date") + if date is not None: + # git-2.2.0 added "%cI", which expands to an ISO-8601 -compliant + # datestamp. However we prefer "%ci" (which expands to an "ISO-8601 + # -like" string, which we must then edit to make compliant), because + # it's been around since git-1.5.3, and it's too difficult to + # discover which version we're using, or to work around using an + # older one. + date = date.strip().replace(" ", "T", 1).replace(" ", "", 1) + refnames = keywords["refnames"].strip() + if refnames.startswith("$Format"): + if verbose: + print("keywords are unexpanded, not using") + raise NotThisMethod("unexpanded keywords, not a git-archive tarball") + refs = set([r.strip() for r in refnames.strip("()").split(",")]) + # starting in git-1.8.3, tags are listed as "tag: foo-1.0" instead of + # just "foo-1.0". If we see a "tag: " prefix, prefer those. + TAG = "tag: " + tags = set([r[len(TAG):] for r in refs if r.startswith(TAG)]) + if not tags: + # Either we're using git < 1.8.3, or there really are no tags. We use + # a heuristic: assume all version tags have a digit. The old git %d + # expansion behaves like git log --decorate=short and strips out the + # refs/heads/ and refs/tags/ prefixes that would let us distinguish + # between branches and tags. By ignoring refnames without digits, we + # filter out many common branch names like "release" and + # "stabilization", as well as "HEAD" and "master". + tags = set([r for r in refs if re.search(r'\d', r)]) + if verbose: + print("discarding '%s', no digits" % ",".join(refs - tags)) + if verbose: + print("likely tags: %s" % ",".join(sorted(tags))) + for ref in sorted(tags): + # sorting will prefer e.g. "2.0" over "2.0rc1" + if ref.startswith(tag_prefix): + r = ref[len(tag_prefix):] + if verbose: + print("picking %s" % r) + return {"version": r, + "full-revisionid": keywords["full"].strip(), + "dirty": False, "error": None, + "date": date} + # no suitable tags, so version is "0+unknown", but full hex is still there + if verbose: + print("no suitable tags, using unknown + full revision id") + return {"version": "0+unknown", + "full-revisionid": keywords["full"].strip(), + "dirty": False, "error": "no suitable tags", "date": None} + + +@register_vcs_handler("git", "pieces_from_vcs") +def git_pieces_from_vcs(tag_prefix, root, verbose, run_command=run_command): + """Get version from 'git describe' in the root of the source tree. + + This only gets called if the git-archive 'subst' keywords were *not* + expanded, and _version.py hasn't already been rewritten with a short + version string, meaning we're inside a checked out source tree. + """ + GITS = ["git"] + if sys.platform == "win32": + GITS = ["git.cmd", "git.exe"] + + out, rc = run_command(GITS, ["rev-parse", "--git-dir"], cwd=root, + hide_stderr=True) + if rc != 0: + if verbose: + print("Directory %s not under git control" % root) + raise NotThisMethod("'git rev-parse --git-dir' returned error") + + # if there is a tag matching tag_prefix, this yields TAG-NUM-gHEX[-dirty] + # if there isn't one, this yields HEX[-dirty] (no NUM) + describe_out, rc = run_command(GITS, ["describe", "--tags", "--dirty", + "--always", "--long", + "--match", "%s*" % tag_prefix], + cwd=root) + # --long was added in git-1.5.5 + if describe_out is None: + raise NotThisMethod("'git describe' failed") + describe_out = describe_out.strip() + full_out, rc = run_command(GITS, ["rev-parse", "HEAD"], cwd=root) + if full_out is None: + raise NotThisMethod("'git rev-parse' failed") + full_out = full_out.strip() + + pieces = {} + pieces["long"] = full_out + pieces["short"] = full_out[:7] # maybe improved later + pieces["error"] = None + + # parse describe_out. It will be like TAG-NUM-gHEX[-dirty] or HEX[-dirty] + # TAG might have hyphens. + git_describe = describe_out + + # look for -dirty suffix + dirty = git_describe.endswith("-dirty") + pieces["dirty"] = dirty + if dirty: + git_describe = git_describe[:git_describe.rindex("-dirty")] + + # now we have TAG-NUM-gHEX or HEX + + if "-" in git_describe: + # TAG-NUM-gHEX + mo = re.search(r'^(.+)-(\d+)-g([0-9a-f]+)$', git_describe) + if not mo: + # unparseable. Maybe git-describe is misbehaving? + pieces["error"] = ("unable to parse git-describe output: '%s'" + % describe_out) + return pieces + + # tag + full_tag = mo.group(1) + if not full_tag.startswith(tag_prefix): + if verbose: + fmt = "tag '%s' doesn't start with prefix '%s'" + print(fmt % (full_tag, tag_prefix)) + pieces["error"] = ("tag '%s' doesn't start with prefix '%s'" + % (full_tag, tag_prefix)) + return pieces + pieces["closest-tag"] = full_tag[len(tag_prefix):] + + # distance: number of commits since tag + pieces["distance"] = int(mo.group(2)) + + # commit: short hex revision ID + pieces["short"] = mo.group(3) + + else: + # HEX: no tags + pieces["closest-tag"] = None + count_out, rc = run_command(GITS, ["rev-list", "HEAD", "--count"], + cwd=root) + pieces["distance"] = int(count_out) # total number of commits + + # commit date: see ISO-8601 comment in git_versions_from_keywords() + date = run_command(GITS, ["show", "-s", "--format=%ci", "HEAD"], + cwd=root)[0].strip() + pieces["date"] = date.strip().replace(" ", "T", 1).replace(" ", "", 1) + + return pieces + + +def do_vcs_install(manifest_in, versionfile_source, ipy): + """Git-specific installation logic for Versioneer. + + For Git, this means creating/changing .gitattributes to mark _version.py + for export-subst keyword substitution. + """ + GITS = ["git"] + if sys.platform == "win32": + GITS = ["git.cmd", "git.exe"] + files = [manifest_in, versionfile_source] + if ipy: + files.append(ipy) + try: + me = __file__ + if me.endswith(".pyc") or me.endswith(".pyo"): + me = os.path.splitext(me)[0] + ".py" + versioneer_file = os.path.relpath(me) + except NameError: + versioneer_file = "versioneer.py" + files.append(versioneer_file) + present = False + try: + f = open(".gitattributes", "r") + for line in f.readlines(): + if line.strip().startswith(versionfile_source): + if "export-subst" in line.strip().split()[1:]: + present = True + f.close() + except EnvironmentError: + pass + if not present: + f = open(".gitattributes", "a+") + f.write("%s export-subst\n" % versionfile_source) + f.close() + files.append(".gitattributes") + run_command(GITS, ["add", "--"] + files) + + +def versions_from_parentdir(parentdir_prefix, root, verbose): + """Try to determine the version from the parent directory name. + + Source tarballs conventionally unpack into a directory that includes both + the project name and a version string. We will also support searching up + two directory levels for an appropriately named parent directory + """ + rootdirs = [] + + for i in range(3): + dirname = os.path.basename(root) + if dirname.startswith(parentdir_prefix): + return {"version": dirname[len(parentdir_prefix):], + "full-revisionid": None, + "dirty": False, "error": None, "date": None} + else: + rootdirs.append(root) + root = os.path.dirname(root) # up a level + + if verbose: + print("Tried directories %s but none started with prefix %s" % + (str(rootdirs), parentdir_prefix)) + raise NotThisMethod("rootdir doesn't start with parentdir_prefix") + + +SHORT_VERSION_PY = """ +# This file was generated by 'versioneer.py' (0.18) from +# revision-control system data, or from the parent directory name of an +# unpacked source archive. Distribution tarballs contain a pre-generated copy +# of this file. + +import json + +version_json = ''' +%s +''' # END VERSION_JSON + + +def get_versions(): + return json.loads(version_json) +""" + + +def versions_from_file(filename): + """Try to determine the version from _version.py if present.""" + try: + with open(filename) as f: + contents = f.read() + except EnvironmentError: + raise NotThisMethod("unable to read _version.py") + mo = re.search(r"version_json = '''\n(.*)''' # END VERSION_JSON", + contents, re.M | re.S) + if not mo: + mo = re.search(r"version_json = '''\r\n(.*)''' # END VERSION_JSON", + contents, re.M | re.S) + if not mo: + raise NotThisMethod("no version_json in _version.py") + return json.loads(mo.group(1)) + + +def write_to_version_file(filename, versions): + """Write the given version number to the given _version.py file.""" + os.unlink(filename) + contents = json.dumps(versions, sort_keys=True, + indent=1, separators=(",", ": ")) + with open(filename, "w") as f: + f.write(SHORT_VERSION_PY % contents) + + print("set %s to '%s'" % (filename, versions["version"])) + + +def plus_or_dot(pieces): + """Return a + if we don't already have one, else return a .""" + if "+" in pieces.get("closest-tag", ""): + return "." + return "+" + + +def render_pep440(pieces): + """Build up version string, with post-release "local version identifier". + + Our goal: TAG[+DISTANCE.gHEX[.dirty]] . Note that if you + get a tagged build and then dirty it, you'll get TAG+0.gHEX.dirty + + Exceptions: + 1: no tags. git_describe was just HEX. 0+untagged.DISTANCE.gHEX[.dirty] + """ + if pieces["closest-tag"]: + rendered = pieces["closest-tag"] + if pieces["distance"] or pieces["dirty"]: + rendered += plus_or_dot(pieces) + rendered += "%d.g%s" % (pieces["distance"], pieces["short"]) + if pieces["dirty"]: + rendered += ".dirty" + else: + # exception #1 + rendered = "0+untagged.%d.g%s" % (pieces["distance"], + pieces["short"]) + if pieces["dirty"]: + rendered += ".dirty" + return rendered + + +def render_pep440_pre(pieces): + """TAG[.post.devDISTANCE] -- No -dirty. + + Exceptions: + 1: no tags. 0.post.devDISTANCE + """ + if pieces["closest-tag"]: + rendered = pieces["closest-tag"] + if pieces["distance"]: + rendered += ".post.dev%d" % pieces["distance"] + else: + # exception #1 + rendered = "0.post.dev%d" % pieces["distance"] + return rendered + + +def render_pep440_post(pieces): + """TAG[.postDISTANCE[.dev0]+gHEX] . + + The ".dev0" means dirty. Note that .dev0 sorts backwards + (a dirty tree will appear "older" than the corresponding clean one), + but you shouldn't be releasing software with -dirty anyways. + + Exceptions: + 1: no tags. 0.postDISTANCE[.dev0] + """ + if pieces["closest-tag"]: + rendered = pieces["closest-tag"] + if pieces["distance"] or pieces["dirty"]: + rendered += ".post%d" % pieces["distance"] + if pieces["dirty"]: + rendered += ".dev0" + rendered += plus_or_dot(pieces) + rendered += "g%s" % pieces["short"] + else: + # exception #1 + rendered = "0.post%d" % pieces["distance"] + if pieces["dirty"]: + rendered += ".dev0" + rendered += "+g%s" % pieces["short"] + return rendered + + +def render_pep440_old(pieces): + """TAG[.postDISTANCE[.dev0]] . + + The ".dev0" means dirty. + + Eexceptions: + 1: no tags. 0.postDISTANCE[.dev0] + """ + if pieces["closest-tag"]: + rendered = pieces["closest-tag"] + if pieces["distance"] or pieces["dirty"]: + rendered += ".post%d" % pieces["distance"] + if pieces["dirty"]: + rendered += ".dev0" + else: + # exception #1 + rendered = "0.post%d" % pieces["distance"] + if pieces["dirty"]: + rendered += ".dev0" + return rendered + + +def render_git_describe(pieces): + """TAG[-DISTANCE-gHEX][-dirty]. + + Like 'git describe --tags --dirty --always'. + + Exceptions: + 1: no tags. HEX[-dirty] (note: no 'g' prefix) + """ + if pieces["closest-tag"]: + rendered = pieces["closest-tag"] + if pieces["distance"]: + rendered += "-%d-g%s" % (pieces["distance"], pieces["short"]) + else: + # exception #1 + rendered = pieces["short"] + if pieces["dirty"]: + rendered += "-dirty" + return rendered + + +def render_git_describe_long(pieces): + """TAG-DISTANCE-gHEX[-dirty]. + + Like 'git describe --tags --dirty --always -long'. + The distance/hash is unconditional. + + Exceptions: + 1: no tags. HEX[-dirty] (note: no 'g' prefix) + """ + if pieces["closest-tag"]: + rendered = pieces["closest-tag"] + rendered += "-%d-g%s" % (pieces["distance"], pieces["short"]) + else: + # exception #1 + rendered = pieces["short"] + if pieces["dirty"]: + rendered += "-dirty" + return rendered + + +def render(pieces, style): + """Render the given version pieces into the requested style.""" + if pieces["error"]: + return {"version": "unknown", + "full-revisionid": pieces.get("long"), + "dirty": None, + "error": pieces["error"], + "date": None} + + if not style or style == "default": + style = "pep440" # the default + + if style == "pep440": + rendered = render_pep440(pieces) + elif style == "pep440-pre": + rendered = render_pep440_pre(pieces) + elif style == "pep440-post": + rendered = render_pep440_post(pieces) + elif style == "pep440-old": + rendered = render_pep440_old(pieces) + elif style == "git-describe": + rendered = render_git_describe(pieces) + elif style == "git-describe-long": + rendered = render_git_describe_long(pieces) + else: + raise ValueError("unknown style '%s'" % style) + + return {"version": rendered, "full-revisionid": pieces["long"], + "dirty": pieces["dirty"], "error": None, + "date": pieces.get("date")} + + +class VersioneerBadRootError(Exception): + """The project root directory is unknown or missing key files.""" + + +def get_versions(verbose=False): + """Get the project version from whatever source is available. + + Returns dict with two keys: 'version' and 'full'. + """ + if "versioneer" in sys.modules: + # see the discussion in cmdclass.py:get_cmdclass() + del sys.modules["versioneer"] + + root = get_root() + cfg = get_config_from_root(root) + + assert cfg.VCS is not None, "please set [versioneer]VCS= in setup.cfg" + handlers = HANDLERS.get(cfg.VCS) + assert handlers, "unrecognized VCS '%s'" % cfg.VCS + verbose = verbose or cfg.verbose + assert cfg.versionfile_source is not None, \ + "please set versioneer.versionfile_source" + assert cfg.tag_prefix is not None, "please set versioneer.tag_prefix" + + versionfile_abs = os.path.join(root, cfg.versionfile_source) + + # extract version from first of: _version.py, VCS command (e.g. 'git + # describe'), parentdir. This is meant to work for developers using a + # source checkout, for users of a tarball created by 'setup.py sdist', + # and for users of a tarball/zipball created by 'git archive' or github's + # download-from-tag feature or the equivalent in other VCSes. + + get_keywords_f = handlers.get("get_keywords") + from_keywords_f = handlers.get("keywords") + if get_keywords_f and from_keywords_f: + try: + keywords = get_keywords_f(versionfile_abs) + ver = from_keywords_f(keywords, cfg.tag_prefix, verbose) + if verbose: + print("got version from expanded keyword %s" % ver) + return ver + except NotThisMethod: + pass + + try: + ver = versions_from_file(versionfile_abs) + if verbose: + print("got version from file %s %s" % (versionfile_abs, ver)) + return ver + except NotThisMethod: + pass + + from_vcs_f = handlers.get("pieces_from_vcs") + if from_vcs_f: + try: + pieces = from_vcs_f(cfg.tag_prefix, root, verbose) + ver = render(pieces, cfg.style) + if verbose: + print("got version from VCS %s" % ver) + return ver + except NotThisMethod: + pass + + try: + if cfg.parentdir_prefix: + ver = versions_from_parentdir(cfg.parentdir_prefix, root, verbose) + if verbose: + print("got version from parentdir %s" % ver) + return ver + except NotThisMethod: + pass + + if verbose: + print("unable to compute version") + + return {"version": "0+unknown", "full-revisionid": None, + "dirty": None, "error": "unable to compute version", + "date": None} + + +def get_version(): + """Get the short version string for this project.""" + return get_versions()["version"] + + +def get_cmdclass(): + """Get the custom setuptools/distutils subclasses used by Versioneer.""" + if "versioneer" in sys.modules: + del sys.modules["versioneer"] + # this fixes the "python setup.py develop" case (also 'install' and + # 'easy_install .'), in which subdependencies of the main project are + # built (using setup.py bdist_egg) in the same python process. Assume + # a main project A and a dependency B, which use different versions + # of Versioneer. A's setup.py imports A's Versioneer, leaving it in + # sys.modules by the time B's setup.py is executed, causing B to run + # with the wrong versioneer. Setuptools wraps the sub-dep builds in a + # sandbox that restores sys.modules to it's pre-build state, so the + # parent is protected against the child's "import versioneer". By + # removing ourselves from sys.modules here, before the child build + # happens, we protect the child from the parent's versioneer too. + # Also see https://github.com/warner/python-versioneer/issues/52 + + cmds = {} + + # we add "version" to both distutils and setuptools + from distutils.core import Command + + class cmd_version(Command): + description = "report generated version string" + user_options = [] + boolean_options = [] + + def initialize_options(self): + pass + + def finalize_options(self): + pass + + def run(self): + vers = get_versions(verbose=True) + print("Version: %s" % vers["version"]) + print(" full-revisionid: %s" % vers.get("full-revisionid")) + print(" dirty: %s" % vers.get("dirty")) + print(" date: %s" % vers.get("date")) + if vers["error"]: + print(" error: %s" % vers["error"]) + cmds["version"] = cmd_version + + # we override "build_py" in both distutils and setuptools + # + # most invocation pathways end up running build_py: + # distutils/build -> build_py + # distutils/install -> distutils/build ->.. + # setuptools/bdist_wheel -> distutils/install ->.. + # setuptools/bdist_egg -> distutils/install_lib -> build_py + # setuptools/install -> bdist_egg ->.. + # setuptools/develop -> ? + # pip install: + # copies source tree to a tempdir before running egg_info/etc + # if .git isn't copied too, 'git describe' will fail + # then does setup.py bdist_wheel, or sometimes setup.py install + # setup.py egg_info -> ? + + # we override different "build_py" commands for both environments + if "setuptools" in sys.modules: + from setuptools.command.build_py import build_py as _build_py + else: + from distutils.command.build_py import build_py as _build_py + + class cmd_build_py(_build_py): + def run(self): + root = get_root() + cfg = get_config_from_root(root) + versions = get_versions() + _build_py.run(self) + # now locate _version.py in the new build/ directory and replace + # it with an updated value + if cfg.versionfile_build: + target_versionfile = os.path.join(self.build_lib, + cfg.versionfile_build) + print("UPDATING %s" % target_versionfile) + write_to_version_file(target_versionfile, versions) + cmds["build_py"] = cmd_build_py + + if "cx_Freeze" in sys.modules: # cx_freeze enabled? + from cx_Freeze.dist import build_exe as _build_exe + # nczeczulin reports that py2exe won't like the pep440-style string + # as FILEVERSION, but it can be used for PRODUCTVERSION, e.g. + # setup(console=[{ + # "version": versioneer.get_version().split("+", 1)[0], # FILEVERSION + # "product_version": versioneer.get_version(), + # ... + + class cmd_build_exe(_build_exe): + def run(self): + root = get_root() + cfg = get_config_from_root(root) + versions = get_versions() + target_versionfile = cfg.versionfile_source + print("UPDATING %s" % target_versionfile) + write_to_version_file(target_versionfile, versions) + + _build_exe.run(self) + os.unlink(target_versionfile) + with open(cfg.versionfile_source, "w") as f: + LONG = LONG_VERSION_PY[cfg.VCS] + f.write(LONG % + {"DOLLAR": "$", + "STYLE": cfg.style, + "TAG_PREFIX": cfg.tag_prefix, + "PARENTDIR_PREFIX": cfg.parentdir_prefix, + "VERSIONFILE_SOURCE": cfg.versionfile_source, + }) + cmds["build_exe"] = cmd_build_exe + del cmds["build_py"] + + if 'py2exe' in sys.modules: # py2exe enabled? + try: + from py2exe.distutils_buildexe import py2exe as _py2exe # py3 + except ImportError: + from py2exe.build_exe import py2exe as _py2exe # py2 + + class cmd_py2exe(_py2exe): + def run(self): + root = get_root() + cfg = get_config_from_root(root) + versions = get_versions() + target_versionfile = cfg.versionfile_source + print("UPDATING %s" % target_versionfile) + write_to_version_file(target_versionfile, versions) + + _py2exe.run(self) + os.unlink(target_versionfile) + with open(cfg.versionfile_source, "w") as f: + LONG = LONG_VERSION_PY[cfg.VCS] + f.write(LONG % + {"DOLLAR": "$", + "STYLE": cfg.style, + "TAG_PREFIX": cfg.tag_prefix, + "PARENTDIR_PREFIX": cfg.parentdir_prefix, + "VERSIONFILE_SOURCE": cfg.versionfile_source, + }) + cmds["py2exe"] = cmd_py2exe + + # we override different "sdist" commands for both environments + if "setuptools" in sys.modules: + from setuptools.command.sdist import sdist as _sdist + else: + from distutils.command.sdist import sdist as _sdist + + class cmd_sdist(_sdist): + def run(self): + versions = get_versions() + self._versioneer_generated_versions = versions + # unless we update this, the command will keep using the old + # version + self.distribution.metadata.version = versions["version"] + return _sdist.run(self) + + def make_release_tree(self, base_dir, files): + root = get_root() + cfg = get_config_from_root(root) + _sdist.make_release_tree(self, base_dir, files) + # now locate _version.py in the new base_dir directory + # (remembering that it may be a hardlink) and replace it with an + # updated value + target_versionfile = os.path.join(base_dir, cfg.versionfile_source) + print("UPDATING %s" % target_versionfile) + write_to_version_file(target_versionfile, + self._versioneer_generated_versions) + cmds["sdist"] = cmd_sdist + + return cmds + + +CONFIG_ERROR = """ +setup.cfg is missing the necessary Versioneer configuration. You need +a section like: + + [versioneer] + VCS = git + style = pep440 + versionfile_source = src/myproject/_version.py + versionfile_build = myproject/_version.py + tag_prefix = + parentdir_prefix = myproject- + +You will also need to edit your setup.py to use the results: + + import versioneer + setup(version=versioneer.get_version(), + cmdclass=versioneer.get_cmdclass(), ...) + +Please read the docstring in ./versioneer.py for configuration instructions, +edit setup.cfg, and re-run the installer or 'python versioneer.py setup'. +""" + +SAMPLE_CONFIG = """ +# See the docstring in versioneer.py for instructions. Note that you must +# re-run 'versioneer.py setup' after changing this section, and commit the +# resulting files. + +[versioneer] +#VCS = git +#style = pep440 +#versionfile_source = +#versionfile_build = +#tag_prefix = +#parentdir_prefix = + +""" + +INIT_PY_SNIPPET = """ +from ._version import get_versions +__version__ = get_versions()['version'] +del get_versions +""" + + +def do_setup(): + """Main VCS-independent setup function for installing Versioneer.""" + root = get_root() + try: + cfg = get_config_from_root(root) + except (EnvironmentError, configparser.NoSectionError, + configparser.NoOptionError) as e: + if isinstance(e, (EnvironmentError, configparser.NoSectionError)): + print("Adding sample versioneer config to setup.cfg", + file=sys.stderr) + with open(os.path.join(root, "setup.cfg"), "a") as f: + f.write(SAMPLE_CONFIG) + print(CONFIG_ERROR, file=sys.stderr) + return 1 + + print(" creating %s" % cfg.versionfile_source) + with open(cfg.versionfile_source, "w") as f: + LONG = LONG_VERSION_PY[cfg.VCS] + f.write(LONG % {"DOLLAR": "$", + "STYLE": cfg.style, + "TAG_PREFIX": cfg.tag_prefix, + "PARENTDIR_PREFIX": cfg.parentdir_prefix, + "VERSIONFILE_SOURCE": cfg.versionfile_source, + }) + + ipy = os.path.join(os.path.dirname(cfg.versionfile_source), + "__init__.py") + if os.path.exists(ipy): + try: + with open(ipy, "r") as f: + old = f.read() + except EnvironmentError: + old = "" + if INIT_PY_SNIPPET not in old: + print(" appending to %s" % ipy) + with open(ipy, "a") as f: + f.write(INIT_PY_SNIPPET) + else: + print(" %s unmodified" % ipy) + else: + print(" %s doesn't exist, ok" % ipy) + ipy = None + + # Make sure both the top-level "versioneer.py" and versionfile_source + # (PKG/_version.py, used by runtime code) are in MANIFEST.in, so + # they'll be copied into source distributions. Pip won't be able to + # install the package without this. + manifest_in = os.path.join(root, "MANIFEST.in") + simple_includes = set() + try: + with open(manifest_in, "r") as f: + for line in f: + if line.startswith("include "): + for include in line.split()[1:]: + simple_includes.add(include) + except EnvironmentError: + pass + # That doesn't cover everything MANIFEST.in can do + # (http://docs.python.org/2/distutils/sourcedist.html#commands), so + # it might give some false negatives. Appending redundant 'include' + # lines is safe, though. + if "versioneer.py" not in simple_includes: + print(" appending 'versioneer.py' to MANIFEST.in") + with open(manifest_in, "a") as f: + f.write("include versioneer.py\n") + else: + print(" 'versioneer.py' already in MANIFEST.in") + if cfg.versionfile_source not in simple_includes: + print(" appending versionfile_source ('%s') to MANIFEST.in" % + cfg.versionfile_source) + with open(manifest_in, "a") as f: + f.write("include %s\n" % cfg.versionfile_source) + else: + print(" versionfile_source already in MANIFEST.in") + + # Make VCS-specific changes. For git, this means creating/changing + # .gitattributes to mark _version.py for export-subst keyword + # substitution. + do_vcs_install(manifest_in, cfg.versionfile_source, ipy) + return 0 + + +def scan_setup_py(): + """Validate the contents of setup.py against Versioneer's expectations.""" + found = set() + setters = False + errors = 0 + with open("setup.py", "r") as f: + for line in f.readlines(): + if "import versioneer" in line: + found.add("import") + if "versioneer.get_cmdclass()" in line: + found.add("cmdclass") + if "versioneer.get_version()" in line: + found.add("get_version") + if "versioneer.VCS" in line: + setters = True + if "versioneer.versionfile_source" in line: + setters = True + if len(found) != 3: + print("") + print("Your setup.py appears to be missing some important items") + print("(but I might be wrong). Please make sure it has something") + print("roughly like the following:") + print("") + print(" import versioneer") + print(" setup( version=versioneer.get_version(),") + print(" cmdclass=versioneer.get_cmdclass(), ...)") + print("") + errors += 1 + if setters: + print("You should remove lines like 'versioneer.VCS = ' and") + print("'versioneer.versionfile_source = ' . This configuration") + print("now lives in setup.cfg, and should be removed from setup.py") + print("") + errors += 1 + return errors + + +if __name__ == "__main__": + cmd = sys.argv[1] + if cmd == "setup": + errors = do_setup() + errors += scan_setup_py() + if errors: + sys.exit(1)