Skip to content
Snippets Groups Projects
Commit 322ea818 authored by Jan Petermann's avatar Jan Petermann
Browse files

rename

parent c3d3d1ea
Branches
No related tags found
No related merge requests found
Show whitespace changes
Inline Side-by-side
Showing
with 37 additions and 37 deletions
.gitignore
+ 1
− 1
View file @ 322ea818
...@@ -2,7 +2,7 @@ ...@@ -2,7 +2,7 @@
*.sublime-* *.sublime-*
dist/ dist/
build/ build/
OpenQlab.egg-info/ openqlab.egg-info/
doc/_build doc/_build
.ropeproject .ropeproject
.eggs .eggs
......
LICENSE
+ 2
− 2
View file @ 322ea818
...@@ -631,7 +631,7 @@ to attach them to the start of each source file to most effectively ...@@ -631,7 +631,7 @@ to attach them to the start of each source file to most effectively
state the exclusion of warranty; and each file should have at least state the exclusion of warranty; and each file should have at least
the "copyright" line and a pointer to where the full notice is found. the "copyright" line and a pointer to where the full notice is found.
OpenQlab openqlab
Copyright (C) 2019 las-nq Copyright (C) 2019 las-nq
This program is free software: you can redistribute it and/or modify This program is free software: you can redistribute it and/or modify
...@@ -652,7 +652,7 @@ Also add information on how to contact you by electronic and paper mail. ...@@ -652,7 +652,7 @@ Also add information on how to contact you by electronic and paper mail.
If the program does terminal interaction, make it output a short If the program does terminal interaction, make it output a short
notice like this when it starts in an interactive mode: notice like this when it starts in an interactive mode:
OpenQlab Copyright (C) 2019 las-nq openqlab Copyright (C) 2019 las-nq
This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
This is free software, and you are welcome to redistribute it This is free software, and you are welcome to redistribute it
under certain conditions; type `show c' for details. under certain conditions; type `show c' for details.
......
README.md
+ 2
− 2
View file @ 322ea818
# OpenQlab # openqlab
[![pipeline status](https://git.physnet.uni-hamburg.de/las-nq/openqlab/badges/master/pipeline.svg)](https://git.physnet.uni-hamburg.de/las-nq/openqlab/commits/master) [![pipeline status](https://git.physnet.uni-hamburg.de/las-nq/openqlab/badges/master/pipeline.svg)](https://git.physnet.uni-hamburg.de/las-nq/openqlab/commits/master)
[![coverage report](https://git.physnet.uni-hamburg.de/las-nq/openqlab/badges/master/coverage.svg)](https://git.physnet.uni-hamburg.de/las-nq/openqlab/commits/master) [![coverage report](https://git.physnet.uni-hamburg.de/las-nq/openqlab/badges/master/coverage.svg)](https://git.physnet.uni-hamburg.de/las-nq/openqlab/commits/master)
`OpenQlab` provides a collection of useful tools and helpers for the `openqlab` provides a collection of useful tools and helpers for the
analysis of lab data in the Nonlinear Quantum Optics Group at the University analysis of lab data in the Nonlinear Quantum Optics Group at the University
of Hamburg. of Hamburg.
......
doc/Makefile
+ 1
− 1
View file @ 322ea818
...@@ -4,7 +4,7 @@ ...@@ -4,7 +4,7 @@
# You can set these variables from the command line. # You can set these variables from the command line.
SPHINXOPTS = SPHINXOPTS =
SPHINXBUILD = python3 -msphinx SPHINXBUILD = python3 -msphinx
SPHINXPROJ = OpenQlab SPHINXPROJ = openqlab
SOURCEDIR = . SOURCEDIR = .
BUILDDIR = _build BUILDDIR = _build
......
doc/analysis.rst
+ 4
− 4
View file @ 322ea818
:mod:`OpenQlab.analysis` -- Data Analysis Tools and Helpers :mod:`openqlab.analysis` -- Data Analysis Tools and Helpers
*********************************************************** ***********************************************************
.. note:: .. note::
...@@ -13,7 +13,7 @@ Gaussian Beam ...@@ -13,7 +13,7 @@ Gaussian Beam
Fit beam data obtained from a beam analyzer to the gaussian beam model using non-linear least squares. Fit beam data obtained from a beam analyzer to the gaussian beam model using non-linear least squares.
.. automodule:: OpenQlab.analysis.gaussian_beam .. automodule:: openqlab.analysis.gaussian_beam
:members: :members:
Phase Phase
...@@ -21,7 +21,7 @@ Phase ...@@ -21,7 +21,7 @@ Phase
Phase calculations Phase calculations
.. automodule:: OpenQlab.analysis.phase .. automodule:: openqlab.analysis.phase
:members: :members:
Servo Design Servo Design
...@@ -29,5 +29,5 @@ Servo Design ...@@ -29,5 +29,5 @@ Servo Design
Toolkit for simulating and designing servo controllers. Toolkit for simulating and designing servo controllers.
.. automodule:: OpenQlab.analysis.servo_design .. automodule:: openqlab.analysis.servo_design
:members: :members:
doc/datacontainer.rst
+ 1
− 1
View file @ 322ea818
...@@ -6,6 +6,6 @@ See here the original documentation of DataFrame_. ...@@ -6,6 +6,6 @@ See here the original documentation of DataFrame_.
.. _DataFrame: https://pandas.pydata.org/pandas-docs/stable/generated/pandas.DataFrame.html .. _DataFrame: https://pandas.pydata.org/pandas-docs/stable/generated/pandas.DataFrame.html
.. automodule:: OpenQlab.io.data_container .. automodule:: openqlab.io.data_container
:members: :members:
:no-undoc-members: :no-undoc-members:
doc/dataframes.rst
+ 1
− 1
View file @ 322ea818
Working with DataFrames/DataContainer Working with DataFrames/DataContainer
************************************* *************************************
The data import functions of :obj:`OpenQlab` make extensive use of :obj:`OpenQlab.io.data_container`, which are convenient objects that hold measurement data similar to an Excel table. The data containers are actually based on the *Pandas* :obj:`DataFrame`, plus some additional header information that further describes the measurement data, such as *RBW*, *frequency range*, etc. Since working with :obj:`DataFrames` can be very convenient, let us give a short introduction to them here. There is also *Panda's* excellent tutorial `10 min to Pandas`_. The data import functions of :obj:`openqlab` make extensive use of :obj:`openqlab.io.data_container`, which are convenient objects that hold measurement data similar to an Excel table. The data containers are actually based on the *Pandas* :obj:`DataFrame`, plus some additional header information that further describes the measurement data, such as *RBW*, *frequency range*, etc. Since working with :obj:`DataFrames` can be very convenient, let us give a short introduction to them here. There is also *Panda's* excellent tutorial `10 min to Pandas`_.
.. _10 min to Pandas: https://pandas.pydata.org/pandas-docs/stable/10min.html .. _10 min to Pandas: https://pandas.pydata.org/pandas-docs/stable/10min.html
......
doc/index.rst
+ 2
− 2
View file @ 322ea818
:tocdepth: 2 :tocdepth: 2
Welcome to OpenQlab's documentation! Welcome to openqlab's documentation!
==================================== ====================================
:mod:`OpenQlab` provides a collection of useful tools and helpers for the :mod:`openqlab` provides a collection of useful tools and helpers for the
analysis of lab data in the Nonlinear Quantum Optics Group at the University analysis of lab data in the Nonlinear Quantum Optics Group at the University
of Hamburg. of Hamburg.
......
doc/install.md
+ 6
− 6
View file @ 322ea818
...@@ -2,13 +2,13 @@ ...@@ -2,13 +2,13 @@
## Prerequisites ## Prerequisites
`OpenQlab` requires a working `Python` installation on your PC. Currently, the easiest way to get this is to install the [Anaconda](https://www.anaconda.com/download/) distribution. Select the `Python 3.x` version (at the time of writing, x=7). `openqlab` requires a working `Python` installation on your PC. Currently, the easiest way to get this is to install the [Anaconda](https://www.anaconda.com/download/) distribution. Select the `Python 3.x` version (at the time of writing, x=7).
## Using the PyPi server (recommended) ## Using the PyPi server (recommended)
This is the recommended, easiest version to install OpenQlab. This is the recommended, easiest version to install openqlab.
```bash ```bash
pip3 install --upgrade --user OpenQlab pip3 install --upgrade --user openqlab
``` ```
If you don't have `pip3` on your system, try `pip`. If you don't have `pip3` on your system, try `pip`.
To install system wide don't use the `--user` flag. To install system wide don't use the `--user` flag.
...@@ -17,7 +17,7 @@ To install system wide don't use the `--user` flag. ...@@ -17,7 +17,7 @@ To install system wide don't use the `--user` flag.
You can get the current version on our [deployment server](https://las-nq-serv.physnet.uni-hamburg.de/software-builds/nq-lab/) or on the [gitlab server](https://gitlab.aei.uni-hannover.de/las-nq/lab/). You can get the current version on our [deployment server](https://las-nq-serv.physnet.uni-hamburg.de/software-builds/nq-lab/) or on the [gitlab server](https://gitlab.aei.uni-hannover.de/las-nq/lab/).
Unpack the OpenQlab archive and `cd` to it. Unpack the openqlab archive and `cd` to it.
### Install dependencies ### Install dependencies
...@@ -33,9 +33,9 @@ To install all pythonic dependencies you can simply run: ...@@ -33,9 +33,9 @@ To install all pythonic dependencies you can simply run:
make requirements make requirements
``` ```
### Install OpenQlab ### Install openqlab
Install `OpenQlab` for the current user: Install `openqlab` for the current user:
```bash ```bash
python3 setup.py install --user python3 setup.py install --user
......
doc/io.rst
+ 4
− 4
View file @ 322ea818
:mod:`OpenQlab.io` -- Import of Instrument Data :mod:`openqlab.io` -- Import of Instrument Data
*********************************************** ***********************************************
Convenient importers of instrument data. Convenient importers of instrument data.
...@@ -6,19 +6,19 @@ Convenient importers of instrument data. ...@@ -6,19 +6,19 @@ Convenient importers of instrument data.
Import Functions Import Functions
---------------- ----------------
.. automodule:: OpenQlab.io .. automodule:: openqlab.io
:members: read,import_data :members: read,import_data
Base Importer Base Importer
------------- -------------
.. automodule:: OpenQlab.io.base_importer .. automodule:: openqlab.io.base_importer
:members: :members:
Importers Importers
--------- ---------
.. automodule:: OpenQlab.io.importers .. automodule:: openqlab.io.importers
:members: :members:
doc/make.bat
+ 1
− 1
View file @ 322ea818
...@@ -10,7 +10,7 @@ if "%SPHINXBUILD%" == "" ( ...@@ -10,7 +10,7 @@ if "%SPHINXBUILD%" == "" (
) )
set SOURCEDIR=. set SOURCEDIR=.
set BUILDDIR=_build set BUILDDIR=_build
set SPHINXPROJ=OpenQlab set SPHINXPROJ=openqlab
if "%1" == "" goto help if "%1" == "" goto help
......
doc/plots.rst
+ 4
− 4
View file @ 322ea818
:mod:`OpenQlab.plots` -- Plotting of Data :mod:`openqlab.plots` -- Plotting of Data
***************************************** *****************************************
Time-Domain Plots Time-Domain Plots
----------------- -----------------
.. automodule:: OpenQlab.plots.time_domain .. automodule:: openqlab.plots.time_domain
:members: :members:
Frequency-Domain Plots Frequency-Domain Plots
---------------------- ----------------------
.. automodule:: OpenQlab.plots.frequency_domain .. automodule:: openqlab.plots.frequency_domain
:members: :members:
Gaussian Beam Plots Gaussian Beam Plots
------------------- -------------------
.. automodule:: OpenQlab.plots.gaussian_beam .. automodule:: openqlab.plots.gaussian_beam
:members: :members:
doc/servodesign.rst
+ 3
− 3
View file @ 322ea818
Servo Design Servo Design
************ ************
:mod:`OpenQlab` helps with designing a standard servo circuit. Here's an example: :mod:`openqlab` helps with designing a standard servo circuit. Here's an example:
>>> %pylab notebook >>> %pylab notebook
>>> from openqlab.analysis import servo_design >>> from openqlab.analysis import servo_design
...@@ -38,7 +38,7 @@ that means. A list of available filters can be found on the ...@@ -38,7 +38,7 @@ that means. A list of available filters can be found on the
>>> %pylab notebook >>> %pylab notebook
>>> from OpenQlab.analysis import servo_design >>> from openqlab.analysis import servo_design
>>> S = servo_design.ServoDesign() >>> S = servo_design.ServoDesign()
>>> S.integrator(1e3).notch(22e3, 100).lowpass(10e3, Q=1.0).gain(10) >>> S.integrator(1e3).notch(22e3, 100).lowpass(10e3, Q=1.0).gain(10)
zeros poles gain zeros poles gain
...@@ -52,7 +52,7 @@ As you can see, the servo keeps track of the individual filters that are added, ...@@ -52,7 +52,7 @@ As you can see, the servo keeps track of the individual filters that are added,
labelling them with a shorthand notation. It also displays poles, zeros and gain labelling them with a shorthand notation. It also displays poles, zeros and gain
for the individual filters, but you can just ignore that if you don't know what for the individual filters, but you can just ignore that if you don't know what
that means. A list of available filters can be found on the that means. A list of available filters can be found on the
:class:`OpenQlab.analysis.servo_design.ServoDesign` page. To get a graph of how :class:`openqlab.analysis.servo_design.ServoDesign` page. To get a graph of how
this servo's response looks like in the frequency domain, simply say: this servo's response looks like in the frequency domain, simply say:
>>> S.plot() >>> S.plot()
......
doc/usage.rst
+ 2
− 2
View file @ 322ea818
...@@ -4,12 +4,12 @@ Usage ...@@ -4,12 +4,12 @@ Usage
Introduction Introduction
------------ ------------
`OpenQlab` is conveniently used inside *Jupyter* notebooks. *Jupyter* is a part of e.g. the Anaconda installation. It allows to combine *Python* code together with images and documentation in a single, nicely formatted notebook page. `openqlab` is conveniently used inside *Jupyter* notebooks. *Jupyter* is a part of e.g. the Anaconda installation. It allows to combine *Python* code together with images and documentation in a single, nicely formatted notebook page.
Here's how to import squeezing traces from a spectrum analyzer and plot them:: Here's how to import squeezing traces from a spectrum analyzer and plot them::
>>> %pylab inline >>> %pylab inline
>>> from OpenQlab import * >>> from openqlab import *
>>> data = io.read(['vac.txt', 'sqz.txt', 'mcd.txt']) >>> data = io.read(['vac.txt', 'sqz.txt', 'mcd.txt'])
>>> data.head() >>> data.head()
vac sqz mcd vac sqz mcd
......
setup.cfg
+ 3
− 3
View file @ 322ea818
...@@ -3,7 +3,7 @@ ...@@ -3,7 +3,7 @@
# http://setuptools.readthedocs.io/en/latest/setuptools.html#configuring-setup-using-setup-cfg-files # http://setuptools.readthedocs.io/en/latest/setuptools.html#configuring-setup-using-setup-cfg-files
[metadata] [metadata]
name = OpenQlab name = openqlab
description = An open-source collection of tools for quantum-optics experiments description = An open-source collection of tools for quantum-optics experiments
author = Group LasNQ, ILP, University of Hamburg author = Group LasNQ, ILP, University of Hamburg
author-email = author-email =
...@@ -49,7 +49,7 @@ addopts = tests ...@@ -49,7 +49,7 @@ addopts = tests
# e.g. --cov-report html (or xml) for html/xml output or --junitxml junit.xml # e.g. --cov-report html (or xml) for html/xml output or --junitxml junit.xml
# in order to write a coverage file that can be read by Jenkins. # in order to write a coverage file that can be read by Jenkins.
addopts = addopts =
--cov OpenQlab --cov-report term-missing --cov openqlab --cov-report term-missing
--verbose --verbose
norecursedirs = norecursedirs =
dist dist
...@@ -86,4 +86,4 @@ exclude = ...@@ -86,4 +86,4 @@ exclude =
# PyScaffold's parameters when the project was created. # PyScaffold's parameters when the project was created.
# This will be used when updating. Do not change! # This will be used when updating. Do not change!
version = 3.0.3 version = 3.0.3
package = OpenQlab package = openqlab
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment