https://github.com/llnl/cyme-launcher
Utility to help run CYME on HPC
https://github.com/llnl/cyme-launcher
cyme energy go hpc launcher simulation utility
Last synced: 8 months ago
JSON representation
Utility to help run CYME on HPC
- Host: GitHub
- URL: https://github.com/llnl/cyme-launcher
- Owner: LLNL
- License: bsd-3-clause
- Created: 2021-10-11T22:18:43.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2022-08-18T19:08:30.000Z (almost 4 years ago)
- Last Synced: 2025-04-12T05:03:19.076Z (about 1 year ago)
- Topics: cyme, energy, go, hpc, launcher, simulation, utility
- Language: Go
- Homepage:
- Size: 16.6 KB
- Stars: 0
- Watchers: 4
- Forks: 0
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: .github/CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# cyme-launcher
cyme-launcher helps with starting up one or more instances of CYME using WINE
on Linux, in a way that works with HPC clusters. It makes sure that a license
manager with available licenses is running, and handles the arguments needed
by WINE to launch the CYME gui, as well as run Python scripts using cympy.
## Pre-requisites
To use cyme-launcher you must own a CYME license and install it using WINE
on the system you will be using. You will also need to have installed the
Sentinel LDK Run-time Environment for Linux.
This utility was tested with CYME 8.x, wine 32-bit 3.0.x, and the Sentinel LDK
RTE 7.x; pull requests with any fixes required for newer versions are greatly
appreciated.
## Installation
Use `go build cyme-launcher` to compile a self-contained executable. Or use
`go run cyme-launcher.go` to run the launcher as if it were a script. X forwarding
must be enabled to run CYME from an SSH session (or a virtual X11 framebuffer
server should be used, such as using `xvfb-run` to run `cyme-launcher`).
## Usage
The following options are supported for setting up paths:
```
-cymepath string
path to the cyme installation (default "C:\\Program Files\\CYME\\CYME")
-hasplmpath string
the path to the hasplm daemon (default "/usr/workspace/wsb/cyme/sentinel_lm")
-hasplmserver string
remote hasplm server to use (default "localhost")
-python string
python script to run
-winepath string
the root path where wine is installed
-wineprefix string
the wine prefix to use (default "/usr/workspace/wsb/cyme/wine32_prefix")
```
## Contributing
Pull requests are welcome. For major changes, please open an issue first
to discuss what you would like to change.
## License
cyme-launcher is distributed under the terms of the BSD-3 clause license.
All new contributions must be made under this license. [LICENSE](LICENSE)
SPDX-License-Identifier: BSD-3-Clause
LLNL-CODE-827749