# 
Welcome to the Joulescope™ User Interface software repo!
Joulescope is an affordable, precision energy
analyzer that enables you to build better products.
Joulescope™ accurately and simultaneously measures the voltage and current
supplied to your target device, and it then computes power and energy.
For more information on Joulescope, see
[www.joulescope.com](https://www.joulescope.com).
This repository contains the Joulescope graphical User Interface (UI).
The UI runs on a host computer and communicates with the Joulescope device
over USB. The application source code is available at
https://github.com/jetperch/pyjoulescope_ui.
The software is highly configurable. Here is the Multimeter view on Windows 11:
<img src="docs/multimeter.png" width="509" />
And here is the Oscilloscope view on Windows 11:
For more information, see:
* [Tips](docs/tips.md): for using the UI.
* [Translations and locale](docs/locale.md)
* [Plugins](docs/plugin.md): Using and developing UI plugins.
* [Changelog](CHANGELOG.md): list of changes by release
* [Future features](docs/features_future.md)
* [Contributing](CONTRIBUTING.md)
* [Code of Conduct](CODE_OF_CONDUCT.md)
* [Developer notes](docs/dev.md)
* [PubSub](docs/pubsub.md)
## Quick start using official distribution
We provide official distributions for Windows, macOS and Ubuntu 22.04LTS.
Visit the main [download](https://www.joulescope.com/download)
page for the latest stable build.
You can download the latest and previous alpha, beta, and stable builds
[here](https://download.joulescope.com/joulescope_install/index_v2.html).
## Run as python package
The Joulescope UI is a python package which you can install for pypi or
run directly from source.
### Install Python
The Joulescope User Interface requires Python 3.9 or newer.
We recommend Python 3.11.
Install [Python 3.9+](https://www.python.org/) on your system and then verify
your python version at the terminal or command line:
> python -VV
Python 3.11.4 (tags/v3.11.4:d2340ef, Jun 7 2023, 05:45:37) [MSC v.1934 64 bit (AMD64)]
Ensure that you have Python 3.9 or newer and 64-bit.
For macOS, you can also use
[Homebrew](https://docs.brew.sh/Installation)
to [install python](https://docs.brew.sh/Homebrew-and-Python).
### Configure virtualenv [optional]
Although not required, using
[virtualenv](https://virtualenv.pypa.io/en/latest/)
avoids dependency conflicts, especially if you use your python installation for
other programs. Using virtualenv ensures that
the Joulescope software has the right dependencies without changing the rest
of your system.
#### For Windows:
Install virtualenv and create a new virtual environment:
python -v venv c:\venv\joulescope
Activate the virtual environment whenever you start a new terminal:
c:\venv\joulescope\Scripts\activate
#### For POSIX including (Linux, macOS):
Install virtualenv and create a new virtual environment:
python -m venv ~/venv/joulescope
Activate the virtual environment whenever you start a new terminal:
. ~/venv/joulescope/bin/activate
### Install using pypi
Installation from pypi is easy:
python -m pip install -U --upgrade-strategy=eager joulescope_ui
If you just want to run the latest released version of the UI.
For Linux, you need to perform additional steps. Here are steps for
Ubuntu:
sudo apt install libudev-dev libxcb-cursor0
wget https://raw.githubusercontent.com/jetperch/joulescope_driver/main/99-joulescope.rules
sudo cp 99-joulescope.rules /etc/udev/rules.d/
sudo udevadm control --reload-rules
If you receive the error:
`Could not load the Qt platform plugin "xcb" in "" even though it was found`,
you need to install additional dependencies. First identify the
missing dependencies:
export QT_DEBUG_PLUGINS=1
python3 -m joulescope_ui
Then install them using apt or your distribution's package manager.
The Joulescope UI uses Qt6, and you can find the Qt6 dependencies
[here](https://doc.qt.io/qt-6/linux-requirements.html).
### Run
Whenever you want to run the Joulescope UI:
python -m joulescope_ui
Depending upon your system, you may need to replace "python"
with "python3" or the full path to your python executable.
The joulescope package also contains an executable, so you can often type:
joulescope ui
## Developer Howto
Clone and configure the Joulescope UI from the terminal or command line:
git clone https://github.com/jetperch/pyjoulescope_ui.git
cd pyjoulescope_ui
python -m pip install -U --upgrade-strategy eager -r requirements.txt
Build the QT resources:
python setup.py sdist
As long as the current directory is the source directory, you can run:
python -m joulescope_ui
If you want to run from another directory, you will need to add the source
to your PYTHONPATH environment variable.
Windows using command prompt:
set PYTHONPATH={C:\path\to\repos}\pyjoulescope_ui
Windows using PowerShell:
$env:PYTHONPATH = "{C:\path\to\repos}\pyjoulescope_ui"
POSIX shells (most Linux, macOS with homebrew):
export PYTHONPATH={path/to/repos}/pyjoulescope_ui
To also distribute the UI on macOS, you need to install XCode and then
configure node. If using homebrew:
brew install node
npm install
You will also need to install the signing certificate using
Applications/Utilities/Keychain Access.
If you also want to simultaneously develop the Joulescope UI and the
Joulescope driver, you can include the joulescope_driver in
your PYTHONPATH and build in place:
pip3 uninstall joulescope
cd {path/to/repos}
git clone https://github.com/jetperch/joulescope_driver.git
cd joulescope_driver
pip3 install -U -r requirements.txt
python setup.py build_ext --inplace && python -m unittest
git clone https://github.com/jetperch/pyjoulescope.git
cd pyjoulescope
pip3 install -U -r requirements.txt
python setup.py build_ext --inplace && python -m unittest
You should then modify your python path to find both the UI and driver
source paths. On Windows:
set PYTHONPATH={C:\path\to\repos}\joulescope_driver;C:\path\to\repos}\pyjoulescope;{C:\path\to\repos}\pyjoulescope_ui
and on POSIX (Linux, Mac OS X with homebrew):
export PYTHONPATH={path/to/repos}/pyjoulescope:{path/to/repos}/pyjoulescope_ui
## License
All pyjoulescope_ui code is released under the permissive Apache 2.0 license.
See the [License File](LICENSE.txt) for details.
Raw data
{
"_id": null,
"home_page": "https://www.joulescope.com",
"name": "joulescope-ui",
"maintainer": null,
"docs_url": null,
"requires_python": "~=3.10",
"maintainer_email": null,
"keywords": "joulescope ui gui \"user interface\"",
"author": "Jetperch LLC",
"author_email": "joulescope-dev@jetperch.com",
"download_url": "https://files.pythonhosted.org/packages/29/01/fa327cff0b80e57c88166d74e315315b047ece1bff45d9bdc4a24b3c5125/joulescope_ui-1.1.6.tar.gz",
"platform": null,
"description": "\n# ![Joulescope](https://download.joulescope.com/press/joulescope_logo-PNG-Transparent-Exact-Small.png \"Joulescope Logo\")\n\n\nWelcome to the Joulescope\u2122 User Interface software repo!\nJoulescope is an affordable, precision energy\nanalyzer that enables you to build better products.\nJoulescope\u2122 accurately and simultaneously measures the voltage and current\nsupplied to your target device, and it then computes power and energy.\nFor more information on Joulescope, see\n[www.joulescope.com](https://www.joulescope.com).\n\nThis repository contains the Joulescope graphical User Interface (UI).\nThe UI runs on a host computer and communicates with the Joulescope device\nover USB. The application source code is available at\nhttps://github.com/jetperch/pyjoulescope_ui. \n\nThe software is highly configurable. Here is the Multimeter view on Windows 11:\n\n<img src=\"docs/multimeter.png\" width=\"509\" />\n\nAnd here is the Oscilloscope view on Windows 11:\n\n\n\nFor more information, see:\n\n* [Tips](docs/tips.md): for using the UI.\n* [Translations and locale](docs/locale.md)\n* [Plugins](docs/plugin.md): Using and developing UI plugins.\n* [Changelog](CHANGELOG.md): list of changes by release\n* [Future features](docs/features_future.md)\n* [Contributing](CONTRIBUTING.md)\n* [Code of Conduct](CODE_OF_CONDUCT.md)\n* [Developer notes](docs/dev.md)\n* [PubSub](docs/pubsub.md)\n\n\n## Quick start using official distribution\n\nWe provide official distributions for Windows, macOS and Ubuntu 22.04LTS.\n\nVisit the main [download](https://www.joulescope.com/download) \npage for the latest stable build.\n\nYou can download the latest and previous alpha, beta, and stable builds\n[here](https://download.joulescope.com/joulescope_install/index_v2.html).\n\n\n## Run as python package\n\nThe Joulescope UI is a python package which you can install for pypi or\nrun directly from source.\n\n\n### Install Python\n\nThe Joulescope User Interface requires Python 3.9 or newer.\nWe recommend Python 3.11.\nInstall [Python 3.9+](https://www.python.org/) on your system and then verify\nyour python version at the terminal or command line:\n\n > python -VV\n Python 3.11.4 (tags/v3.11.4:d2340ef, Jun 7 2023, 05:45:37) [MSC v.1934 64 bit (AMD64)]\n\nEnsure that you have Python 3.9 or newer and 64-bit.\nFor macOS, you can also use\n[Homebrew](https://docs.brew.sh/Installation)\nto [install python](https://docs.brew.sh/Homebrew-and-Python).\n\n\n### Configure virtualenv [optional]\n\nAlthough not required, using\n[virtualenv](https://virtualenv.pypa.io/en/latest/)\navoids dependency conflicts, especially if you use your python installation for\nother programs. Using virtualenv ensures that\nthe Joulescope software has the right dependencies without changing the rest\nof your system.\n\n\n#### For Windows:\n\nInstall virtualenv and create a new virtual environment:\n\n python -v venv c:\\venv\\joulescope\n\nActivate the virtual environment whenever you start a new terminal:\n\n c:\\venv\\joulescope\\Scripts\\activate\n\n\n#### For POSIX including (Linux, macOS):\n\nInstall virtualenv and create a new virtual environment:\n\n python -m venv ~/venv/joulescope\n\nActivate the virtual environment whenever you start a new terminal:\n\n . ~/venv/joulescope/bin/activate\n\n\n### Install using pypi\n\nInstallation from pypi is easy:\n\n python -m pip install -U --upgrade-strategy=eager joulescope_ui\n \nIf you just want to run the latest released version of the UI.\n\nFor Linux, you need to perform additional steps. Here are steps for\nUbuntu:\n\n sudo apt install libudev-dev libxcb-cursor0\n wget https://raw.githubusercontent.com/jetperch/joulescope_driver/main/99-joulescope.rules\n sudo cp 99-joulescope.rules /etc/udev/rules.d/\n sudo udevadm control --reload-rules\n\nIf you receive the error:\n`Could not load the Qt platform plugin \"xcb\" in \"\" even though it was found`,\nyou need to install additional dependencies. First identify the \nmissing dependencies:\n\n export QT_DEBUG_PLUGINS=1\n python3 -m joulescope_ui\n\nThen install them using apt or your distribution's package manager.\nThe Joulescope UI uses Qt6, and you can find the Qt6 dependencies\n[here](https://doc.qt.io/qt-6/linux-requirements.html).\n\n\n### Run\n\nWhenever you want to run the Joulescope UI:\n\n python -m joulescope_ui\n\nDepending upon your system, you may need to replace \"python\" \nwith \"python3\" or the full path to your python executable.\n\nThe joulescope package also contains an executable, so you can often type:\n\n joulescope ui\n\n\n## Developer Howto\n\nClone and configure the Joulescope UI from the terminal or command line:\n\n git clone https://github.com/jetperch/pyjoulescope_ui.git\n cd pyjoulescope_ui\n python -m pip install -U --upgrade-strategy eager -r requirements.txt\n\nBuild the QT resources:\n\n python setup.py sdist\n\nAs long as the current directory is the source directory, you can run:\n\n python -m joulescope_ui\n\nIf you want to run from another directory, you will need to add the source\nto your PYTHONPATH environment variable. \n\nWindows using command prompt:\n\n set PYTHONPATH={C:\\path\\to\\repos}\\pyjoulescope_ui\n\nWindows using PowerShell:\n\n $env:PYTHONPATH = \"{C:\\path\\to\\repos}\\pyjoulescope_ui\"\n\nPOSIX shells (most Linux, macOS with homebrew):\n\n export PYTHONPATH={path/to/repos}/pyjoulescope_ui\n\nTo also distribute the UI on macOS, you need to install XCode and then\nconfigure node. If using homebrew:\n\n brew install node\n npm install\n\nYou will also need to install the signing certificate using\nApplications/Utilities/Keychain Access.\n\nIf you also want to simultaneously develop the Joulescope UI and the\nJoulescope driver, you can include the joulescope_driver in \nyour PYTHONPATH and build in place:\n\n pip3 uninstall joulescope\n cd {path/to/repos}\n git clone https://github.com/jetperch/joulescope_driver.git\n cd joulescope_driver\n pip3 install -U -r requirements.txt\n python setup.py build_ext --inplace && python -m unittest\n git clone https://github.com/jetperch/pyjoulescope.git\n cd pyjoulescope\n pip3 install -U -r requirements.txt \n python setup.py build_ext --inplace && python -m unittest\n\nYou should then modify your python path to find both the UI and driver\nsource paths. On Windows:\n\n set PYTHONPATH={C:\\path\\to\\repos}\\joulescope_driver;C:\\path\\to\\repos}\\pyjoulescope;{C:\\path\\to\\repos}\\pyjoulescope_ui\n\nand on POSIX (Linux, Mac OS X with homebrew):\n\n export PYTHONPATH={path/to/repos}/pyjoulescope:{path/to/repos}/pyjoulescope_ui\n\n\n## License\n\nAll pyjoulescope_ui code is released under the permissive Apache 2.0 license.\nSee the [License File](LICENSE.txt) for details.\n",
"bugtrack_url": null,
"license": "Apache 2.0",
"summary": "Joulescope\u2122 graphical user interface",
"version": "1.1.6",
"project_urls": {
"Bug Reports": "https://github.com/jetperch/pyjoulescope_ui/issues",
"Funding": "https://www.joulescope.com",
"Homepage": "https://www.joulescope.com",
"Source": "https://github.com/jetperch/pyjoulescope_ui/",
"Twitter": "https://twitter.com/joulescope"
},
"split_keywords": [
"joulescope",
"ui",
"gui",
"\"user",
"interface\""
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "2901fa327cff0b80e57c88166d74e315315b047ece1bff45d9bdc4a24b3c5125",
"md5": "061f31633a252ece84d7d98e7018a411",
"sha256": "8a6bc9fdd580ec4e54bdebe7132cbf599589e8ef346eb21920c53a5d6fb06224"
},
"downloads": -1,
"filename": "joulescope_ui-1.1.6.tar.gz",
"has_sig": false,
"md5_digest": "061f31633a252ece84d7d98e7018a411",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "~=3.10",
"size": 4103823,
"upload_time": "2024-04-26T14:26:59",
"upload_time_iso_8601": "2024-04-26T14:26:59.191961Z",
"url": "https://files.pythonhosted.org/packages/29/01/fa327cff0b80e57c88166d74e315315b047ece1bff45d9bdc4a24b3c5125/joulescope_ui-1.1.6.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-26 14:26:59",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "jetperch",
"github_project": "pyjoulescope_ui",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "joulescope-ui"
}
JSON
