# hpc_suite
`hpc_suite` is a python package for working with data on high performance computing (HPC) systems.
# Installation via `pip`
Install `hpc_suite` using `pip` (if using a shared machine, add the `--user` argument after `install`)
```
pip install hpc_suite
```
# Updating
Update the code using `pip` (if using a shared machine, add the `--user` argument after `install`)
```
pip install hpc_suite --upgrade
```
# Installation with `pip` editable install
**Only do this if you are developing (i.e. changing) the code.**
Clone a copy of this repository, preferably while within a directory called git
```
mkdir -p git; cd git
git clone https://gitlab.com/chilton-group/hpc_suite
```
Navigate to the package directory
```
cd hpc_suite/packages
```
and install the package in editable mode (if using a shared machine, add the `--user` argument after `install`)
```
pip install -e .
```
When you're done developing (i.e. your changes have been merged to the master),
or if you just want to use the current release version of the package, uninstall using `pip`
```
pip uninstall hpc_suite
```
and follow the Installation via `pip` instructions above.
# Building a `.whl` file (Advanced)
**Only do this if you are told to.**
To build a copy of the `hpc_suite` `.whl` file, move to the `package` directory.
Now run
```
./build_binaries.sh
```
Then install the `.whl` file with `pip` (if using a shared machine, add the `--user` argument after `install`)
```
pip install dist/*.whl
```
# Documentation
The [documentation](https://chilton-group.gitlab.io/hpc_suite/) for this package is hosted by gitlab, and is automatically generated whenever new code is committed to the `main` branch. The automatic generation of this documentation relies on a common layout for comments and docstrings within the code, see [contributing](https://gitlab.com/chilton-group/group-wiki/-/wikis/Contributing:-General) for more information.
# Development
Before making changes to this repository, please follow the steps outlined in the [Chilton group wiki](https://gitlab.com/chilton-group/group-wiki/-/wikis/Contributing:-General).
# Bugs
If you believe you have a bug, *please check that you are using the most up to date version of the code*.
If that does not fix the problem, please create an issue on GitLab detailing the following:
- The commands you entered
- The error message
Remember to simplify the problem as much as possible in order to provide a minimum working example, e.g. an example for a small molecule rather than one with 100000 atoms.
Then, look at the code, try and figure out what you think is wrong if possible, and include this in your issue.
Raw data
{
"_id": null,
"home_page": "https://gitlab.com/chilton-group/hpc_suite",
"name": "hpc-suite",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": null,
"keywords": null,
"author": "Chilton Group",
"author_email": "nicholas.chilton@manchester.ac.uk",
"download_url": "https://files.pythonhosted.org/packages/6d/54/5c59b6f30a602fa33affe5b5a6a4645fcfcdf06709a994d3b74cd191ba3a/hpc_suite-1.10.1.tar.gz",
"platform": null,
"description": "# hpc_suite\n\n`hpc_suite` is a python package for working with data on high performance computing (HPC) systems.\n\n# Installation via `pip`\n\nInstall `hpc_suite` using `pip` (if using a shared machine, add the `--user` argument after `install`)\n\n```\npip install hpc_suite\n```\n\n# Updating\n\nUpdate the code using `pip` (if using a shared machine, add the `--user` argument after `install`)\n\n```\npip install hpc_suite --upgrade\n```\n\n# Installation with `pip` editable install\n\n**Only do this if you are developing (i.e. changing) the code.**\n\nClone a copy of this repository, preferably while within a directory called git\n\n```\nmkdir -p git; cd git\ngit clone https://gitlab.com/chilton-group/hpc_suite\n```\n\nNavigate to the package directory\n\n```\ncd hpc_suite/packages\n```\n\nand install the package in editable mode (if using a shared machine, add the `--user` argument after `install`)\n\n```\npip install -e .\n```\n\nWhen you're done developing (i.e. your changes have been merged to the master), \nor if you just want to use the current release version of the package, uninstall using `pip`\n\n```\npip uninstall hpc_suite\n```\n\nand follow the Installation via `pip` instructions above.\n\n# Building a `.whl` file (Advanced)\n\n**Only do this if you are told to.**\n\nTo build a copy of the `hpc_suite` `.whl` file, move to the `package` directory.\n\nNow run\n\n```\n./build_binaries.sh\n```\n\nThen install the `.whl` file with `pip` (if using a shared machine, add the `--user` argument after `install`)\n\n```\npip install dist/*.whl\n```\n\n\n# Documentation\n\nThe [documentation](https://chilton-group.gitlab.io/hpc_suite/) for this package is hosted by gitlab, and is automatically generated whenever new code is committed to the `main` branch. The automatic generation of this documentation relies on a common layout for comments and docstrings within the code, see [contributing](https://gitlab.com/chilton-group/group-wiki/-/wikis/Contributing:-General) for more information.\n\n# Development\n\nBefore making changes to this repository, please follow the steps outlined in the [Chilton group wiki](https://gitlab.com/chilton-group/group-wiki/-/wikis/Contributing:-General).\n\n# Bugs\n\nIf you believe you have a bug, *please check that you are using the most up to date version of the code*. \n\nIf that does not fix the problem, please create an issue on GitLab detailing the following:\n - The commands you entered\n - The error message\n\nRemember to simplify the problem as much as possible in order to provide a minimum working example, e.g. an example for a small molecule rather than one with 100000 atoms.\n\nThen, look at the code, try and figure out what you think is wrong if possible, and include this in your issue.\n",
"bugtrack_url": null,
"license": null,
"summary": "A package for working with data on HPC platforms",
"version": "1.10.1",
"project_urls": {
"Bug Tracker": "https://gitlab.com/chilton-group/hpc_suite/-/issues",
"Documentation": "https://chilton-group.gitlab.io/hpc_suite",
"Homepage": "https://gitlab.com/chilton-group/hpc_suite"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "57d33c2fa7957dfdb42933d46b0936484f3fc88f08370a3467fc0aace38f8794",
"md5": "218758e3b23980b2afea80b7b6bfc945",
"sha256": "29eff45c9a7da1e8bc1299425bcd2e510241b452ebe843c55d40985c9b5c9a63"
},
"downloads": -1,
"filename": "hpc_suite-1.10.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "218758e3b23980b2afea80b7b6bfc945",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.6",
"size": 26854,
"upload_time": "2024-05-03T05:25:58",
"upload_time_iso_8601": "2024-05-03T05:25:58.447363Z",
"url": "https://files.pythonhosted.org/packages/57/d3/3c2fa7957dfdb42933d46b0936484f3fc88f08370a3467fc0aace38f8794/hpc_suite-1.10.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "6d545c59b6f30a602fa33affe5b5a6a4645fcfcdf06709a994d3b74cd191ba3a",
"md5": "30f15f9b11f43423da4b393642483344",
"sha256": "fafdf0a91f03a6fc0cdd3e4edaaecbb0daa2d8ea2d0a1fd8e0b46fec9be8ec70"
},
"downloads": -1,
"filename": "hpc_suite-1.10.1.tar.gz",
"has_sig": false,
"md5_digest": "30f15f9b11f43423da4b393642483344",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 26669,
"upload_time": "2024-05-03T05:26:00",
"upload_time_iso_8601": "2024-05-03T05:26:00.551461Z",
"url": "https://files.pythonhosted.org/packages/6d/54/5c59b6f30a602fa33affe5b5a6a4645fcfcdf06709a994d3b74cd191ba3a/hpc_suite-1.10.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-05-03 05:26:00",
"github": false,
"gitlab": true,
"bitbucket": false,
"codeberg": false,
"gitlab_user": "chilton-group",
"gitlab_project": "hpc_suite",
"lcname": "hpc-suite"
}
JSON