bapsf-motion


Namebapsf-motion JSON
Version 0.2.0b1 PyPI version JSON
download
home_page
SummaryPackage for controlling motion devices in a BaPSF DAQ system
upload_time2024-02-27 03:49:10
maintainer
docs_urlNone
authorBasic Plasma Science Facility
requires_python>=3.7
license
keywords plasma physics plasma science bapsf motion
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # 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.

            

Raw data

            {
    "_id": null,
    "home_page": "",
    "name": "bapsf-motion",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.7",
    "maintainer_email": "",
    "keywords": "plasma physics,plasma,science,bapsf,motion",
    "author": "Basic Plasma Science Facility",
    "author_email": "",
    "download_url": "https://files.pythonhosted.org/packages/c2/b2/e3bc4403cbd35b58821951ab5271cfc6fb017ba8e0c9cf541f4acfa0cbd2/bapsf_motion-0.2.0b1.tar.gz",
    "platform": null,
    "description": "# bapsf_motion\n\n[![Documentation Status](https://readthedocs.org/projects/bapsf-motion/badge/?version=latest)](https://bapsf-motion.readthedocs.io/en/latest/?badge=latest)\n\n``bapsf_motion`` is a module developed for the \n[Basic Plasma Facility (BaPSF)](https://plasma.physics.ucla.edu/) at the\nUniversity of California, Los Angeles to integrate with its DAQ system\nand control motion devices, such as probe drives.\n\n## GUI Development\n\nThis package uses ``PySide6`` to develop its GUI interface.  In attempts\nto keep the code pythonic, we are using the feature\n[`from __feature__ import snake_case`](https://doc.qt.io/qtforpython/feature-why.html).\nThis will allow us to write code like `QMainWindow.set_window_title()`\ninstead of `QMainWindow.setWindowTitle()`.  To get a module set up the \n`__feature__` import must occur after the first `PySide6` import, for\nexample:\n\n```python\nfrom PySide6.QtWidgets import QMainWindow\n\nfrom __feature__ import snake_case  # noqa\n```\n\nNote the `# noqa`, this is needed to prevent linters and code inspection\nfrom complaining about the import order.\n\nWhen this is first implement your linters and code inspection will\nlikely complain with unresolved instances.  This is because the\n[Python stub files](https://peps.python.org/pep-0484/#stub-files)\n(i.e. ``.pyi`` files) were generated without this feature enabled.  To\nupdate your stub files follow the procedure below:\n\n1. Determine where `PySide6` is installed.  This can be done by \n   executing `python -m pip show pyside6` in the command prompt.  This\n   show be the `site-packages` directory for you Python distribution.\n2. Navigate to the directory indicated by step 1.\n3. Navigate into the `PySide6/` directory.\n4. Now execute the following command in your command prompt:\n\n   ```bash\n   pyside6-genpyi all --feature snake_case\n   ```\n   \n   This will update all the stub files accordingly, and should only take\n   a few seconds.\n",
    "bugtrack_url": null,
    "license": "",
    "summary": "Package for controlling motion devices in a BaPSF DAQ system",
    "version": "0.2.0b1",
    "project_urls": null,
    "split_keywords": [
        "plasma physics",
        "plasma",
        "science",
        "bapsf",
        "motion"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "fa71737af5d78d0b17a8dd42419053fab86bd06fcb0cc191372f0f07689183b8",
                "md5": "7d0573c72678f3a031ba9b51b299ade8",
                "sha256": "2a414e8848342276ced251e637d25bf834b0ef12d07386faa8a39fc81569e5b5"
            },
            "downloads": -1,
            "filename": "bapsf_motion-0.2.0b1-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "7d0573c72678f3a031ba9b51b299ade8",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.7",
            "size": 112521,
            "upload_time": "2024-02-27T03:49:08",
            "upload_time_iso_8601": "2024-02-27T03:49:08.364373Z",
            "url": "https://files.pythonhosted.org/packages/fa/71/737af5d78d0b17a8dd42419053fab86bd06fcb0cc191372f0f07689183b8/bapsf_motion-0.2.0b1-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "c2b2e3bc4403cbd35b58821951ab5271cfc6fb017ba8e0c9cf541f4acfa0cbd2",
                "md5": "2cbd2723bc51035ce3b36c69b7405ffa",
                "sha256": "fc035d999809466ec26da0b0892357d9580fb9207410d891cf67a2ee8e3218ec"
            },
            "downloads": -1,
            "filename": "bapsf_motion-0.2.0b1.tar.gz",
            "has_sig": false,
            "md5_digest": "2cbd2723bc51035ce3b36c69b7405ffa",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.7",
            "size": 850511,
            "upload_time": "2024-02-27T03:49:10",
            "upload_time_iso_8601": "2024-02-27T03:49:10.199004Z",
            "url": "https://files.pythonhosted.org/packages/c2/b2/e3bc4403cbd35b58821951ab5271cfc6fb017ba8e0c9cf541f4acfa0cbd2/bapsf_motion-0.2.0b1.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-02-27 03:49:10",
    "github": false,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "lcname": "bapsf-motion"
}
        
Elapsed time: 0.18642s