Overview
This repository provides pfcon – a controlling service that speaks to remote pman and pfioh services.
pfcon
Most simply, pfcon pushes local data to a remote location (by talking to a remote pfioh service), runs some process on this data in the remote space using pman, and then copies the resultant data back to a local target space.
It can be used to query and control the following (for example):
state: Is job <XYZ> still running?
result: What is the stdout (or stderr) from job <XYZ>?
control: Kill job <XYZ>
Installation
Installation is relatively straightforward, and we recommend using either python virtual environments or docker.
Python Virtual Environment
On Ubuntu, install the Python virtual environment creator
sudo apt install virtualenvThen, create a directory for your virtual environments e.g.:
mkdir ~/python-envsYou might want to add to your .bashrc file these two lines:
export WORKON_HOME=~/python-envs
source /usr/local/bin/virtualenvwrapper.shThen you can source your .bashrc and create a new Python3 virtual environment:
source .bashrc
mkvirtualenv --python=python3 python_envTo activate or “enter” the virtual env:
workon python_envTo deactivate virtual env:
deactivateUsing the fnndsc/pfcon dock
The easiest option however, is to just use the fnndsc/pfcon dock.
docker pull fnndsc/pfconand then run
docker run --name pfcon -v /home:/Users --rm -ti fnndsc/pfcon --forever --httpResponseUsage
For usage of pfcon, consult the relevant wiki pages.
pfcon usage
For pfcon detailed information, see the pfcon wiki page.
[--ip <IP>]
The IP interface on which to listen. Default %s.
[--port <port>]
The port on which to listen. Defaults to '5055'.
[--man <manpage>]
Internal man page with more detail on specific calls.
[--forever]
Start service and do not terminate.
[--httpResponse]
Send return strings as HTTP formatted replies with content-type html.
[--cordBlockSeconds <blockSeconds>]
The number of seconds to block/wait internally in the coordination loop.
This is the time between ``pfioh`` has indicated successful unpack of file
data and the call to ``pman`` to start processing.
[--configFileLoad <file>]
Load configuration information from the JSON formatted <file>.
[--configFileSave <file>]
Save configuration information to the JSON formatted <file>.
[-x|--desc]
Provide an overview help page.
[-y|--synopsis]
Provide a synopsis help summary.
[--version]
Print internal version number and exit.
[--debugToDir <dir>]
A directory to contain various debugging output -- these are typically
JSON object strings capturing internal state. If empty string (default)
then no debugging outputs are captured/generated. If specified, then
``pfcon`` will check for dir existence and attempt to create if
needed.
[-v|--verbosity <level>]
Set the verbosity level. "0" typically means no/minimal output. Allows for
more fine tuned output control as opposed to '--quiet' that effectively
silences everything.EXAMPLES
Start pfcon in forever mode:
pfcon \\
--forever \\
--port 5005 \\
--httpResponse \\
--verbosity 1 \\
--debugToDir /tmp \\
--ip 127.0.0.11 maintainer
Metadata
1 maintainer
Release files for pfcon 2.2.4.6
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| pfcon-2.2.4.6.tar.gz | 25.1 kB | Details |
Release files / pfcon-2.2.4.6.tar.gz
| Download URL | pfcon-2.2.4.6.tar.gz |
|---|---|
| Size | 25.1 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
c063aac8fee6e1fc41696fc83066ae5931fe8ac91b5161ae6b2ed57927f57ebf
|
|
BLAKE2b-256 checksum How to use checksums |
2a9fced8eb162066568fbd0b8c1c07d609aa483eaea9b24dd7111a99984a8b8d
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/3.2.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/49.2.0 requests-toolbelt/0.9.1 tqdm/4.48.0 CPython/3.8.2
|
