bapsf-motion 0.2.0b1__tar.gz

bapsf_motion-0.2.0b1/.gitattributes

@@ -0,0 +1,10 @@
+*.vi binary
+*.vim binary
+*.lvproj binary
+*.lvclass binary
+*.lvlps binary
+*.aliases binary
+*.lvlib binary
+*.vit binary
+*.ctl binary
+*.ctt binary

bapsf_motion-0.2.0b1/.github/dependabot.yml

@@ -0,0 +1,20 @@
+# as per
+#     https://docs.github.com/en/code-security/supply-chain-security/enabling-and-disabling-version-updates
+# configuration options
+#     https://docs.github.com/en/code-security/dependabot/dependabot-version-updates/configuration-options-for-the-dependabot.yml-file
+#
+version: 2
+updates:
+
+  # Maintain dependencies for GitHub Actions
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    reviewers:
+      - "rocco8773"
+    assignees:
+      - "rocco8773"
+    schedule:
+      interval: "weekly"
+      day: "monday"
+      # Check for npm updates at 4am PST
+      time: "23:00"

bapsf_motion-0.2.0b1/.github/workflows/python-publish.yml

@@ -0,0 +1,48 @@
+# This workflow will upload a Python Package using Twine when a release
+# is created.  For more information see:
+#
+#   https://help.github.com/en/actions/language-and-framework-guides/using-python-with-github-actions#publishing-to-package-registries
+#
+# PyPI's instructions on creating a new project
+#   https://packaging.python.org/en/latest/guides/publishing-package-distribution-releases-using-github-actions-ci-cd-workflows/#configuring-trusted-publishing
+
+# This workflow uses actions that are not certified by GitHub.
+# They are provided by a third-party and are governed by
+# separate terms of service, privacy policy, and support
+# documentation.
+
+name: Upload Python Package
+
+on:
+  release:
+    types: [published]
+
+permissions:
+  contents: read
+
+jobs:
+  deploy:
+
+    runs-on: ubuntu-latest
+
+    environment:
+      name: pypi
+      url: https://pypi.org/p/bapsf_motion
+
+    permissions:
+      id-token: write
+
+    steps:
+    - uses: actions/checkout@v4
+    - name: Set up Python
+      uses: actions/setup-python@v4
+      with:
+        python-version: 3.x
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install build
+    - name: Build package
+      run: python -m build
+    - name: Publish package (to PyPI)
+      uses: pypa/gh-action-pypi-publish@release/v1

bapsf_motion-0.2.0b1/.github/workflows/test.yml

@@ -0,0 +1,217 @@
+name: Tests
+
+on:
+  schedule:
+    # run every Sunday at 10:13 am UTC (3:13 am PT)
+    - cron: '13 10 * * 0'
+  push:
+    branches:
+      - main
+    tags:
+      - "v*"
+  pull_request:
+  workflow_dispatch:
+
+jobs:
+#  base-tests:
+#    name: py${{ matrix.python }} ${{ matrix.name-modifier }} - on ${{ matrix.os }}
+#    runs-on: ${{ matrix.os }}
+#
+#    strategy:
+#      fail-fast: false
+#      matrix:
+#        include:
+#          # mark default
+#          - python: '3.10'
+#            os: ubuntu-latest
+#            do-coverage: false
+#            name-modifier: ''
+#
+#          # mark case for coverage reporting
+#          - python: '3.7'
+#            os: ubuntu-latest
+#            do-coverage: true
+#            name-modifier: 'with Coverage'
+#    steps:
+#      - name: Checkout code
+#        uses: actions/checkout@v4
+#        with:
+#          fetch-depth: 0
+#      - name: Setup Python
+#        uses: actions/setup-python@v5
+#        with:
+#          python-version: ${{ matrix.python }}
+#      - name: Install 'bapsflib' dependencies
+#        run: python -m pip install -r requirements/tests.txt
+#      - name: Run tests ${{ matrix.name-modifier }}
+#        run: |
+#          if ${{ matrix.do-coverage }}; then
+#            coverage run -m unittest discover
+#          else
+#            python -m unittest discover
+#          fi
+#        shell: bash
+#      - name: Report coverage
+#        if: ${{ matrix.do-coverage && !failure() }}
+#        uses: codecov/codecov-action@v3.1.4
+#        with:
+#          token: ${{ secrets.CODECOV_TOKEN }}
+#          files: .coverage
+#          fail_ci_if_error: true
+#
+#  tests:
+#    needs: base-tests
+#    name: py${{ matrix.python }} - on ${{ matrix.os }}
+#    runs-on: ${{ matrix.os }}
+#
+#    strategy:
+#      fail-fast: false
+#      matrix:
+#        python: ['3.7', '3.8', '3.9', '3.10']
+#        os: [ubuntu-latest, macos-latest, windows-latest]
+#
+#        exclude:
+#          # these were done in base-tests
+#          - python: '3.10'
+#            os: ubuntu-latest
+#          - python: '3.7'
+#            os: ubuntu-latest
+#
+#    steps:
+#      - name: Checkout code
+#        uses: actions/checkout@v4
+#        with:
+#          fetch-depth: 0
+#      - name: Setup Python
+#        uses: actions/setup-python@v5
+#        with:
+#          python-version: ${{ matrix.python }}
+#      - name: Install 'bapsflib' dependencies
+#        run: python -m pip install -r requirements/tests.txt
+#      - name: Run tests
+#        run: |
+#            python -m unittest discover
+#        shell: bash
+#
+#  test-mins:
+#    # test min versions of key dependencies
+#    needs: tests
+#    name: Min Vers | py-${{ matrix.python }} | ${{ matrix.spec-name }}
+#    runs-on: ubuntu-latest
+#
+#    strategy:
+#      fail-fast: true
+#      matrix:
+#        include:
+#          - spec-name: h5py v3.0
+#            min-install: h5py==3.0
+#            python: '3.7'
+#
+#          - spec-name: h5py v3.0 numpy v1.20
+#            min-install: h5py==3.0 numpy==1.20
+#            python: '3.7'
+#
+#    steps:
+#      - name: Checkout code
+#        uses: actions/checkout@v4
+#        with:
+#          fetch-depth: 0
+#      - name: Setup Python
+#        uses: actions/setup-python@v5
+#        with:
+#          python-version: ${{ matrix.python }}
+#      - name: Install 'bapsflib' dependencies
+#        run: |
+#          python -m pip install -r requirements/tests.txt ${{ matrix.min-install }}
+#      - name: Run tests
+#        run: python -m unittest discover
+
+  import-bapsf_motion:
+    name: Importing bapsf_motion
+#    needs: base-tests
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: false
+      matrix:
+        python: [ '3.10', '3.11', '3.12' ]
+        os: [ubuntu-latest]
+        architecture: [x64]
+
+        include:
+          - python: '3.7'
+            os: windows-2019
+            architecture: x64
+
+          - python: '3.10'
+            os: windows-2019
+            architecture: x64
+
+          - python: '3.10'
+            os: windows-2019
+            architecture: x86
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python }}
+          architecture: ${{ matrix.architecture }}
+      - name: Install 'bapsf_motion' dependencies
+        if: ${{ matrix.architecture == 'x64' }}
+        run: |
+          python -m pip install -r requirements/gui.txt
+      - name: Install additional PySide6 dependencies [Linux Systems ONLY]
+        if: ${{ matrix.architecture == 'x64' && runner.os != 'Windows'}}
+        run: |
+          sudo apt update && sudo apt install -y libegl1-mesa-dev
+      - name: Install 'bapsf_motion' dependencies (32bit)
+        if: ${{ matrix.architecture == 'x86' }}
+        run: |
+          python -m pip install -r requirements/install-32bit.txt
+      - name: Import 'bapsf_motion'
+        run: |
+          python -c 'import bapsf_motion'
+      - name: Import 'bapsf_motion.gui'
+        if: ${{ matrix.architecture == 'x64' }}
+        run: |
+          python -c 'import bapsf_motion.gui'
+
+  build-bapsf_motion:
+    name: Packaging
+    runs-on: ubuntu-latest
+    needs:
+#      - test-mins
+      - import-bapsf_motion
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+      - name: Get history and tags for SCM versioning to work
+        run: |
+          git fetch --prune --unshallow
+          git fetch --depth=1 origin +refs/tags/*:refs/tags/*
+      - name: Set up Python 3.10
+        uses: actions/setup-python@v5
+        with:
+          python-version: '3.10'
+          cache: pip
+      - name: Install requirements
+        run: |
+          pip install --progress-bar off --upgrade pip setuptools setuptools_scm twine build
+          pip install --progress-bar off -r requirements/install.txt
+      - name: Build a binary wheel
+        run: |
+          python -m build --wheel --outdir dist/
+      - name: Build a source tarball
+        run: |
+          python -m build --sdist --outdir dist/
+      - name: Twine check
+        run: |
+          twine check dist/*
+      - name: Install bapsf_motion in all variants
+        run: |
+          pip install --progress-bar off .[install]
+          pip install --progress-bar off -e .[install]

bapsf_motion-0.2.0b1/.gitignore

@@ -0,0 +1,151 @@
+# LabView files
+# https://labviewwiki.org/wiki/ALIASES_File_Extension
+*.aliases
+# https://labviewwiki.org/wiki/LVLPS_File_Extension
+*.lvlps
+
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+*.a
+*.o
+*.so
+MANIFEST
+
+# Ignore .c files by default to avoid including generated code. If you want to
+# add a non-generated .c extension, use `git add -f filename.c`.
+*.c
+
+# Distribution / packaging
+.Python
+env/
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*,cover
+.hypothesis/
+.pytest_cache
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+docs/api
+docs/gen_modules
+
+# PyBuilder
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+notebooks_for_proto
+
+# pyenv
+.python-version
+
+# celery beat schedule file
+celerybeat-schedule
+
+# SageMath parsed files
+*.sage.py
+
+# dotenv
+.env
+
+# virtualenv
+.venvs
+.venv
+venv/
+venvs/
+ENV/
+
+# Spyder project settings
+.spyderproject
+
+# Rope project settings
+.ropeproject
+
+# VS code project settings
+.vscode
+
+# mkdocs documentation
+/site
+
+# Auxiliary files associated with emacs
+*#
+*~
+*.#
+.#*
+
+# Auxilliary files associated with vim
+*.swp
+VIRTUAL/
+
+# LaTeX and bibtex auxiliary files
+
+*.aux
+*.bbl
+*.blg
+
+# Miscellaneous files
+.idea/
+Untitled*
+untitled*
+*debuglog*
+.DS_Store
+*/cython_version.py
+.mypy_cache
+*.tmp
+
+# Documentation files
+auto_examples
+
+# Version file
+plasmapy/version.py
+tags
+docs/notebooks/*.md

bapsf_motion-0.2.0b1/.readthedocs.yml

@@ -0,0 +1,23 @@
+# Read the Docs configuration file
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html
+
+version: 2
+
+formats:
+- htmlzip
+
+build:
+  os: ubuntu-22.04
+  tools:
+    python: '3.10'
+  apt_packages:
+  - graphviz
+
+sphinx:
+  configuration: docs/conf.py
+
+python:
+  install:
+    - requirements: requirements.txt
+    - method: pip
+      path: .

bapsf_motion-0.2.0b1/PKG-INFO

@@ -0,0 +1,140 @@
+Metadata-Version: 2.1
+Name: bapsf_motion
+Version: 0.2.0b1
+Summary: Package for controlling motion devices in a BaPSF DAQ system
+Author: Basic Plasma Science Facility
+Keywords: plasma physics,plasma,science,bapsf,motion
+Classifier: Development Status :: 1 - Planning
+Classifier: Intended Audience :: Science/Research
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.7
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Topic :: Scientific/Engineering :: Physics
+Classifier: Topic :: Scientific/Engineering :: Astronomy
+Provides: bapsf_motion
+Requires-Python: >=3.7
+Description-Content-Type: text/markdown
+Requires-Dist: astropy
+Requires-Dist: importlib_metadata; python_version < "3.8"
+Requires-Dist: matplotlib>=3.3.0
+Requires-Dist: numpy>=1.18.1
+Requires-Dist: numpydoc
+Requires-Dist: tomli; python_version < "3.11"
+Requires-Dist: tomli_w
+Requires-Dist: tqdm
+Requires-Dist: xarray
+Provides-Extra: gui
+Requires-Dist: PySide6; python_version >= "3.10" and extra == "gui"
+Requires-Dist: PySide6<=6.3.1; python_version < "3.10" and extra == "gui"
+Requires-Dist: qtawesome; extra == "gui"
+Provides-Extra: tests
+Requires-Dist: pytest>=5.1; extra == "tests"
+Provides-Extra: 32bit
+Requires-Dist: pandas<=2.0.3; extra == "32bit"
+Provides-Extra: docs
+Requires-Dist: docutils>=0.18.1; extra == "docs"
+Requires-Dist: ipython; extra == "docs"
+Requires-Dist: jinja2>=3.1.2; extra == "docs"
+Requires-Dist: nbsphinx>=0.9.1; extra == "docs"
+Requires-Dist: numpydoc>=1.5.0; extra == "docs"
+Requires-Dist: pillow>=9.5.0; extra == "docs"
+Requires-Dist: pygments>=2.15.0; extra == "docs"
+Requires-Dist: sphinx>=6.1.3; extra == "docs"
+Requires-Dist: sphinx-changelog>=1.3.0; extra == "docs"
+Requires-Dist: sphinx-codeautolink>=0.15.0; extra == "docs"
+Requires-Dist: sphinx-copybutton>=0.5.1; extra == "docs"
+Requires-Dist: sphinx-gallery>=0.12.2; extra == "docs"
+Requires-Dist: sphinx-hoverxref>=1.1.1; extra == "docs"
+Requires-Dist: sphinx-issues>=3.0.1; extra == "docs"
+Requires-Dist: sphinx-notfound-page>=0.8.3; extra == "docs"
+Requires-Dist: sphinx-reredirects>=0.1.1; extra == "docs"
+Requires-Dist: sphinx_rtd_theme>=1.2.0; extra == "docs"
+Requires-Dist: sphinx_tabs>=3.4.1; extra == "docs"
+Requires-Dist: sphinxcontrib-bibtex>=2.5.0; extra == "docs"
+Requires-Dist: towncrier>=22.12; extra == "docs"
+Requires-Dist: tox>=4.4.0; extra == "docs"
+Requires-Dist: plasmapy_sphinx; extra == "docs"
+Provides-Extra: extras
+Requires-Dist: black; extra == "extras"
+Requires-Dist: isort; extra == "extras"
+Provides-Extra: developer
+Requires-Dist: PySide6; python_version >= "3.10" and extra == "developer"
+Requires-Dist: PySide6<=6.3.1; python_version < "3.10" and extra == "developer"
+Requires-Dist: qtawesome; extra == "developer"
+Requires-Dist: docutils>=0.18.1; extra == "developer"
+Requires-Dist: ipython; extra == "developer"
+Requires-Dist: jinja2>=3.1.2; extra == "developer"
+Requires-Dist: nbsphinx>=0.9.1; extra == "developer"
+Requires-Dist: numpydoc>=1.5.0; extra == "developer"
+Requires-Dist: pillow>=9.5.0; extra == "developer"
+Requires-Dist: pygments>=2.15.0; extra == "developer"
+Requires-Dist: sphinx>=6.1.3; extra == "developer"
+Requires-Dist: sphinx-changelog>=1.3.0; extra == "developer"
+Requires-Dist: sphinx-codeautolink>=0.15.0; extra == "developer"
+Requires-Dist: sphinx-copybutton>=0.5.1; extra == "developer"
+Requires-Dist: sphinx-gallery>=0.12.2; extra == "developer"
+Requires-Dist: sphinx-hoverxref>=1.1.1; extra == "developer"
+Requires-Dist: sphinx-issues>=3.0.1; extra == "developer"
+Requires-Dist: sphinx-notfound-page>=0.8.3; extra == "developer"
+Requires-Dist: sphinx-reredirects>=0.1.1; extra == "developer"
+Requires-Dist: sphinx_rtd_theme>=1.2.0; extra == "developer"
+Requires-Dist: sphinx_tabs>=3.4.1; extra == "developer"
+Requires-Dist: sphinxcontrib-bibtex>=2.5.0; extra == "developer"
+Requires-Dist: towncrier>=22.12; extra == "developer"
+Requires-Dist: tox>=4.4.0; extra == "developer"
+Requires-Dist: plasmapy_sphinx; extra == "developer"
+Requires-Dist: pytest>=5.1; extra == "developer"
+Requires-Dist: black; extra == "developer"
+Requires-Dist: isort; extra == "developer"
+
+# bapsf_motion
+
+[![Documentation Status](https://readthedocs.org/projects/bapsf-motion/badge/?version=latest)](https://bapsf-motion.readthedocs.io/en/latest/?badge=latest)
+
+``bapsf_motion`` is a module developed for the 
+[Basic Plasma Facility (BaPSF)](https://plasma.physics.ucla.edu/) at the
+University of California, Los Angeles to integrate with its DAQ system
+and control motion devices, such as probe drives.
+
+## GUI Development
+
+This package uses ``PySide6`` to develop its GUI interface.  In attempts
+to keep the code pythonic, we are using the feature
+[`from __feature__ import snake_case`](https://doc.qt.io/qtforpython/feature-why.html).
+This will allow us to write code like `QMainWindow.set_window_title()`
+instead of `QMainWindow.setWindowTitle()`.  To get a module set up the 
+`__feature__` import must occur after the first `PySide6` import, for
+example:
+
+```python
+from PySide6.QtWidgets import QMainWindow
+
+from __feature__ import snake_case  # noqa
+```
+
+Note the `# noqa`, this is needed to prevent linters and code inspection
+from complaining about the import order.
+
+When this is first implement your linters and code inspection will
+likely complain with unresolved instances.  This is because the
+[Python stub files](https://peps.python.org/pep-0484/#stub-files)
+(i.e. ``.pyi`` files) were generated without this feature enabled.  To
+update your stub files follow the procedure below:
+
+1. Determine where `PySide6` is installed.  This can be done by 
+   executing `python -m pip show pyside6` in the command prompt.  This
+   show be the `site-packages` directory for you Python distribution.
+2. Navigate to the directory indicated by step 1.
+3. Navigate into the `PySide6/` directory.
+4. Now execute the following command in your command prompt:
+
+   ```bash
+   pyside6-genpyi all --feature snake_case
+   ```
+   
+   This will update all the stub files accordingly, and should only take
+   a few seconds.

bapsf_motion-0.2.0b1/README.md

@@ -0,0 +1,47 @@
+# bapsf_motion
+
+[![Documentation Status](https://readthedocs.org/projects/bapsf-motion/badge/?version=latest)](https://bapsf-motion.readthedocs.io/en/latest/?badge=latest)
+
+``bapsf_motion`` is a module developed for the 
+[Basic Plasma Facility (BaPSF)](https://plasma.physics.ucla.edu/) at the
+University of California, Los Angeles to integrate with its DAQ system
+and control motion devices, such as probe drives.
+
+## GUI Development
+
+This package uses ``PySide6`` to develop its GUI interface.  In attempts
+to keep the code pythonic, we are using the feature
+[`from __feature__ import snake_case`](https://doc.qt.io/qtforpython/feature-why.html).
+This will allow us to write code like `QMainWindow.set_window_title()`
+instead of `QMainWindow.setWindowTitle()`.  To get a module set up the 
+`__feature__` import must occur after the first `PySide6` import, for
+example:
+
+```python
+from PySide6.QtWidgets import QMainWindow
+
+from __feature__ import snake_case  # noqa
+```
+
+Note the `# noqa`, this is needed to prevent linters and code inspection
+from complaining about the import order.
+
+When this is first implement your linters and code inspection will
+likely complain with unresolved instances.  This is because the
+[Python stub files](https://peps.python.org/pep-0484/#stub-files)
+(i.e. ``.pyi`` files) were generated without this feature enabled.  To
+update your stub files follow the procedure below:
+
+1. Determine where `PySide6` is installed.  This can be done by 
+   executing `python -m pip show pyside6` in the command prompt.  This
+   show be the `site-packages` directory for you Python distribution.
+2. Navigate to the directory indicated by step 1.
+3. Navigate into the `PySide6/` directory.
+4. Now execute the following command in your command prompt:
+
+   ```bash
+   pyside6-genpyi all --feature snake_case
+   ```
+   
+   This will update all the stub files accordingly, and should only take
+   a few seconds.