[](https://github.com/plumed/PlumedToHTML/actions/workflows/main.yml)
[](https://codecov.io/gh/plumed/PlumedToHTML)
[](https://lgtm.com/projects/g/plumed/PlumedToHTML/alerts/)
[](https://lgtm.com/projects/g/plumed/PlumedToHTML/context:python)
[](https://badge.fury.io/py/PlumedToHTML)
# PlumedToHTML
This is a Python implementation that allows you to generate pretified PLUMED input files that can be included in HTML documents. These pretified inputs have the following features:
* There is a badge that shows whether PLUMED is able to parse the input or not.
* When you hover over the names of actions tooltips appear to describe them that contain links to the corresponding pages in the PLUMED documentation.
* When you hover over the keyword name a tooltip explains the meaning of that particular keyword.
* If you click on the label for an action an explanation of that quantity that is stored in that label is given. The way the quantity is used in the rest of the calculation is given.
* If shortcuts are used and actions read in things that do not appear in the input you have the option to see what actions are read in by PLUMED. You can thus get insight into how methods are implemented in PLUMED.
* If some action has parameters that are set to default values you have the option to see what the default values of these parameters are.
N.B. This script uses subprocess to call PLUMED __If you use this script PLUMED must be available in your path__
# Documentation
You can install this script by using the command:
````
pip install plumedToHTML
````
You can then use it within a python script by using the command:
````
from PlumedToHTML import get_html, get_html_header
````
The function `get_html` takes two arguments:
* The first argument is a string that contains the PLUMED input you want to get the html for.
* The second argument is a label that is used to refer to the input. __If you have multiple PLUMED inputs on one page they all must have different labels__
This function returns a string that contains the PLUMED input html to include in your page.
The function `get_html_header` returns some javascript functions and css definitions that must be included in the header of the html page. These functions and css instructions control how the PLUMED inputs appear.
Raw data
{
"_id": null,
"home_page": "https://github.com/plumed/PlumedToHTML",
"name": "PlumedToHTML",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": null,
"author": "Gareth Tribello",
"author_email": "gareth.tribello@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/eb/8b/aeb61c65040bed6f81d087e2ce77aa2339917542fffe2c182edbefd14e3e/plumedtohtml-0.85.tar.gz",
"platform": null,
"description": "[](https://github.com/plumed/PlumedToHTML/actions/workflows/main.yml)\n[](https://codecov.io/gh/plumed/PlumedToHTML)\n[](https://lgtm.com/projects/g/plumed/PlumedToHTML/alerts/)\n[](https://lgtm.com/projects/g/plumed/PlumedToHTML/context:python)\n[](https://badge.fury.io/py/PlumedToHTML)\n\n# PlumedToHTML\n\nThis is a Python implementation that allows you to generate pretified PLUMED input files that can be included in HTML documents. These pretified inputs have the following features: \n \n* There is a badge that shows whether PLUMED is able to parse the input or not.\n* When you hover over the names of actions tooltips appear to describe them that contain links to the corresponding pages in the PLUMED documentation.\n* When you hover over the keyword name a tooltip explains the meaning of that particular keyword.\n* If you click on the label for an action an explanation of that quantity that is stored in that label is given. The way the quantity is used in the rest of the calculation is given.\n* If shortcuts are used and actions read in things that do not appear in the input you have the option to see what actions are read in by PLUMED. You can thus get insight into how methods are implemented in PLUMED.\n* If some action has parameters that are set to default values you have the option to see what the default values of these parameters are. \n\nN.B. This script uses subprocess to call PLUMED __If you use this script PLUMED must be available in your path__ \n\n# Documentation\n\nYou can install this script by using the command:\n\n````\npip install plumedToHTML\n````\n\nYou can then use it within a python script by using the command:\n\n````\nfrom PlumedToHTML import get_html, get_html_header\n````\n\nThe function `get_html` takes two arguments:\n\n* The first argument is a string that contains the PLUMED input you want to get the html for.\n* The second argument is a label that is used to refer to the input. __If you have multiple PLUMED inputs on one page they all must have different labels__\n\nThis function returns a string that contains the PLUMED input html to include in your page.\n\nThe function `get_html_header` returns some javascript functions and css definitions that must be included in the header of the html page. These functions and css instructions control how the PLUMED inputs appear.\n",
"bugtrack_url": null,
"license": null,
"summary": "A package for creating pretified HTML for PLUMED files",
"version": "0.85",
"project_urls": {
"Homepage": "https://github.com/plumed/PlumedToHTML"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "b824c754d62036baac4bb6f2e71d942a96fabe0dbcb4cc34dd57f40e78041869",
"md5": "1031a89a7307898e8ac81158cd2bb190",
"sha256": "baaf42ee024c296a5cf6697280480d15a63633f3d9c8caf93615a9432771158e"
},
"downloads": -1,
"filename": "PlumedToHTML-0.85-py3-none-any.whl",
"has_sig": false,
"md5_digest": "1031a89a7307898e8ac81158cd2bb190",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 26667,
"upload_time": "2024-10-22T12:43:54",
"upload_time_iso_8601": "2024-10-22T12:43:54.640684Z",
"url": "https://files.pythonhosted.org/packages/b8/24/c754d62036baac4bb6f2e71d942a96fabe0dbcb4cc34dd57f40e78041869/PlumedToHTML-0.85-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "eb8baeb61c65040bed6f81d087e2ce77aa2339917542fffe2c182edbefd14e3e",
"md5": "08ea06c8f6c06da5ba49251526ab6d4a",
"sha256": "869087f3f461133fca0ea8382f303e1ac3f3b56e7252e296d4c075bbea09cd8d"
},
"downloads": -1,
"filename": "plumedtohtml-0.85.tar.gz",
"has_sig": false,
"md5_digest": "08ea06c8f6c06da5ba49251526ab6d4a",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 26233,
"upload_time": "2024-10-22T12:43:56",
"upload_time_iso_8601": "2024-10-22T12:43:56.817823Z",
"url": "https://files.pythonhosted.org/packages/eb/8b/aeb61c65040bed6f81d087e2ce77aa2339917542fffe2c182edbefd14e3e/plumedtohtml-0.85.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-22 12:43:56",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "plumed",
"github_project": "PlumedToHTML",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"tox": true,
"lcname": "plumedtohtml"
}
JSON
