Skip to content

Commit

Permalink
Merging with latest master.
Browse files Browse the repository at this point in the history
  • Loading branch information
swh76 committed Oct 24, 2019
2 parents 923705d + 39f8ac2 commit 4fde320
Show file tree
Hide file tree
Showing 101 changed files with 5,495 additions and 6,851 deletions.
1 change: 1 addition & 0 deletions .gitattributes
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
pysmurf/_version.py export-subst
23 changes: 22 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
@@ -1,4 +1,25 @@
*.pyc
*.py~
*.dat
*.png
*.png

# Distribution / packaging
.Python
env/
build/
develop-eggs/
dist/
downloads/
eggs/
.eggs/
lib/
lib64/
parts/
sdist/
var/
wheels/
*.egg-info/
.installed.cfg
*.egg

.idea/
21 changes: 21 additions & 0 deletions .readthedocs.yml
Original file line number Diff line number Diff line change
@@ -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: .
40 changes: 40 additions & 0 deletions LICENSE.txt
Original file line number Diff line number Diff line change
@@ -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.

2 changes: 2 additions & 0 deletions MANIFEST.in
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
include versioneer.py
include pysmurf/_version.py
32 changes: 31 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -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
4 changes: 0 additions & 4 deletions __init__.py

This file was deleted.

4 changes: 0 additions & 4 deletions base/__init__.py

This file was deleted.

96 changes: 78 additions & 18 deletions cfg_files/rflab/experiment_rflab_thermal_testing_201907.cfg
Original file line number Diff line number Diff line change
Expand Up @@ -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,
Expand All @@ -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
Expand Down Expand Up @@ -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,
Expand All @@ -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,
Expand Down
69 changes: 69 additions & 0 deletions cfg_files/stanford/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,69 @@
# Stanford pysmurf cfg file index

<table>
<tr>
<td><b>cfg file</b></td>
<td><b>Description</b></td>
</tr>

<!-- Begin Frankenpolar Run 29 pysmurf config files -->
<tr>
<td colspan="2"><b>Frankenpolar Run 29 pysmurf configuration files</b></td>
</tr>

<tr>
<td><a href="experiment_fp29_cc02-02_lbOnlyBay0.cfg">experiment_fp29_cc02-02_lbOnlyBay0.cfg</a></td>
<td>
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).
</td>
</tr>

<tr>
<td><a href="experiment_fp29_cc02-02_hbOnlyBay0.cfg">experiment_fp29_cc02-02_hbOnlyBay0.cfg</a></td>
<td>
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).
</td>
</tr>

<tr>
<td><a href="experiment_fp29_cc02-02_fullBand.cfg">experiment_fp29_cc02-02_fullBand.cfg</a></td>
<td>
For use with cryostat card C02-02. Configures all eight 500MHz
bands. Configures for external (front-panel) 122.88 MHz
reference.
</td>
</tr>
<!-- End Frankenpolar Run 29 pysmurf config files -->

<!-- Begin Frankenpolar Run 30 pysmurf config files -->
<tr>
<td colspan="2"><b>Frankenpolar Run 30 pysmurf configuration files</b></td>
</tr>

<tr>
<td><a href="experiment_fp30_srv03_rfsoc.cfg">experiment_fp30_srv03_rfsoc.cfg</a></td>
<td>
Test cfg used to take noise data with the RFSoC on cold
resonators.
</td>
</tr>

<tr>
<td><a href="experiment_fp30_cc02-03_lbOnlyBay0.cfg">experiment_fp30_cc02-03_lbOnlyBay0.cfg</a></td>
<td>
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).
</td>
</tr>
<!-- End Frankenpolar Run 30 pysmurf config files -->

</table>

Loading

0 comments on commit 4fde320

Please sign in to comment.