Hesuan (Phynexis) v0 CLI
The phynexis-v0 command line runs simulations and handles license
activation. Install it with the v0 installer: the CLI wheel
is public, and upgrade downloads the prefix after activation. v1 uses
phynexis-v1 the same way, then source /opt/phynexis-v1/etc/bashrc.
Commands
| Command | Purpose |
|---|---|
install <archive> | Install a native pack (--prefix to choose the root) |
upgrade [version] | Update the CLI wheel and download the licensed prefix |
prefix | Print the install root (default /opt/phynexis) |
run [-np N] <cmd> | Run a command with the phynexis environment |
shell [dir] | Interactive shell (OpenFOAM + phynexis env) |
| `python <script | -c>` |
job <sub> | Background tasks (submit/status/log/kill/prune) |
paraview <sub> | ParaView pvserver lifecycle (server/version/connect) |
license <sub> | Manage the license (status/activate/deactivate) |
completion bash|zsh | Install tab completion |
Run phynexis-v0 help for the full usage.
Examples
Install the CLI, then download the prefix:
curl -fsSL https://download.xiaohe.team/phynexis-v0/install.sh | bash
phynexis-v0 license activate <license-key>
phynexis-v0 upgrade
source /opt/phynexis/etc/bashrc
Run a simulation script:
phynexis-v0 run python3 examples/00_random_packing/1_gjk_solver.py
phynexis-v0 run -np 4 python3 examples/cfddem/case.py
Start an interactive shell with the OpenFOAM + phynexis environment:
phynexis-v0 shell .
Run Python with the netdem module:
phynexis-v0 python -c "import netdem; print(netdem.__version__)"
Submit a background job:
phynexis-v0 job submit python3 examples/00_random_packing/1_gjk_solver.py
phynexis-v0 job status
Background jobs
phynexis-v0 job manages long-running simulations in the background (backed
by a user-level pueue daemon, so tasks survive ssh disconnects).
| Subcommand | Purpose |
|---|---|
submit [-np N] <cmd> | Run a command in the background |
status [id] | List tasks (queued / running / success / failed) |
log [id] | Show task output (default: latest) |
kill <id> | Stop a running task |
remove <id> | Remove a queued task |
prune | Drop finished tasks from the queue |
setup [--install] | Init the pueue daemon |
phynexis-v0 job submit -np 4 python3 examples/00_random_packing/1_gjk_solver.py
phynexis-v0 job status
phynexis-v0 job log 3
Tasks run in a clean runtime env: PATH is frozen at submit time, and
PYTHONPATH/LD_LIBRARY_PATH come from the sourced bashrc — export extra
paths inside the submitted command if needed.
ParaView server
phynexis-v0 paraview manages a ParaView pvserver for remote visualization.
| Subcommand | Purpose |
|---|---|
server start [--port N] [-np N] [--offscreen] | Start pvserver in the background |
server stop | Stop the pvserver |
server status | State + cs:// connect URL |
server restart [...] | Stop then start |
version | pvserver path + version |
connect [--port N] | Show how a client connects |
phynexis-v0 paraview server start
phynexis-v0 paraview server status
phynexis-v0 paraview connect
From a client machine: phynexis-v0 paraview connect --host <server> shows the
cs:// URL to open in ParaView.
License
Running the solver requires an activated license:
phynexis-v0 license activate <license-key>
phynexis-v0 license status
Get a license from Xiaohe Accounts. The full CLI reference lives on the technical site.