Skip to content

Commit

Permalink
Moves version back to pyproject.toml
Browse files Browse the repository at this point in the history
Updates README.
  • Loading branch information
gadamc committed Feb 7, 2023
1 parent e4060da commit 29b1928
Show file tree
Hide file tree
Showing 3 changed files with 29 additions and 18 deletions.
40 changes: 26 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,32 +22,33 @@ experiments.
### Prerequisites

The utilities in this package depend on publicly available Python packages found
on PyPI and on packages currently only on github. The public packages will be installed
automatically when you run the installation script. However, you will first
need to manually install the following packages
on PyPI. However, the package also depends on the National Instruments DAQmx and
SpinCore's PulseBlaster libraries. These libraries are not available on PyPI and
must be installed separately.

* [gadamc/qcsapphire](https://github.com/gadamc/qcsapphire)
* [gadamc/qt3RFSynthControl](https://github.com/gadamc/qt3RFSynthControl)
* [gadamc/nipiezeojenapy](https://github.com/gadamc/nipiezeojenapy)
* [zeeshawnkazi/pulseblaster](https://github.com/zeeshawnkazi/pulseblaster)
* [National Instruments DAQmx](https://nidaqmx-python.readthedocs.io/en/latest/)
* [driver downloads](http://www.ni.com/downloads/)
* [SpinCore's PulseBlaster](https://www.spincore.com/pulseblaster.html)
* [spinAPI driver](http://www.spincore.com/support/spinapi/)

## Installation

Once the prerequisite packages have been installed

```
git clone https://github.com/gadamc/qt3-utils
cd qt3-utils
python -m pip install .
pip install qt3utils
```

# Usage

The simplest way to get started is to see one of the [example](examples) notebooks.
This package provides GUI applications and a Python API for controlling the hardware and running experiments.

# Applications
For instructions on using the python API,
the simplest way to get started is to see one of the [example](examples) notebooks.

## QT3 Oscilloscope
## Applications

### QT3 Oscilloscope

The console program `qt3scope` comes with this package. It allows you to run
a simple program from the command-line that reads the count rate on a particular
Expand All @@ -67,7 +68,7 @@ If default settings are correct, then should be able to run without options
> qt3scope
```

## QT3 Confocal Scan
### QT3 Confocal Scan

The console program `qt3scan` comes with this package. This program launches
a GUI applications that will perform a confocal scan using the Jena system
Expand All @@ -88,6 +89,17 @@ If default settings are correct, then should be able to run without options
> qt3scan
```

### QT3 Piezo Controller

The console program `qt3piezo` comes installed via the 'nipiezojenapy' package, and may be launched from the command line.

```
> qt3piezo
```

Similarly, this applications can be configured via command line options to match the haredware setup.


# Debugging

# LICENSE
Expand Down
4 changes: 1 addition & 3 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"

[project]
name = "qt3utils"
dynamic = ["version"] # version is defined in __init__.py
version = '1.0.1.dev1'

description = "A package for performing experiments in the QT3 lab at UW."
readme = "README.md"
Expand Down Expand Up @@ -63,5 +63,3 @@ dependencies = [
qt3scope = "applications.oscilloscope:main"
qt3scan = "applications.piezoscan:main"

[tool.setuptools.dynamic]
version = {attr = "qt3utils.__version__"}
3 changes: 2 additions & 1 deletion src/qt3utils/__init__.py
Original file line number Diff line number Diff line change
@@ -1 +1,2 @@
__version__ = '1.0.1.dev0'
from importlib.metadata import version
__version__ = version(__package__)

0 comments on commit 29b1928

Please sign in to comment.