multipac-testbench


Namemultipac-testbench JSON
Version 1.8.2 PyPI version JSON
download
home_pageNone
SummaryPost-treat the data produced by the MULTIPAC test bench.
upload_time2025-08-01 16:07:39
maintainerNone
docs_urlNone
authorNone
requires_python>=3.11
licenseNone
keywords post treatment multipactor
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # MULTIPAC testbench
This library is designed to post-treat the data from the MULTIPAC multipactor test bench at LPSC, Grenoble, France.

## Installation

### Users
1. Create a dedicated Python environment, activate it.
2. Run `pip install multipac_testbench`

> [!NOTE]
> If you are completely new to Python and these instructions are unclear, check [this tutorial](https://python-guide.readthedocs.io/en/latest/).
> In particular, you will want to:
> 1. [Install Python](https://python-guide.readthedocs.io/en/latest/starting/installation/) 3.11 or higher.
> 2. [Learn to use Python environments](https://python-guide.readthedocs.io/en/latest/dev/virtualenvs/), `pipenv` or `virtualenv`.
> 3. [Install a Python IDE](https://python-guide.readthedocs.io/en/latest/dev/env/#ides) such as Spyder or VSCode.

### Developers
1. Clone the repository:
`git clone git@github.com:AdrienPlacais/multipac_testbench.git`
2. Create a dedicated Python environment, activate it.
3. Navigate to the main `multipac_testbench` folder and install the library with all dependencies: `pip install -e .`

Note that you will need Python 3.11 or higher to use the library.

If you want to use `conda`, you must manually install the required packages defined in `pyproject.toml`.
Then, add `multipac_testbench.src` to your `$PYTHONPATH` environment variable.

## Project info

- ๐Ÿ“š [Documentation](https://multipac-testbench.readthedocs.io/en/stable/)
- ๐Ÿ“‹ [Changelog](./CHANGELOG.md)
- ๐Ÿค [Contributing](./CONTRIBUTING.md)
- ๐Ÿš€ [Tutorials/examples](https://multipac-testbench.readthedocs.io/en/stable/manual/tutorials.html)

TODO:
- [ ] Add notebook execution to normal test workflow.
  - [ ] Add jupyter installation to `pip` deps for test

## Future updates

- [X] Calibration of new field probes.
- [X] Implementation of Retarding Field Analyzer.
    - [X] RPA grid in V instead of kV.
- [ ] `sweet_plot` updates for better RPA treatment:
    - [ ] Allow for `head` argument, working similarly to `tail`.
    - [X] Argument to plot increasing and decreasing values differently. Useful when plotting RPA current against RPA grid voltage.
- [ ] Option to plot maximum of a signal per power cycle.
- [ ] Bug fix: Upper threshold is given even when we did not exit the multipactor zone.
- [X] Adding a post-treater to `Power` instruments should be reflected in `SWR` and `ReflectionCoefficient` calculations.

## Labviewer to-do
- [ ] Automatic export binary -> xlsx or csv
- [ ] Automatic export of individual power step files
- [ ] Allow to take last value from individual power step file rather than highest
- [ ] Fix synxhro of dBm column

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "multipac-testbench",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.11",
    "maintainer_email": null,
    "keywords": "post treatment, multipactor",
    "author": null,
    "author_email": "Adrien Pla\u00e7ais <placais@lpsc.in2p3.fr>",
    "download_url": "https://files.pythonhosted.org/packages/b4/89/fc64675552d51b9574d1cd51c1e27ba2cd76263ac897b08b2535746c6872/multipac_testbench-1.8.2.tar.gz",
    "platform": null,
    "description": "# MULTIPAC testbench\nThis library is designed to post-treat the data from the MULTIPAC multipactor test bench at LPSC, Grenoble, France.\n\n## Installation\n\n### Users\n1. Create a dedicated Python environment, activate it.\n2. Run `pip install multipac_testbench`\n\n> [!NOTE]\n> If you are completely new to Python and these instructions are unclear, check [this tutorial](https://python-guide.readthedocs.io/en/latest/).\n> In particular, you will want to:\n> 1. [Install Python](https://python-guide.readthedocs.io/en/latest/starting/installation/) 3.11 or higher.\n> 2. [Learn to use Python environments](https://python-guide.readthedocs.io/en/latest/dev/virtualenvs/), `pipenv` or `virtualenv`.\n> 3. [Install a Python IDE](https://python-guide.readthedocs.io/en/latest/dev/env/#ides) such as Spyder or VSCode.\n\n### Developers\n1. Clone the repository:\n`git clone git@github.com:AdrienPlacais/multipac_testbench.git`\n2. Create a dedicated Python environment, activate it.\n3. Navigate to the main `multipac_testbench` folder and install the library with all dependencies: `pip install -e .`\n\nNote that you will need Python 3.11 or higher to use the library.\n\nIf you want to use `conda`, you must manually install the required packages defined in `pyproject.toml`.\nThen, add `multipac_testbench.src` to your `$PYTHONPATH` environment variable.\n\n## Project info\n\n- \ud83d\udcda [Documentation](https://multipac-testbench.readthedocs.io/en/stable/)\n- \ud83d\udccb [Changelog](./CHANGELOG.md)\n- \ud83e\udd1d [Contributing](./CONTRIBUTING.md)\n- \ud83d\ude80 [Tutorials/examples](https://multipac-testbench.readthedocs.io/en/stable/manual/tutorials.html)\n\nTODO:\n- [ ] Add notebook execution to normal test workflow.\n  - [ ] Add jupyter installation to `pip` deps for test\n\n## Future updates\n\n- [X] Calibration of new field probes.\n- [X] Implementation of Retarding Field Analyzer.\n    - [X] RPA grid in V instead of kV.\n- [ ] `sweet_plot` updates for better RPA treatment:\n    - [ ] Allow for `head` argument, working similarly to `tail`.\n    - [X] Argument to plot increasing and decreasing values differently. Useful when plotting RPA current against RPA grid voltage.\n- [ ] Option to plot maximum of a signal per power cycle.\n- [ ] Bug fix: Upper threshold is given even when we did not exit the multipactor zone.\n- [X] Adding a post-treater to `Power` instruments should be reflected in `SWR` and `ReflectionCoefficient` calculations.\n\n## Labviewer to-do\n- [ ] Automatic export binary -> xlsx or csv\n- [ ] Automatic export of individual power step files\n- [ ] Allow to take last value from individual power step file rather than highest\n- [ ] Fix synxhro of dBm column\n",
    "bugtrack_url": null,
    "license": null,
    "summary": "Post-treat the data produced by the MULTIPAC test bench.",
    "version": "1.8.2",
    "project_urls": {
        "Documentation": "https://adrienplacais.github.io/multipac_testbench/html/index.html",
        "Homepage": "https://github.com/AdrienPlacais/multipac_testbench"
    },
    "split_keywords": [
        "post treatment",
        " multipactor"
    ],
    "urls": [
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "a3a42c48f215cef9d4904dfb0dd82040bf307445d1cae69bde98f658422ce96e",
                "md5": "dc02070d0d66572a0ebfaa95f9517167",
                "sha256": "dfd1a1c6d6e2e5f9f96b313311be7b104a3722efa8dcdfae90f76d74e1b5f1c0"
            },
            "downloads": -1,
            "filename": "multipac_testbench-1.8.2-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "dc02070d0d66572a0ebfaa95f9517167",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.11",
            "size": 2610550,
            "upload_time": "2025-08-01T16:07:35",
            "upload_time_iso_8601": "2025-08-01T16:07:35.354509Z",
            "url": "https://files.pythonhosted.org/packages/a3/a4/2c48f215cef9d4904dfb0dd82040bf307445d1cae69bde98f658422ce96e/multipac_testbench-1.8.2-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "b489fc64675552d51b9574d1cd51c1e27ba2cd76263ac897b08b2535746c6872",
                "md5": "e517087ae46e9feb7e5fa32e5a5fb615",
                "sha256": "b21a8c0486fadae70a834485621cb0bc0a14f00c899fc952191b098483e837f7"
            },
            "downloads": -1,
            "filename": "multipac_testbench-1.8.2.tar.gz",
            "has_sig": false,
            "md5_digest": "e517087ae46e9feb7e5fa32e5a5fb615",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.11",
            "size": 27403850,
            "upload_time": "2025-08-01T16:07:39",
            "upload_time_iso_8601": "2025-08-01T16:07:39.889483Z",
            "url": "https://files.pythonhosted.org/packages/b4/89/fc64675552d51b9574d1cd51c1e27ba2cd76263ac897b08b2535746c6872/multipac_testbench-1.8.2.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2025-08-01 16:07:39",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "AdrienPlacais",
    "github_project": "multipac_testbench",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "multipac-testbench"
}
        
Elapsed time: 1.94911s