| Name | pywerami JSON |
| Version |
0.3.0
JSON |
| download |
| home_page | None |
| Summary | pywerami is a stand-alone program to make an countour/3D plot from a contour data file generated by the Perple_X program WERAMI. |
| upload_time | 2025-01-27 11:12:45 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.10 |
| license | MIT License
pywerami - stand-alone program to make an countour/3D plot from Perple_X data
Copyright (c) 2021, Ondrej Lexa
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE. |
| keywords |
perple_x
petrology
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# pywerami
[](https://badge.fury.io/gh/ondrolexa%2Fpywerami)
[](https://readthedocs.org/projects/pywerami/?badge=latest)
[](https://zenodo.org/badge/latestdoi/46796466)
## What is pywerami
pywerami is a stand-alone program to make an countour/3D plot from data
file generated by the Perple_X program WERAMI or tci file generated by
TCInvestigator.
## How to install
It is strongly suggested to install **pywerami** into separate environment. You can create
Python virtual environment. For Linux and macOS use:
python -m venv .venv
source .venv/bin/activate
for Windows use Command Prompt or PowerShell:
python -m venv .venv
.venv\Scripts\activate
> [!NOTE]
> On Microsoft Windows, it may be required to set the execution policy in PowerShell for the user.
> You can do this by issuing the following PowerShell command:
> ```
> Set-ExecutionPolicy -ExecutionPolicy RemoteSigned -Scope CurrentUser
> ```
and install **pywerami** using pip within the environment. **You should choose the UI framework using option** `pyqt5` **or** `pyqt6`:
pip install pywerami[pyqt6]
## I'm using conda or mamba to manage environments
If you have already have conda or mamba installed, you can create environment with:
conda create -n pywerami python pyqt numpy matplotlib scipy
or
mamba create -n pywerami python pyqt numpy matplotlib scipy
Then activate the new environment:
conda activate pywerami
or
mamba activate pywerami
and install with pip. As PyQt is already installed with mamba/conda, we will install **pywerami** without UI framework:
pip install pywerami
> [!NOTE]
> If you encounter errors during install, try to install without upgrading dependencies:
> ```
> pip install --no-deps pywerami
> ```
### Running pywerami
To start pywerami, simply type:
```bash
pywerami
```
Do not forget that virtual environment must be activated prior running `pywerami`.
## Getting help
If you get any errors [open a new Issue](https://github.com/ondrolexa/pywerami/issues) providing the versions from either command above, as well as any errors you saw in the console during the installation.
## Donate
pywerami is an open-source project, available for you for free. It took a lot of time and resources to build this software. If you find this software useful and want to support its future development please consider donating me.
[](https://www.paypal.com/cgi-bin/webscr?cmd=_donations&business=QTYZWVUNDUAH8&item_name=pywerami+development+donation¤cy_code=EUR&source=url)
## License
pywerami is free software: you can redistribute it and/or modify it under the terms of the MIT License. A copy of this license is provided in ``LICENSE`` file.
Raw data
{
"_id": null,
"home_page": null,
"name": "pywerami",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.10",
"maintainer_email": "Ondrej Lexa <lexa.ondrej@gmail.com>",
"keywords": "Perple_X, petrology",
"author": null,
"author_email": "Ondrej Lexa <lexa.ondrej@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/20/d4/144b1e5a9d3751c0da3d29c011439d8b52f372e74afe0558eba6a869ce20/pywerami-0.3.0.tar.gz",
"platform": null,
"description": "# pywerami\n\n[](https://badge.fury.io/gh/ondrolexa%2Fpywerami)\n[](https://readthedocs.org/projects/pywerami/?badge=latest)\n[](https://zenodo.org/badge/latestdoi/46796466)\n\n## What is pywerami\n\npywerami is a stand-alone program to make an countour/3D plot from data\nfile generated by the Perple_X program WERAMI or tci file generated by\nTCInvestigator.\n\n## How to install\n\nIt is strongly suggested to install **pywerami** into separate environment. You can create\nPython virtual environment. For Linux and macOS use:\n\n python -m venv .venv\n source .venv/bin/activate\n\nfor Windows use Command Prompt or PowerShell:\n\n python -m venv .venv\n .venv\\Scripts\\activate\n\n> [!NOTE]\n> On Microsoft Windows, it may be required to set the execution policy in PowerShell for the user.\n> You can do this by issuing the following PowerShell command:\n> ```\n> Set-ExecutionPolicy -ExecutionPolicy RemoteSigned -Scope CurrentUser\n> ```\n\nand install **pywerami** using pip within the environment. **You should choose the UI framework using option** `pyqt5` **or** `pyqt6`:\n\n pip install pywerami[pyqt6]\n\n## I'm using conda or mamba to manage environments\n\nIf you have already have conda or mamba installed, you can create environment with:\n\n conda create -n pywerami python pyqt numpy matplotlib scipy\n\nor\n\n mamba create -n pywerami python pyqt numpy matplotlib scipy\n\nThen activate the new environment:\n\n conda activate pywerami\n\nor\n\n mamba activate pywerami\n\nand install with pip. As PyQt is already installed with mamba/conda, we will install **pywerami** without UI framework:\n\n pip install pywerami\n\n> [!NOTE]\n> If you encounter errors during install, try to install without upgrading dependencies:\n> ```\n> pip install --no-deps pywerami\n> ```\n\n### Running pywerami\nTo start pywerami, simply type:\n\n```bash\npywerami\n```\n\nDo not forget that virtual environment must be activated prior running `pywerami`.\n\n## Getting help\n\nIf you get any errors [open a new Issue](https://github.com/ondrolexa/pywerami/issues) providing the versions from either command above, as well as any errors you saw in the console during the installation.\n\n## Donate\n\npywerami is an open-source project, available for you for free. It took a lot of time and resources to build this software. If you find this software useful and want to support its future development please consider donating me.\n\n[](https://www.paypal.com/cgi-bin/webscr?cmd=_donations&business=QTYZWVUNDUAH8&item_name=pywerami+development+donation¤cy_code=EUR&source=url)\n\n## License\n\npywerami is free software: you can redistribute it and/or modify it under the terms of the MIT License. A copy of this license is provided in ``LICENSE`` file.\n",
"bugtrack_url": null,
"license": "MIT License\n \n pywerami - stand-alone program to make an countour/3D plot from Perple_X data\n Copyright (c) 2021, Ondrej Lexa\n \n Permission is hereby granted, free of charge, to any person obtaining a copy\n of this software and associated documentation files (the \"Software\"), to deal\n in the Software without restriction, including without limitation the rights\n to use, copy, modify, merge, publish, distribute, sublicense, and/or sell\n copies of the Software, and to permit persons to whom the Software is\n furnished to do so, subject to the following conditions:\n \n The above copyright notice and this permission notice shall be included in all\n copies or substantial portions of the Software.\n \n THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\n IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\n FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\n AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\n LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\n OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\n SOFTWARE.",
"summary": "pywerami is a stand-alone program to make an countour/3D plot from a contour data file generated by the Perple_X program WERAMI.",
"version": "0.3.0",
"project_urls": {
"Changelog": "https://github.com/ondrolexa/pywerami/blob/master/CHANGELOG.md",
"Documentation": "https://pywerami.readthedocs.io/",
"Homepage": "https://github.com/ondrolexa/pywerami",
"Issues": "https://github.com/ondrolexa/pywerami/issues",
"Repository": "https://github.com/ondrolexa/pywerami.git"
},
"split_keywords": [
"perple_x",
" petrology"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "909c095ca11a3d4e00c8a570a87a4ba86c79b557c9232efbf9667da6a12f9873",
"md5": "b865c87dbf17f9c594f1c7cd5615df7f",
"sha256": "c05a98552dc9684de8a2ba363b598d0b88de5e416e91b3db35c596dab78e0ac7"
},
"downloads": -1,
"filename": "pywerami-0.3.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "b865c87dbf17f9c594f1c7cd5615df7f",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10",
"size": 314409,
"upload_time": "2025-01-27T11:12:42",
"upload_time_iso_8601": "2025-01-27T11:12:42.444311Z",
"url": "https://files.pythonhosted.org/packages/90/9c/095ca11a3d4e00c8a570a87a4ba86c79b557c9232efbf9667da6a12f9873/pywerami-0.3.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "20d4144b1e5a9d3751c0da3d29c011439d8b52f372e74afe0558eba6a869ce20",
"md5": "96b945c82c4bb03476aa6bd0d03eefa2",
"sha256": "be6f1735adc0c048490f6f870786d321ebc511b5fb368e2dd679d652274c4b89"
},
"downloads": -1,
"filename": "pywerami-0.3.0.tar.gz",
"has_sig": false,
"md5_digest": "96b945c82c4bb03476aa6bd0d03eefa2",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10",
"size": 312214,
"upload_time": "2025-01-27T11:12:45",
"upload_time_iso_8601": "2025-01-27T11:12:45.020617Z",
"url": "https://files.pythonhosted.org/packages/20/d4/144b1e5a9d3751c0da3d29c011439d8b52f372e74afe0558eba6a869ce20/pywerami-0.3.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-01-27 11:12:45",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "ondrolexa",
"github_project": "pywerami",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "pywerami"
}
