diff --git a/README.md b/README.md index 87cab8632..1a78d2b88 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,6 @@ -# [PyRPL](http://lneuhaus.github.io/pyrpl/) -[![travis status](https://travis-ci.org/lneuhaus/pyrpl.svg?branch=master "Travis status")](https://travis-ci.org/lneuhaus/pyrpl) +#[PyRPL](http://lneuhaus.github.io/pyrpl/) + +[![travis status](https://travis-ci.org/lneuhaus/pyrpl.svg?branch=master "Travisstatus")](https://travis-ci.org/lneuhaus/pyrpl) [![code coverage](https://codecov.io/github/lneuhaus/pyrpl/coverage.svg?branch=master "Code coverage")](https://codecov.io/gh/lneuhaus/pyrpl) [![Python versions on PyPI](https://img.shields.io/pypi/pyversions/pyrpl.svg)](https://pypi.python.org/pypi/pyrpl/) [![PyrRPL version on PyPI](https://img.shields.io/pypi/v/pyrpl.svg "PyRPL on PyPI")](https://pypi.python.org/pypi/pyrpl/) diff --git a/README.rst b/README.rst index 68ab36e74..e7145b497 100644 --- a/README.rst +++ b/README.rst @@ -1,31 +1,53 @@ -.. figure:: https://travis-ci.com/lneuhaus/pyrpl.svg?token=Au8JgYk93p9iq2p6bSTp&branch=master - :alt: Travis status +` `__ +======================================= - travis status +|travis status| |code coverage| |Python versions on PyPI| |PyrRPL +version on PyPI| |join chat on gitter| |License| + +|Download PyRPL| |LGPLv3| PyRPL (Python RedPitaya Lockbox) turns your RedPitaya into a powerful DSP device, especially suitable as a digital lockbox and measurement device in quantum optics experiments. +Website +------- + +Get started by checking out the `official PyRPL +website `__. + Installation ------------ -Make sure you have an installation of Python (2.7 or 3.5). If you are -new to Python or unexperienced with fighting installation issues, it is -recommended to install the +The easiest and fastest way to get PyRPL is to download and execute the +`precompiled executable for +windows `__. +This option requires no extra programs to be installed on the computer. + +If instead you would like to use and/or modify the source code, make +sure you have an installation of Python (2.7, 3.4, 3.5, or 3.6). If you +are new to Python or unexperienced with fighting installation issues, it +is recommended to install the `Anaconda `__ Python distribution, -which allows to install all PyRPL dependencies in a virtual environment -with the following two commands +which allows to install all PyRPL dependencies via :: - conda create -y -n pyrpl-env python=3.5 numpy scipy paramiko pandas nose pip pyqt=4 - activate pyrpl-env + conda install numpy scipy paramiko pandas nose pip pyqt qtpy pyqtgraph pyyaml Check `this wiki -page `__ -for hints if you cannot execute conda in a terminal. If you are not -using Anaconda, you must manually install the python package +page `__ +for hints if you cannot execute conda in a terminal. Alternatively, if +you prefer creating a virtual environment for pyrpl, do so with the +following two commands + +:: + + conda create -y -n pyrpl-env numpy scipy paramiko pandas nose pip pyqt qtpy pyqtgraph pyyaml + activate pyrpl-env + +If you are not using Anaconda, you must manually install the python +package `PyQt5 `__ or `PyQt4 `__, which requires a working C compiler installation on the system. @@ -74,7 +96,7 @@ Issues ------ We collect a list of common problems in a `dedicated wiki -page `__. +page `__. If you do not find your problem listed there, please report all problems or wishes as new issues on `this page `__, so we can fix it and @@ -132,7 +154,7 @@ should make sure that you are able to generate a working bitfile on your machine. To do so, you must install Vivado 2015.4 `(64-bit windows `__](https://www.xilinx.com/member/forms/download/xef.html?filename=Xilinx\_Vivado\_SDK\_2015.4\_1118\_2\_Lin64.bin&akdm=1) and `together with a working -license `__. +license `__. Next, with a terminal in the pyrpl root directory, type :: @@ -154,3 +176,20 @@ License Please read our license file `LICENSE `__ for more information. + +.. |travis status| image:: https://travis-ci.org/lneuhaus/pyrpl.svg?branch=master + :target: https://travis-ci.org/lneuhaus/pyrpl +.. |code coverage| image:: https://codecov.io/github/lneuhaus/pyrpl/coverage.svg?branch=master + :target: https://codecov.io/gh/lneuhaus/pyrpl +.. |Python versions on PyPI| image:: https://img.shields.io/pypi/pyversions/pyrpl.svg + :target: https://pypi.python.org/pypi/pyrpl/ +.. |PyrRPL version on PyPI| image:: https://img.shields.io/pypi/v/pyrpl.svg + :target: https://pypi.python.org/pypi/pyrpl/ +.. |join chat on gitter| image:: https://badges.gitter.im/JoinChat.svg + :target: https://gitter.im/lneuhaus/pyrpl +.. |License| image:: https://img.shields.io/pypi/l/pyrpl.svg + :target: https://github.com/lneuhaus/pyrpl/blob/master/LICENSE +.. |Download PyRPL| image:: https://a.fsdn.com/con/app/sf-download-button + :target: https://sourceforge.net/projects/pyrpl/files/latest/download +.. |LGPLv3| image:: https://www.gnu.org/graphics/gplv3-88x31.png + :target: https://www.gnu.org/licenses/gpl.html diff --git a/doc/sphinx/source/pyrpl.hardware_modules.iir.rst b/doc/sphinx/source/pyrpl.hardware_modules.iir.rst index 9d8959f04..f234a4c82 100644 --- a/doc/sphinx/source/pyrpl.hardware_modules.iir.rst +++ b/doc/sphinx/source/pyrpl.hardware_modules.iir.rst @@ -1,27 +1,27 @@ -pyrpl\.hardware\_modules\.iir package -===================================== +pyrpl.hardware_modules.iir package +================================== Submodules ---------- -pyrpl\.hardware\_modules\.iir\.bodefit module ---------------------------------------------- +pyrpl.hardware_modules.iir.bodefit module +----------------------------------------- .. automodule:: pyrpl.hardware_modules.iir.bodefit :members: :undoc-members: :show-inheritance: -pyrpl\.hardware\_modules\.iir\.iir module ------------------------------------------ +pyrpl.hardware_modules.iir.iir module +------------------------------------- .. automodule:: pyrpl.hardware_modules.iir.iir :members: :undoc-members: :show-inheritance: -pyrpl\.hardware\_modules\.iir\.iir\_theory module -------------------------------------------------- +pyrpl.hardware_modules.iir.iir_theory module +-------------------------------------------- .. automodule:: pyrpl.hardware_modules.iir.iir_theory :members: diff --git a/doc/sphinx/source/pyrpl.hardware_modules.rst b/doc/sphinx/source/pyrpl.hardware_modules.rst index 2cf008e61..35d1fba4a 100644 --- a/doc/sphinx/source/pyrpl.hardware_modules.rst +++ b/doc/sphinx/source/pyrpl.hardware_modules.rst @@ -1,5 +1,5 @@ -pyrpl\.hardware\_modules package -================================ +pyrpl.hardware_modules package +============================== Subpackages ----------- @@ -11,88 +11,88 @@ Subpackages Submodules ---------- -pyrpl\.hardware\_modules\.ams module ------------------------------------- +pyrpl.hardware_modules.ams module +--------------------------------- .. automodule:: pyrpl.hardware_modules.ams :members: :undoc-members: :show-inheritance: -pyrpl\.hardware\_modules\.asg module ------------------------------------- +pyrpl.hardware_modules.asg module +--------------------------------- .. automodule:: pyrpl.hardware_modules.asg :members: :undoc-members: :show-inheritance: -pyrpl\.hardware\_modules\.aux\_output module --------------------------------------------- +pyrpl.hardware_modules.dsp module +--------------------------------- -.. automodule:: pyrpl.hardware_modules.aux_output +.. automodule:: pyrpl.hardware_modules.dsp :members: :undoc-members: :show-inheritance: -pyrpl\.hardware\_modules\.dsp module +pyrpl.hardware_modules.filter module ------------------------------------ -.. automodule:: pyrpl.hardware_modules.dsp +.. automodule:: pyrpl.hardware_modules.filter :members: :undoc-members: :show-inheritance: -pyrpl\.hardware\_modules\.filter module ---------------------------------------- +pyrpl.hardware_modules.hk module +-------------------------------- -.. automodule:: pyrpl.hardware_modules.filter +.. automodule:: pyrpl.hardware_modules.hk :members: :undoc-members: :show-inheritance: -pyrpl\.hardware\_modules\.hk module ------------------------------------ +pyrpl.hardware_modules.iq module +-------------------------------- -.. automodule:: pyrpl.hardware_modules.hk +.. automodule:: pyrpl.hardware_modules.iq :members: :undoc-members: :show-inheritance: -pyrpl\.hardware\_modules\.iq module ------------------------------------ +pyrpl.hardware_modules.pid module +--------------------------------- -.. automodule:: pyrpl.hardware_modules.iq +.. automodule:: pyrpl.hardware_modules.pid :members: :undoc-members: :show-inheritance: -pyrpl\.hardware\_modules\.pid module ------------------------------------- +pyrpl.hardware_modules.pwm module +--------------------------------- -.. automodule:: pyrpl.hardware_modules.pid +.. automodule:: pyrpl.hardware_modules.pwm :members: :undoc-members: :show-inheritance: -pyrpl\.hardware\_modules\.sampler module ----------------------------------------- +pyrpl.hardware_modules.sampler module +------------------------------------- .. automodule:: pyrpl.hardware_modules.sampler :members: :undoc-members: :show-inheritance: -pyrpl\.hardware\_modules\.scope module --------------------------------------- +pyrpl.hardware_modules.scope module +----------------------------------- .. automodule:: pyrpl.hardware_modules.scope :members: :undoc-members: :show-inheritance: -pyrpl\.hardware\_modules\.trig module -------------------------------------- +pyrpl.hardware_modules.trig module +---------------------------------- .. automodule:: pyrpl.hardware_modules.trig :members: diff --git a/doc/sphinx/source/pyrpl.rst b/doc/sphinx/source/pyrpl.rst index 99dbe58ab..4f1073bf4 100644 --- a/doc/sphinx/source/pyrpl.rst +++ b/doc/sphinx/source/pyrpl.rst @@ -14,112 +14,112 @@ Subpackages Submodules ---------- -pyrpl\.acquisition\_module module ---------------------------------- +pyrpl.acquisition_module module +------------------------------- .. automodule:: pyrpl.acquisition_module :members: :undoc-members: :show-inheritance: -pyrpl\.async\_utils module --------------------------- +pyrpl.async_utils module +------------------------ .. automodule:: pyrpl.async_utils :members: :undoc-members: :show-inheritance: -pyrpl\.attributes module ------------------------- +pyrpl.attributes module +----------------------- .. automodule:: pyrpl.attributes :members: :undoc-members: :show-inheritance: -pyrpl\.curvedb module ---------------------- +pyrpl.curvedb module +-------------------- .. automodule:: pyrpl.curvedb :members: :undoc-members: :show-inheritance: -pyrpl\.errors module --------------------- +pyrpl.errors module +------------------- .. automodule:: pyrpl.errors :members: :undoc-members: :show-inheritance: -pyrpl\.memory module --------------------- +pyrpl.memory module +------------------- .. automodule:: pyrpl.memory :members: :undoc-members: :show-inheritance: -pyrpl\.module\_attributes module --------------------------------- +pyrpl.module_attributes module +------------------------------ .. automodule:: pyrpl.module_attributes :members: :undoc-members: :show-inheritance: -pyrpl\.modules module ---------------------- +pyrpl.modules module +-------------------- .. automodule:: pyrpl.modules :members: :undoc-members: :show-inheritance: -pyrpl\.pyrpl module -------------------- +pyrpl.pyrpl module +------------------ .. automodule:: pyrpl.pyrpl :members: :undoc-members: :show-inheritance: -pyrpl\.pyrpl\_utils module --------------------------- +pyrpl.pyrpl_utils module +------------------------ .. automodule:: pyrpl.pyrpl_utils :members: :undoc-members: :show-inheritance: -pyrpl\.redpitaya module ------------------------ +pyrpl.redpitaya module +---------------------- .. automodule:: pyrpl.redpitaya :members: :undoc-members: :show-inheritance: -pyrpl\.redpitaya\_client module -------------------------------- +pyrpl.redpitaya_client module +----------------------------- .. automodule:: pyrpl.redpitaya_client :members: :undoc-members: :show-inheritance: -pyrpl\.sound module -------------------- +pyrpl.sound module +------------------ .. automodule:: pyrpl.sound :members: :undoc-members: :show-inheritance: -pyrpl\.sshshell module ----------------------- +pyrpl.sshshell module +--------------------- .. automodule:: pyrpl.sshshell :members: diff --git a/doc/sphinx/source/pyrpl.software_modules.lockbox.models.rst b/doc/sphinx/source/pyrpl.software_modules.lockbox.models.rst index d5f777cc7..e3bc09173 100644 --- a/doc/sphinx/source/pyrpl.software_modules.lockbox.models.rst +++ b/doc/sphinx/source/pyrpl.software_modules.lockbox.models.rst @@ -1,43 +1,35 @@ -pyrpl\.software\_modules\.lockbox\.models package -================================================= +pyrpl.software_modules.lockbox.models package +============================================= Submodules ---------- -pyrpl\.software\_modules\.lockbox\.models\.coarse\_lockbox\_generalized module ------------------------------------------------------------------------------- - -.. automodule:: pyrpl.software_modules.lockbox.models.coarse_lockbox_generalized - :members: - :undoc-members: - :show-inheritance: - -pyrpl\.software\_modules\.lockbox\.models\.custom\_lockbox\_example module --------------------------------------------------------------------------- +pyrpl.software_modules.lockbox.models.custom_lockbox_example module +------------------------------------------------------------------- .. automodule:: pyrpl.software_modules.lockbox.models.custom_lockbox_example :members: :undoc-members: :show-inheritance: -pyrpl\.software\_modules\.lockbox\.models\.fabryperot module ------------------------------------------------------------- +pyrpl.software_modules.lockbox.models.fabryperot module +------------------------------------------------------- .. automodule:: pyrpl.software_modules.lockbox.models.fabryperot :members: :undoc-members: :show-inheritance: -pyrpl\.software\_modules\.lockbox\.models\.interferometer module ----------------------------------------------------------------- +pyrpl.software_modules.lockbox.models.interferometer module +----------------------------------------------------------- .. automodule:: pyrpl.software_modules.lockbox.models.interferometer :members: :undoc-members: :show-inheritance: -pyrpl\.software\_modules\.lockbox\.models\.linear module --------------------------------------------------------- +pyrpl.software_modules.lockbox.models.linear module +--------------------------------------------------- .. automodule:: pyrpl.software_modules.lockbox.models.linear :members: diff --git a/doc/sphinx/source/pyrpl.software_modules.lockbox.rst b/doc/sphinx/source/pyrpl.software_modules.lockbox.rst index 3835059fb..29a3070b7 100644 --- a/doc/sphinx/source/pyrpl.software_modules.lockbox.rst +++ b/doc/sphinx/source/pyrpl.software_modules.lockbox.rst @@ -1,5 +1,5 @@ -pyrpl\.software\_modules\.lockbox package -========================================= +pyrpl.software_modules.lockbox package +====================================== Subpackages ----------- @@ -11,32 +11,40 @@ Subpackages Submodules ---------- -pyrpl\.software\_modules\.lockbox\.input module ------------------------------------------------ +pyrpl.software_modules.lockbox.gainoptimizer module +--------------------------------------------------- + +.. automodule:: pyrpl.software_modules.lockbox.gainoptimizer + :members: + :undoc-members: + :show-inheritance: + +pyrpl.software_modules.lockbox.input module +------------------------------------------- .. automodule:: pyrpl.software_modules.lockbox.input :members: :undoc-members: :show-inheritance: -pyrpl\.software\_modules\.lockbox\.lockbox module -------------------------------------------------- +pyrpl.software_modules.lockbox.lockbox module +--------------------------------------------- .. automodule:: pyrpl.software_modules.lockbox.lockbox :members: :undoc-members: :show-inheritance: -pyrpl\.software\_modules\.lockbox\.output module ------------------------------------------------- +pyrpl.software_modules.lockbox.output module +-------------------------------------------- .. automodule:: pyrpl.software_modules.lockbox.output :members: :undoc-members: :show-inheritance: -pyrpl\.software\_modules\.lockbox\.stage module ------------------------------------------------ +pyrpl.software_modules.lockbox.stage module +------------------------------------------- .. automodule:: pyrpl.software_modules.lockbox.stage :members: diff --git a/doc/sphinx/source/pyrpl.software_modules.rst b/doc/sphinx/source/pyrpl.software_modules.rst index 5b535058d..f821d0b04 100644 --- a/doc/sphinx/source/pyrpl.software_modules.rst +++ b/doc/sphinx/source/pyrpl.software_modules.rst @@ -1,5 +1,5 @@ -pyrpl\.software\_modules package -================================ +pyrpl.software_modules package +============================== Subpackages ----------- @@ -11,48 +11,56 @@ Subpackages Submodules ---------- -pyrpl\.software\_modules\.curve\_viewer module ----------------------------------------------- +pyrpl.software_modules.curve_viewer module +------------------------------------------ .. automodule:: pyrpl.software_modules.curve_viewer :members: :undoc-members: :show-inheritance: -pyrpl\.software\_modules\.loop module -------------------------------------- +pyrpl.software_modules.loop module +---------------------------------- .. automodule:: pyrpl.software_modules.loop :members: :undoc-members: :show-inheritance: -pyrpl\.software\_modules\.module\_managers module -------------------------------------------------- +pyrpl.software_modules.module_managers module +--------------------------------------------- .. automodule:: pyrpl.software_modules.module_managers :members: :undoc-members: :show-inheritance: -pyrpl\.software\_modules\.network\_analyzer module --------------------------------------------------- +pyrpl.software_modules.network_analyzer module +---------------------------------------------- .. automodule:: pyrpl.software_modules.network_analyzer :members: :undoc-members: :show-inheritance: -pyrpl\.software\_modules\.pyrpl\_config module ----------------------------------------------- +pyrpl.software_modules.pyrpl_config module +------------------------------------------ .. automodule:: pyrpl.software_modules.pyrpl_config :members: :undoc-members: :show-inheritance: -pyrpl\.software\_modules\.spectrum\_analyzer module ---------------------------------------------------- +pyrpl.software_modules.software_pid module +------------------------------------------ + +.. automodule:: pyrpl.software_modules.software_pid + :members: + :undoc-members: + :show-inheritance: + +pyrpl.software_modules.spectrum_analyzer module +----------------------------------------------- .. automodule:: pyrpl.software_modules.spectrum_analyzer :members: diff --git a/doc/sphinx/source/pyrpl.test.rst b/doc/sphinx/source/pyrpl.test.rst new file mode 100644 index 000000000..9ca5e33c8 --- /dev/null +++ b/doc/sphinx/source/pyrpl.test.rst @@ -0,0 +1,141 @@ +pyrpl.test package +================== + +Subpackages +----------- + +.. toctree:: + + pyrpl.test.test_hardware_modules + +Submodules +---------- + +pyrpl.test.debug_timer module +----------------------------- + +.. automodule:: pyrpl.test.debug_timer + :members: + :undoc-members: + :show-inheritance: + +pyrpl.test.test_attribute module +-------------------------------- + +.. automodule:: pyrpl.test.test_attribute + :members: + :undoc-members: + :show-inheritance: + +pyrpl.test.test_base module +--------------------------- + +.. automodule:: pyrpl.test.test_base + :members: + :undoc-members: + :show-inheritance: + +pyrpl.test.test_example module +------------------------------ + +.. automodule:: pyrpl.test.test_example + :members: + :undoc-members: + :show-inheritance: + +pyrpl.test.test_load_save module +-------------------------------- + +.. automodule:: pyrpl.test.test_load_save + :members: + :undoc-members: + :show-inheritance: + +pyrpl.test.test_lockbox module +------------------------------ + +.. automodule:: pyrpl.test.test_lockbox + :members: + :undoc-members: + :show-inheritance: + +pyrpl.test.test_memory module +----------------------------- + +.. automodule:: pyrpl.test.test_memory + :members: + :undoc-members: + :show-inheritance: + +pyrpl.test.test_module_widgets module +------------------------------------- + +.. automodule:: pyrpl.test.test_module_widgets + :members: + :undoc-members: + :show-inheritance: + +pyrpl.test.test_na module +------------------------- + +.. automodule:: pyrpl.test.test_na + :members: + :undoc-members: + :show-inheritance: + +pyrpl.test.test_ownership module +-------------------------------- + +.. automodule:: pyrpl.test.test_ownership + :members: + :undoc-members: + :show-inheritance: + +pyrpl.test.test_proxyproperty module +------------------------------------ + +.. automodule:: pyrpl.test.test_proxyproperty + :members: + :undoc-members: + :show-inheritance: + +pyrpl.test.test_pyqtgraph_benchmark module +------------------------------------------ + +.. automodule:: pyrpl.test.test_pyqtgraph_benchmark + :members: + :undoc-members: + :show-inheritance: + +pyrpl.test.test_redpitaya module +-------------------------------- + +.. automodule:: pyrpl.test.test_redpitaya + :members: + :undoc-members: + :show-inheritance: + +pyrpl.test.test_registers module +-------------------------------- + +.. automodule:: pyrpl.test.test_registers + :members: + :undoc-members: + :show-inheritance: + +pyrpl.test.test_spectrum_analyzer module +---------------------------------------- + +.. automodule:: pyrpl.test.test_spectrum_analyzer + :members: + :undoc-members: + :show-inheritance: + + +Module contents +--------------- + +.. automodule:: pyrpl.test + :members: + :undoc-members: + :show-inheritance: diff --git a/doc/sphinx/source/pyrpl.test.test_hardware_modules.rst b/doc/sphinx/source/pyrpl.test.test_hardware_modules.rst new file mode 100644 index 000000000..b8c1f9d51 --- /dev/null +++ b/doc/sphinx/source/pyrpl.test.test_hardware_modules.rst @@ -0,0 +1,62 @@ +pyrpl.test.test_hardware_modules package +======================================== + +Submodules +---------- + +pyrpl.test.test_hardware_modules.test_dsp_inputs module +------------------------------------------------------- + +.. automodule:: pyrpl.test.test_hardware_modules.test_dsp_inputs + :members: + :undoc-members: + :show-inheritance: + +pyrpl.test.test_hardware_modules.test_na_iir module +--------------------------------------------------- + +.. automodule:: pyrpl.test.test_hardware_modules.test_na_iir + :members: + :undoc-members: + :show-inheritance: + +pyrpl.test.test_hardware_modules.test_pid_na_iq module +------------------------------------------------------ + +.. automodule:: pyrpl.test.test_hardware_modules.test_pid_na_iq + :members: + :undoc-members: + :show-inheritance: + +pyrpl.test.test_hardware_modules.test_scope module +-------------------------------------------------- + +.. automodule:: pyrpl.test.test_hardware_modules.test_scope + :members: + :undoc-members: + :show-inheritance: + +pyrpl.test.test_hardware_modules.test_scope_asg_ams module +---------------------------------------------------------- + +.. automodule:: pyrpl.test.test_hardware_modules.test_scope_asg_ams + :members: + :undoc-members: + :show-inheritance: + +pyrpl.test.test_hardware_modules.test_trig module +------------------------------------------------- + +.. automodule:: pyrpl.test.test_hardware_modules.test_trig + :members: + :undoc-members: + :show-inheritance: + + +Module contents +--------------- + +.. automodule:: pyrpl.test.test_hardware_modules + :members: + :undoc-members: + :show-inheritance: diff --git a/doc/sphinx/source/pyrpl.widgets.module_widgets.rst b/doc/sphinx/source/pyrpl.widgets.module_widgets.rst index f397ceee4..13957a4b2 100644 --- a/doc/sphinx/source/pyrpl.widgets.module_widgets.rst +++ b/doc/sphinx/source/pyrpl.widgets.module_widgets.rst @@ -1,107 +1,107 @@ -pyrpl\.widgets\.module\_widgets package -======================================= +pyrpl.widgets.module_widgets package +==================================== Submodules ---------- -pyrpl\.widgets\.module\_widgets\.asg\_widget module ---------------------------------------------------- +pyrpl.widgets.module_widgets.asg_widget module +---------------------------------------------- .. automodule:: pyrpl.widgets.module_widgets.asg_widget :members: :undoc-members: :show-inheritance: -pyrpl\.widgets\.module\_widgets\.base\_module\_widget module ------------------------------------------------------------- +pyrpl.widgets.module_widgets.base_module_widget module +------------------------------------------------------ .. automodule:: pyrpl.widgets.module_widgets.base_module_widget :members: :undoc-members: :show-inheritance: -pyrpl\.widgets\.module\_widgets\.curve\_viewer\_widget module -------------------------------------------------------------- +pyrpl.widgets.module_widgets.curve_viewer_widget module +------------------------------------------------------- .. automodule:: pyrpl.widgets.module_widgets.curve_viewer_widget :members: :undoc-members: :show-inheritance: -pyrpl\.widgets\.module\_widgets\.iir\_widget module ---------------------------------------------------- +pyrpl.widgets.module_widgets.iir_widget module +---------------------------------------------- .. automodule:: pyrpl.widgets.module_widgets.iir_widget :members: :undoc-members: :show-inheritance: -pyrpl\.widgets\.module\_widgets\.iq\_widget module --------------------------------------------------- +pyrpl.widgets.module_widgets.iq_widget module +--------------------------------------------- .. automodule:: pyrpl.widgets.module_widgets.iq_widget :members: :undoc-members: :show-inheritance: -pyrpl\.widgets\.module\_widgets\.lockbox\_widget module -------------------------------------------------------- +pyrpl.widgets.module_widgets.lockbox_widget module +-------------------------------------------------- .. automodule:: pyrpl.widgets.module_widgets.lockbox_widget :members: :undoc-members: :show-inheritance: -pyrpl\.widgets\.module\_widgets\.module\_manager\_widget module ---------------------------------------------------------------- +pyrpl.widgets.module_widgets.module_manager_widget module +--------------------------------------------------------- .. automodule:: pyrpl.widgets.module_widgets.module_manager_widget :members: :undoc-members: :show-inheritance: -pyrpl\.widgets\.module\_widgets\.na\_widget module --------------------------------------------------- +pyrpl.widgets.module_widgets.na_widget module +--------------------------------------------- .. automodule:: pyrpl.widgets.module_widgets.na_widget :members: :undoc-members: :show-inheritance: -pyrpl\.widgets\.module\_widgets\.pid\_widget module ---------------------------------------------------- +pyrpl.widgets.module_widgets.pid_widget module +---------------------------------------------- .. automodule:: pyrpl.widgets.module_widgets.pid_widget :members: :undoc-members: :show-inheritance: -pyrpl\.widgets\.module\_widgets\.pyrpl\_config\_widget module -------------------------------------------------------------- +pyrpl.widgets.module_widgets.pyrpl_config_widget module +------------------------------------------------------- .. automodule:: pyrpl.widgets.module_widgets.pyrpl_config_widget :members: :undoc-members: :show-inheritance: -pyrpl\.widgets\.module\_widgets\.schematics module --------------------------------------------------- +pyrpl.widgets.module_widgets.schematics module +---------------------------------------------- .. automodule:: pyrpl.widgets.module_widgets.schematics :members: :undoc-members: :show-inheritance: -pyrpl\.widgets\.module\_widgets\.scope\_widget module ------------------------------------------------------ +pyrpl.widgets.module_widgets.scope_widget module +------------------------------------------------ .. automodule:: pyrpl.widgets.module_widgets.scope_widget :members: :undoc-members: :show-inheritance: -pyrpl\.widgets\.module\_widgets\.spec\_an\_widget module --------------------------------------------------------- +pyrpl.widgets.module_widgets.spec_an_widget module +-------------------------------------------------- .. automodule:: pyrpl.widgets.module_widgets.spec_an_widget :members: diff --git a/doc/sphinx/source/pyrpl.widgets.rst b/doc/sphinx/source/pyrpl.widgets.rst index 92ab560ce..de856a125 100644 --- a/doc/sphinx/source/pyrpl.widgets.rst +++ b/doc/sphinx/source/pyrpl.widgets.rst @@ -1,5 +1,5 @@ -pyrpl\.widgets package -====================== +pyrpl.widgets package +===================== Subpackages ----------- @@ -11,24 +11,40 @@ Subpackages Submodules ---------- -pyrpl\.widgets\.attribute\_widgets module ------------------------------------------ +pyrpl.widgets.attribute_widgets module +-------------------------------------- .. automodule:: pyrpl.widgets.attribute_widgets :members: :undoc-members: :show-inheritance: -pyrpl\.widgets\.pyrpl\_widget module ------------------------------------- +pyrpl.widgets.pyrpl_widget module +--------------------------------- .. automodule:: pyrpl.widgets.pyrpl_widget :members: :undoc-members: :show-inheritance: -pyrpl\.widgets\.yml\_editor module ----------------------------------- +pyrpl.widgets.spinbox module +---------------------------- + +.. automodule:: pyrpl.widgets.spinbox + :members: + :undoc-members: + :show-inheritance: + +pyrpl.widgets.startup_widget module +----------------------------------- + +.. automodule:: pyrpl.widgets.startup_widget + :members: + :undoc-members: + :show-inheritance: + +pyrpl.widgets.yml_editor module +------------------------------- .. automodule:: pyrpl.widgets.yml_editor :members: diff --git a/pyrpl/redpitaya.py b/pyrpl/redpitaya.py index fce7d2919..c0d43db27 100644 --- a/pyrpl/redpitaya.py +++ b/pyrpl/redpitaya.py @@ -257,8 +257,8 @@ def update_fpga(self, filename=None): "The fpga bitfile was not found at the expected location. Try passing the arguments " "dirname=\"c://github//pyrpl//pyrpl//\" adapted to your installation directory of pyrpl " "and filename=\"red_pitaya.bin\"! Current dirname: " - +self.parameters['dirname'] - +" current filename: "+self.parameters['filename']) + + self.parameters['dirname'] + + " current filename: "+self.parameters['filename']) for i in range(3): try: self.ssh.scp.put(source,