Metadata-Version: 2.1
Name: remotemanager
Version: 0.11.5
Summary: remote run management tool
Author-email: Louis Beal <louis.j.beal@gmail.com>
Classifier: Programming Language :: Python :: 3.9
Classifier: Operating System :: OS Independent
Requires-Python: >=3.7
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: pyyaml
Requires-Dist: requests
Provides-Extra: dill
Requires-Dist: dill; extra == "dill"
Provides-Extra: jsonpickle
Requires-Dist: jsonpickle; extra == "jsonpickle"
Provides-Extra: all
Requires-Dist: dill; extra == "all"
Requires-Dist: jsonpickle; extra == "all"
Provides-Extra: docs
Requires-Dist: nbsphinx; extra == "docs"
Requires-Dist: sphinx-rtd-theme; extra == "docs"
Requires-Dist: furo; extra == "docs"
Provides-Extra: dev
Requires-Dist: dill; extra == "dev"
Requires-Dist: jsonpickle; extra == "dev"
Requires-Dist: sphinx; extra == "dev"
Requires-Dist: nbsphinx; extra == "dev"
Requires-Dist: sphinx-rtd-theme; extra == "dev"
Requires-Dist: pytest; extra == "dev"
Requires-Dist: pytest-cov; extra == "dev"
Requires-Dist: nbval; extra == "dev"
Requires-Dist: bumpver; extra == "dev"
Requires-Dist: numpy; extra == "dev"
Requires-Dist: flake8; extra == "dev"
Requires-Dist: furo; extra == "dev"

# remotemanager

Modular serialisation and management package for handling the running of functions on remote machines

Based off of the BigDFT RemoteRunner concept, remotemanager represents an improvement and expansion on the concepts based there.

Primary usage is via a `Dataset`, which connects to a remote machine via `URL`

You can think of the `Dataset` as a "container" of sorts for a calculation, to which "runs" are attached. These runs are then executed on the remote machine described by the provided `URL`

### Installation

A quick install of the latest stable release can be done via `pip install remotemanager`

For development, you can clone this repo and install via `cd remotemanager && pip install -e .[dev]`

Tip: You can clone a specific branch with `git clone -b devel`.

If you want to build the docs locally a `pandoc` install is required. 

You can install all required python packages with the `[dev]` or `[docs]` optionals. 

### HPC

Remotemanager exists to facilitate running on High Performance Compute machines (supercomputers). Script generation is ideally done via the `BaseComputer` module.

Existing Computers can be found at [this repository](https://gitlab.com/l_sim/remotemanager-computers). For creating a new machine class, see the [documentation](https://l_sim.gitlab.io/remotemanager/).

### Documentation

See the [documentation](https://l_sim.gitlab.io/remotemanager/) for further information, tutorials and api documentation.
