https://github.com/inab/vre_template_tool

Template tool job executor for VRE
https://github.com/inab/vre_template_tool

template tool vre wrapper

Last synced: 5 days ago
JSON representation

Template tool job executor for VRE

• Host: GitHub
• URL: https://github.com/inab/vre_template_tool
• Owner: inab
• License: apache-2.0
• Created: 2020-01-27T16:13:37.000Z (almost 5 years ago)
• Default Branch: master
• Last Pushed: 2023-01-24T15:10:23.000Z (almost 2 years ago)
• Last Synced: 2024-04-15T09:21:03.201Z (7 months ago)
• Topics: template, tool, vre, wrapper
• Language: Python
• Homepage: https://github.com/inab/openVRE
• Size: 3.76 MB
• Stars: 0
• Watchers: 9
• Forks: 3
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE
  • Citation: CITATION.cff

Awesome Lists containing this project

README

        
# VRE template Tool Executor

[![Documentation Status](https://readthedocs.org/projects/vre-template-tool/badge/?version=latest)](https://vre-template-tool.readthedocs.io/en/latest/?badge=latest)

Example tool that is ready to run in the VRE matching the code in the [documentation](https://vre-template-tool.readthedocs.io/en/latest/?badge=latest).

This repository can be forked and used as the base template for creating new tools. It should have all of base

functionalities and is set up for testing to ensure code clarity.

## Requirements

- Python 3.6 or later

- [Git](https://git-scm.com/downloads)

```bash

sudo apt update

sudo apt install python3

sudo apt install git

```

In order to install the Python dependencies you need `pip` and `venv` modules.

```bash

sudo apt install python3-pip python3-venv

```

## Installation

Directly from GitHub:

```bash

cd $HOME

git clone https://github.com/inab/vre_template_tool.git

cd vre_template_tool

```

Create the Python environment:

```bash

python3 -m venv venv

source venv/bin/activate

pip install --upgrade pip wheel

pip install -r requirements.txt

```

## Run the Wrapper

```bash

./VRE_RUNNER --config tests/basic/config.json --in_metadata tests/basic/in_metadata.json --out_metadata out_metadata.json --log_file VRE_RUNNER.log

```

Look for the results in `tests/basic/run000/`.

## License

* © 2020-2022 Barcelona Supercomputing Center (BSC), ES

Licensed under the Apache License [Version 2.0](https://www.apache.org/licenses/LICENSE-2.0), see the file `LICENSE` for details.