# What does "VRE language" mean?
This is a [Domain-Specific Language (DSL)](https://en.wikipedia.org/wiki/Domain-specific_language) to be used in a [Virtual Research Environment](https://en.wikipedia.org/wiki/Virtual_research_environment) in the [VirtMat projects](https://www.materials.kit.edu/virtmat_current_projects.php). This means it is a computer language using domain-specific notations and abstractions rather than such commonly used in general purpose languages such as Python. For example, in our DSL there are no for-loops and classes (that are used in Python) and no workflows and workflow node objects (used in workflow DSLs). But we have objects such as atoms and molecules and semantics to perform specific operations on these.
# Requirements
## Domain concepts
The DSL totally depends on how we define our domain. In this VRE language, we define our domain as *materials modelling* domain that is a subdomain of *scientific computing* and has subdomains such as *atomistic modeling* and *molecular modeling*. Particularly, support of physical units by the language is a common concept for all these domains. Nevertheless, these domains can still be defined in different ways. Therefore, we base *our domain definition* on a set of use cases. We generally look at [this repository](https://gitlab.kit.edu/kit/virtmat-tools/virtmat-models-and-data-analyses) for relevant use cases to define our domain. **You are welcome to contribute with further uses cases to the further development of the VRE language.** To get involved, please fork [the use case repository](https://gitlab.kit.edu/kit/virtmat-tools/virtmat-models-and-data-analyses), add your use case and create a merge request.
## Requirements from the community and the target platform
Apart from the domain-specific notations, our VRE language has to satisfy further requirements:
1. Support a full life cycle of modeling, simulation and data analysis. A model should be accessible and extensible dynamically, at any time. This is what we call *persistence* and *dynamics* of the model. To satisfy this requirement, we connect the interpreter to a workflow management system equipped with a database.
2. Use [Jupyter](https://jupyter.org/) as a front-end system. This poses a challenge for models with persistence and on the other hand a new Jupyter kernel with the VRE language interpreter has to be developed.
3. Make the complex workflow management systems and HPC systems / batch systems *transparent*. This is not obvious and also not trivial to implement. Particularly, notations in the program code about the granularity (which statements belong to the same workflow node) and the computing resources needed (such as computing time, number of CPUs, memory, disk space, ...) are necessary for computational performance or other practical reasons but difficult to hide completely from the language.
4. Use Python as a language for the interpreter. This is due to the fact that a plenty of libraries (APIs) for Python in the domain already exist: the [Atomic Simulation Environment (ASE)](https://wiki.fysik.dtu.dk/ase/), [Python Materials Genomics (Pymatgen)](https://pymatgen.org/) and [PyIron](https://pyiron.org/), to name only a few. These libraries cover the most relevant aspects of their domains but still are used in the general-purpose language Python. The use of Python implies in turn that a workflow management system and system of physical units providing Python APIs are required.
# Development status
The current developement status of the VRE language is *beta*.
If you are interested, you can have a look at the [issues](https://gitlab.kit.edu/kit/virtmat-tools/vre-language/-/issues) and even start contributing by forking and creating merge requests.
If you want to use workflows for modeling and data analysis using Python in Jupyter you can start testing the [VRE middleware](https://gitlab.kit.edu/kit/virtmat-tools/vre-middleware) that is currently in *beta* state.
# Documentation
An installation guide and comprehensive documentation is provided on [these pages](https://vre-language.readthedocs.io).
# Support
If you need support or have any questions about VRE Language please write a message to virtmat-tools@lists.kit.edu.
Raw data
{
"_id": null,
"home_page": null,
"name": "vre-language",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": null,
"keywords": "domain-specific language, scientific computing, workflow, Jupyter",
"author": "The Virtmat Tools Team",
"author_email": "virtmat-tools@lists.kit.edu",
"download_url": "https://files.pythonhosted.org/packages/d0/b0/0cdff178f12fd25331b071c4a5e320052cd045c9acfda205916084907845/vre_language-0.5.2.tar.gz",
"platform": null,
"description": "# What does \"VRE language\" mean?\n\nThis is a [Domain-Specific Language (DSL)](https://en.wikipedia.org/wiki/Domain-specific_language) to be used in a [Virtual Research Environment](https://en.wikipedia.org/wiki/Virtual_research_environment) in the [VirtMat projects](https://www.materials.kit.edu/virtmat_current_projects.php). This means it is a computer language using domain-specific notations and abstractions rather than such commonly used in general purpose languages such as Python. For example, in our DSL there are no for-loops and classes (that are used in Python) and no workflows and workflow node objects (used in workflow DSLs). But we have objects such as atoms and molecules and semantics to perform specific operations on these.\n\n# Requirements\n\n## Domain concepts\n\nThe DSL totally depends on how we define our domain. In this VRE language, we define our domain as *materials modelling* domain that is a subdomain of *scientific computing* and has subdomains such as *atomistic modeling* and *molecular modeling*. Particularly, support of physical units by the language is a common concept for all these domains. Nevertheless, these domains can still be defined in different ways. Therefore, we base *our domain definition* on a set of use cases. We generally look at [this repository](https://gitlab.kit.edu/kit/virtmat-tools/virtmat-models-and-data-analyses) for relevant use cases to define our domain. **You are welcome to contribute with further uses cases to the further development of the VRE language.** To get involved, please fork [the use case repository](https://gitlab.kit.edu/kit/virtmat-tools/virtmat-models-and-data-analyses), add your use case and create a merge request.\n\n## Requirements from the community and the target platform\n\nApart from the domain-specific notations, our VRE language has to satisfy further requirements:\n\n1. Support a full life cycle of modeling, simulation and data analysis. A model should be accessible and extensible dynamically, at any time. This is what we call *persistence* and *dynamics* of the model. To satisfy this requirement, we connect the interpreter to a workflow management system equipped with a database.\n2. Use [Jupyter](https://jupyter.org/) as a front-end system. This poses a challenge for models with persistence and on the other hand a new Jupyter kernel with the VRE language interpreter has to be developed.\n3. Make the complex workflow management systems and HPC systems / batch systems *transparent*. This is not obvious and also not trivial to implement. Particularly, notations in the program code about the granularity (which statements belong to the same workflow node) and the computing resources needed (such as computing time, number of CPUs, memory, disk space, ...) are necessary for computational performance or other practical reasons but difficult to hide completely from the language.\n4. Use Python as a language for the interpreter. This is due to the fact that a plenty of libraries (APIs) for Python in the domain already exist: the [Atomic Simulation Environment (ASE)](https://wiki.fysik.dtu.dk/ase/), [Python Materials Genomics (Pymatgen)](https://pymatgen.org/) and [PyIron](https://pyiron.org/), to name only a few. These libraries cover the most relevant aspects of their domains but still are used in the general-purpose language Python. The use of Python implies in turn that a workflow management system and system of physical units providing Python APIs are required.\n\n# Development status\n\nThe current developement status of the VRE language is *beta*.\n\nIf you are interested, you can have a look at the [issues](https://gitlab.kit.edu/kit/virtmat-tools/vre-language/-/issues) and even start contributing by forking and creating merge requests.\n\nIf you want to use workflows for modeling and data analysis using Python in Jupyter you can start testing the [VRE middleware](https://gitlab.kit.edu/kit/virtmat-tools/vre-middleware) that is currently in *beta* state.\n\n# Documentation\n\nAn installation guide and comprehensive documentation is provided on [these pages](https://vre-language.readthedocs.io).\n\n# Support\n\nIf you need support or have any questions about VRE Language please write a message to virtmat-tools@lists.kit.edu.\n",
"bugtrack_url": null,
"license": "BSD-3-Clause",
"summary": "VRE Language",
"version": "0.5.2",
"project_urls": null,
"split_keywords": [
"domain-specific language",
" scientific computing",
" workflow",
" jupyter"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "3b6ee8efcee1b4ccc32fc7204ff3032afe0b00ea30bd43acaa03784f7b58e1fe",
"md5": "0e5214fc94c0adea894405e22158c7eb",
"sha256": "eb8abee53f81bebed17e1c9352df7e883604a5a7e40b186a1aaa05085a1da566"
},
"downloads": -1,
"filename": "vre_language-0.5.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "0e5214fc94c0adea894405e22158c7eb",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 130305,
"upload_time": "2024-09-27T23:34:37",
"upload_time_iso_8601": "2024-09-27T23:34:37.079359Z",
"url": "https://files.pythonhosted.org/packages/3b/6e/e8efcee1b4ccc32fc7204ff3032afe0b00ea30bd43acaa03784f7b58e1fe/vre_language-0.5.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "d0b00cdff178f12fd25331b071c4a5e320052cd045c9acfda205916084907845",
"md5": "06fa3dc457ca7011f691dc277eee4ac8",
"sha256": "e590aea4833a11fed57c59c353b97271ea104746b3e612baf10c5447a4937c86"
},
"downloads": -1,
"filename": "vre_language-0.5.2.tar.gz",
"has_sig": false,
"md5_digest": "06fa3dc457ca7011f691dc277eee4ac8",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 150757,
"upload_time": "2024-09-27T23:34:39",
"upload_time_iso_8601": "2024-09-27T23:34:39.238060Z",
"url": "https://files.pythonhosted.org/packages/d0/b0/0cdff178f12fd25331b071c4a5e320052cd045c9acfda205916084907845/vre_language-0.5.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-09-27 23:34:39",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "vre-language"
}
JSON