# EPICS AppImage
This project is intended to provide prebuilt EPICS base tools in the form
of AppImages for the end-users, for those who usually do not need to have the full
EPICS base built. Tools like ``softIoc``, ``caget``, ``caput``, ``cainfo``,
``camonitor``, ``softIocPVA``, ``pvget``, ``pvput``, ``pvinfo``,
``pvmonitor``, etc. could be used in the command line interface. More tools
will be included in future releases.
## User Guide
### Installation
On an x86_64 machine, type in the Terminal with ``pip install epics-appimage`` to install the package.
Alternatively, each AppImage can also be downloaded from the release page,
``chmod +x <AppImage>`` and run it. If only one AppImage is needed, download
``epics-base-tools-x86_64.AppImage``.
### Run
Typical EPICS base tools could be invoked by just typing the name in the
Terminal, e.g. ``softIoc``, ``caget``, ``caput``, etc.
One special command called ``epics-base-tools`` is built to be used as the
entry point for all the packaged tools, all packaged tools are sharing the
same libraries, thus this single AppImage is way more compact.
Type ``epics-base-tools`` in the Terminal will output the usage message:
```bash
Missing the app name!
Usage: epics-base-tools-x86_64.AppImage -i -l -h app-name
Run the deployed EPICS base tools.
Available options:
-i, --info EPICS base version
-l, --list All available EPICS base tools
app-name Name of one of the deployed tools
-h, --help Print this help and exit
-v, --verbose Print script debug info
Examples:
# use caget tool
epics-base-tools-x86_64.AppImage caget
# create an alias for caget
alias caget="epics-base-tools-x86_64.AppImage caget"
```
``epics-base-tools softIoc`` is equivalent as ``softIoc``, the same applies to other tools.
``--list`` or ``-l`` option lists all packaged EPICS base tools, e.g.:
``epics-base-tools -l`` outputs:
```bash
(26) apps are available:
acctst antelope ascheck caConnTest caEventRate caget cainfo camonitor caput caRepeater casw ca_test catime e_flex iocLogServer makeBpt msi p2p pvcall pvget pvinfo pvlist pvmonitor pvput softIoc softIocPVA
```
## Build AppImages from EPICS base
In the Terminal, run: ``make bootstrap | tee -a log``, edit `bootstrap.sh` as needed.
Raw data
{
"_id": null,
"home_page": "https://github.com/archman/epics-appimage",
"name": "epics-appimage",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": null,
"author": "Tong Zhang",
"author_email": "zhangt@frib.msu.edu",
"download_url": "https://pypi.org/project/epics-appimage",
"platform": null,
"description": "# EPICS AppImage\n\nThis project is intended to provide prebuilt EPICS base tools in the form\nof AppImages for the end-users, for those who usually do not need to have the full\nEPICS base built. Tools like ``softIoc``, ``caget``, ``caput``, ``cainfo``,\n``camonitor``, ``softIocPVA``, ``pvget``, ``pvput``, ``pvinfo``,\n``pvmonitor``, etc. could be used in the command line interface. More tools\nwill be included in future releases.\n\n## User Guide\n\n### Installation\nOn an x86_64 machine, type in the Terminal with ``pip install epics-appimage`` to install the package.\n\nAlternatively, each AppImage can also be downloaded from the release page,\n``chmod +x <AppImage>`` and run it. If only one AppImage is needed, download\n``epics-base-tools-x86_64.AppImage``.\n\n### Run\nTypical EPICS base tools could be invoked by just typing the name in the\nTerminal, e.g. ``softIoc``, ``caget``, ``caput``, etc.\n\nOne special command called ``epics-base-tools`` is built to be used as the\nentry point for all the packaged tools, all packaged tools are sharing the\nsame libraries, thus this single AppImage is way more compact.\n\nType ``epics-base-tools`` in the Terminal will output the usage message:\n```bash\nMissing the app name!\nUsage: epics-base-tools-x86_64.AppImage -i -l -h app-name\n\nRun the deployed EPICS base tools.\n\nAvailable options:\n\n -i, --info EPICS base version\n -l, --list All available EPICS base tools\n app-name Name of one of the deployed tools\n -h, --help Print this help and exit\n -v, --verbose Print script debug info\n\nExamples:\n # use caget tool\n epics-base-tools-x86_64.AppImage caget\n # create an alias for caget\n alias caget=\"epics-base-tools-x86_64.AppImage caget\"\n```\n\n``epics-base-tools softIoc`` is equivalent as ``softIoc``, the same applies to other tools.\n\n``--list`` or ``-l`` option lists all packaged EPICS base tools, e.g.:\n``epics-base-tools -l`` outputs:\n```bash\n(26) apps are available:\n\nacctst antelope ascheck caConnTest caEventRate caget cainfo camonitor caput caRepeater casw ca_test catime e_flex iocLogServer makeBpt msi p2p pvcall pvget pvinfo pvlist pvmonitor pvput softIoc softIocPVA\n\n```\n\n## Build AppImages from EPICS base\nIn the Terminal, run: ``make bootstrap | tee -a log``, edit `bootstrap.sh` as needed.\n\n\n",
"bugtrack_url": null,
"license": "GPLv3",
"summary": "AppImages built from EPICS base",
"version": "7.0.8.1",
"project_urls": {
"Download": "https://pypi.org/project/epics-appimage",
"Homepage": "https://github.com/archman/epics-appimage"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "1ac711c15e90321e313f2e13679d5772792d5eb7b2326b957a3c764c27b2cd59",
"md5": "c08ae3c7b78d276a5732b4ba51634d3f",
"sha256": "485084f281bf3622ab1fbabe6cbe83836f9494be43142459de7e171f456c6427"
},
"downloads": -1,
"filename": "epics_appimage-7.0.8.1-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "c08ae3c7b78d276a5732b4ba51634d3f",
"packagetype": "bdist_wheel",
"python_version": "py2.py3",
"requires_python": null,
"size": 3000814,
"upload_time": "2024-08-14T17:52:23",
"upload_time_iso_8601": "2024-08-14T17:52:23.434078Z",
"url": "https://files.pythonhosted.org/packages/1a/c7/11c15e90321e313f2e13679d5772792d5eb7b2326b957a3c764c27b2cd59/epics_appimage-7.0.8.1-py2.py3-none-any.whl",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-08-14 17:52:23",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "archman",
"github_project": "epics-appimage",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "epics-appimage"
}
JSON
