From 29b1928a5fe3a61c5978b6c482872dda5f4537ca Mon Sep 17 00:00:00 2001
From: G Adam Cox <gadamc@gmail.com>
Date: Tue, 7 Feb 2023 13:20:27 -0800
Subject: [PATCH] Moves version back to pyproject.toml Updates README.

---
 README.md                | 40 ++++++++++++++++++++++++++--------------
 pyproject.toml           |  4 +---
 src/qt3utils/__init__.py |  3 ++-
 3 files changed, 29 insertions(+), 18 deletions(-)

diff --git a/README.md b/README.md
index 20305a92..c0e1a0cd 100644
--- a/README.md
+++ b/README.md
@@ -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
@@ -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
@@ -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
diff --git a/pyproject.toml b/pyproject.toml
index d9c5ff3e..592b4f59 100644
--- a/pyproject.toml
+++ b/pyproject.toml
@@ -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"
@@ -63,5 +63,3 @@ dependencies = [
 qt3scope = "applications.oscilloscope:main"
 qt3scan = "applications.piezoscan:main"
 
-[tool.setuptools.dynamic]
-version = {attr = "qt3utils.__version__"}
diff --git a/src/qt3utils/__init__.py b/src/qt3utils/__init__.py
index c6092d3e..54baa20b 100644
--- a/src/qt3utils/__init__.py
+++ b/src/qt3utils/__init__.py
@@ -1 +1,2 @@
-__version__ = '1.0.1.dev0'
+from importlib.metadata import version
+__version__ = version(__package__)