Metadata-Version: 2.4
Name: vre-middleware
Version: 1.3.1
Summary: Platform middleware connecting HPC clusters, workflow systems and databases
Author: The Virtmat Tools Team
Author-email: virtmat-tools@lists.kit.edu
License: BSD-3-Clause
Project-URL: Homepage, https://gitlab.kit.edu/kit/virtmat-tools/vre-middleware
Project-URL: Documentation, https://vre-middleware.readthedocs.io
Project-URL: Download, https://pypi.org/project/vre-middleware/#files
Project-URL: Source Code, https://gitlab.kit.edu/kit/virtmat-tools/vre-middleware
Project-URL: Bug Reports, https://gitlab.kit.edu/kit/virtmat-tools/vre-middleware/-/issues
Project-URL: Changelog, https://gitlab.kit.edu/kit/virtmat-tools/vre-middleware/-/blob/master/CHANGELOG.md
Project-URL: Credits, https://gitlab.kit.edu/kit/virtmat-tools/vre-middleware/-/blob/master/CREDITS.md
Project-URL: Contributing, https://gitlab.kit.edu/kit/virtmat-tools/vre-middleware/-/blob/master/CONTRIBUTING.md
Keywords: workflow,workflow management system,Jupyter
Classifier: Development Status :: 4 - Beta
Classifier: Environment :: Web Environment
Classifier: Framework :: Jupyter
Classifier: Framework :: Jupyter :: JupyterLab
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: BSD License
Classifier: Natural Language :: English
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Topic :: Scientific/Engineering
Classifier: Topic :: Software Development :: Libraries :: Application Frameworks
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Topic :: Software Development :: User Interfaces
Classifier: Topic :: Other/Nonlisted Topic
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: fireworks>=2.0.4
Requires-Dist: prettytable
Requires-Dist: ipywidgets
Requires-Dist: ipyfilechooser
Requires-Dist: ipython
Requires-Dist: fabric2
Requires-Dist: semantic-version
Requires-Dist: fireworks-schema>=1.4.0
Requires-Dist: jsonschema>=4.18.0
Provides-Extra: test
Requires-Dist: requests; extra == "test"
Requires-Dist: pytz; extra == "test"
Requires-Dist: python-dateutil; extra == "test"
Requires-Dist: flake8; extra == "test"
Requires-Dist: pylint; extra == "test"
Requires-Dist: pytest; extra == "test"
Requires-Dist: pylint-exit; extra == "test"
Requires-Dist: pytest-cov; extra == "test"
Requires-Dist: anybadge; extra == "test"
Requires-Dist: pyflakes; extra == "test"
Requires-Dist: bandit; extra == "test"
Requires-Dist: testfixtures; extra == "test"
Dynamic: license-file

This is a [Virtual Research Environment](https://en.wikipedia.org/wiki/Virtual_research_environment) (VRE) middleware that has the goal to provide a Jupyter-oriented application programming interface (API) and a graphical user interface (GUI) to existing computing resources and infrastructures for virtual materials design. This VRE middleware acts as an interface to existing workflow systems and batch systems on different HPC clusters that can be switched as transparent backends. The VRE middleware enables implementing available [VirtMat](https://www.materials.kit.edu/298.php) [use cases](https://gitlab.kit.edu/kit/virtmat-tools/virtmat-models-and-data-analyses) as Jupyter notebooks that can be used, for instance, via the [JupyterHub services](https://www.nhr.kit.edu/userdocs/jupyter/) on computing resources provided by [NHR@KIT](https://www.nhr.kit.edu/english) and [bwUniCluster](https://wiki.bwhpc.de/e/Category:BwUniCluster_2.0).


# Quick start

  * [Prerequisites](docs/prerequisites.md)
  * [Installation and setup](docs/installation.md)
    - [Local installation](docs/installation.md#local-installation)
    - [Development installation](docs/installation.md#development-installation)
  * [Running the unit tests](docs/testing.md#running-the-unit-tests)


# Documentation

The full documentation is available [here](https://vre-middleware.readthedocs.io/).


# Support

If you need support or have any questions about VRE Middleware please write a message to virtmat-tools@lists.kit.edu.


# Continuous Integration (CI) Environment

A more in-depth explanation of the Continuous Integration (CI) environment can be found in the [Docker-Container repository](https://gitlab.com/ikondov/vre-ci-docker/-/blob/master/docs/ci_documentation.md)
