|
1 | 1 | The extension allows users to update PyAEDT and PyEDB through GUI |
2 | 2 | ----------------------------------------------------------------- |
3 | 3 |
|
4 | | -.. image:: ../../../_static/extensions/version_manager.png |
| 4 | +.. image:: ../../../_static/extensions/version_manager_basic.png |
5 | 5 | :width: 800 |
6 | | - :alt: Version manager |
7 | | - |
8 | | ----------- |
9 | | -Features |
10 | | ----------- |
11 | | - |
12 | | -- Show Python virtual environment path |
13 | | -- Show Python version |
14 | | -- Show the current PyAEDT and PyEDB versions |
15 | | -- Show the latest PyAEDT and PyEDB release available on PyPI |
16 | | -- Update PyAEDT and PyEDB to the latest version on PyPI |
17 | | -- Install PyAEDT and PyEDB with a branch available on Github |
18 | | - - By default the main development branch is used |
19 | | - - Other existing branch names can be provided |
20 | | -- Update PyAEDT and PyEDB from wheelhouse |
21 | | - - Check compatibility |
22 | | -- Reset and update PyAEDT buttons in AEDT |
| 6 | + :alt: Version manager basic |
| 7 | + |
| 8 | +.. image:: ../../../_static/extensions/version_manager_advanced.png |
| 9 | + :width: 800 |
| 10 | + :alt: Version manager advanced |
| 11 | + |
| 12 | +Overview |
| 13 | +======== |
| 14 | +A lightweight panel to view your Python environment and manage the two core |
| 15 | +packages: ``pyaedt`` and ``pyedb``. It lets you see what is installed, compare |
| 16 | +with the latest PyPI releases, update (or downgrade to the latest official |
| 17 | +release), install from a Git branch, or install from a wheelhouse ZIP. |
| 18 | + |
| 19 | +Main actions |
| 20 | +============ |
| 21 | +- Show virtual environment path and Python version |
| 22 | +- Show installed and latest PyPI versions of ``pyaedt`` and ``pyedb`` |
| 23 | +- Update one or both packages (Update / Update All) |
| 24 | +- Install a package from a Git branch |
| 25 | +- Install ``pyaedt`` from a validated wheelhouse ZIP |
| 26 | +- Reset PyAEDT buttons inside AEDT |
| 27 | +- Open help page (Help button) |
| 28 | + |
| 29 | +Tabs |
| 30 | +==== |
| 31 | +Basic: Versions, Update buttons, Update All, Wheelhouse install. |
| 32 | + |
| 33 | +Advanced: Git branch install fields and Reset AEDT panels. |
| 34 | + |
| 35 | +Quick: Install from Git branch |
| 36 | +============================== |
| 37 | +1. Go to Advanced tab. |
| 38 | +2. Enter branch name (default is ``main``). |
| 39 | +3. Click Get Branch and confirm. |
| 40 | + |
| 41 | +Quick: Update from wheelhouse |
| 42 | +============================= |
| 43 | +1. Click Update from wheelhouse (Basic tab). |
| 44 | +2. Pick the wheelhouse ZIP. |
| 45 | +3. If compatible, it installs new ``pyaedt[all]`` and refreshes the panels. |
| 46 | + |
| 47 | +Notes |
| 48 | +===== |
| 49 | +- Uses ``uv pip`` when available; falls back to ``python -m pip`` automatically. |
| 50 | +- Git must be on PATH for branch installs. |
| 51 | +- Wheelhouse ZIP must match Python version and OS. |
| 52 | +- A downgrade occurs only if your installed version is newer than the latest |
| 53 | + release on PyPI. |
| 54 | + |
| 55 | +Troubleshooting |
| 56 | +=============== |
| 57 | +- Missing buttons after update: Reset AEDT panels (Advanced tab). |
| 58 | +- PyPI lookup fails: check network / proxy and retry. |
| 59 | +- Git branch install fails: verify branch name and that Git is installed. |
| 60 | +- Wheelhouse rejected: confirm Python version and OS match. |
| 61 | + |
| 62 | +Disclaimer |
| 63 | +========== |
| 64 | +A confirmation dialog appears before any install or update involving |
| 65 | +third-party/open-source software. Proceed only if you accept the terms. |
0 commit comments