| Name | postgkyl JSON |
| Version |
1.7.5
JSON |
| download |
| home_page | None |
| Summary | Python library and command-line tool for postprocessing (not only) Gkeyll data |
| upload_time | 2024-08-30 08:15:48 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.10 |
| license | MIT License Copyright (c) 2016-2024 Ammar Hakim and the Gkeyll Team 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 |
plasma
gkeyll
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# Postgkyl
This is the Postgkyl project. It is both Python library and command-line tool
designed to provide unified access to Gkeyll data together with a broad variety
of analytical and visualization tools.
## Documentation
Full documentation of the Gkeyll project is available at
[ReadTheDocs](http://gkeyll.rtfd.io).
## Dependencies and Installation
Postgkyl requires the following packages:
* [click](https://pypi.org/project/click/)
* [matplotlib](https://pypi.org/project/matplotlib/)
* [msgpack](https://pypi.org/project/msgpack/)
* [numpy](https://pypi.org/project/numpy/)
* [scipy](https://pypi.org/project/scipy/)
* [sympy](https://pypi.org/project/sympy/)
* [tables](https://pypi.org/project/tables/)
Note that Posgkyl currently does not work with NumPy >= 2.0; the update is in
the works. In addition, there are two optional dependencies:
* [adios2](https://pypi.org/project/adios2/)
* [pytest](https://pypi.org/project/pytest/)
ADIOS 2 is required for reading Gkeyll 2 `bp` output files and it is not needed
when working only with `gkylzero`. [pytest](https://docs.pytest.org/en/stable/)
is required only for developers.
### Setting up virtual environment (recommended)
We strongly recommend creating a virtual Python environment for everybody
working with more than one Python project (this includes even using both
Postgkyl and Sphinx). The two recommended options are
[venv](https://docs.python.org/3/library/venv.html) and
[mamba](https://mamba.readthedocs.io/en/latest/).
With `venv`, one can create the virtual environment with:
```bash
python -m venv /path/to/new/virtual/environments/pgkyl
```
then activate it with:
| bash/zsh | `source <venv>/bin/activate` |
| fish | `source <venv>/bin/activate.fish` |
| csh/tcsh | `source <venv>/bin/activate.csh` |
and deactivate with:
```bash
deactivate
```
With `mamba`, one can create the virtual environment with:
```bash
mamba create -n pgkyl
```
then activate with:
```bash
mamba activate pgkyl
```
and deactivate with:
```bash
mamba deactivate
```
Note that with `mamba`, one can also use the provided `environment.yml` file,
which also includes dependency specifications:
```bash
mamba env create -f environment.yml
```
### Installing Postgkyl
The Postgkyl itself is installed with `pip`.[^1] Developers and uses who want to
have the most up-to-date version should install Postgkyl from the source code:
```bash
git clone git@github.com:ammarhakim/postgkyl.git
cd postgkyl
pip install -e .[adios,test]
```
Alternatively, Postgkyl can be installed directly from [PyPI](https://pypi.org/project/postgkyl/):
```bash
pip install -e postgkyl[adios,test]
```
Note that ADIOS2 is not available on PyPI for Mac OSX; therefore, Mac users who
want to use it need to install the dependency from elsewhere, for example, using
the above-mentioned `mamba` and then do *not* use the `adios` tag with `pip`.
## Testing
Postgkyl utilizes [pytest](https://docs.pytest.org/) for testing. The tests can
be called manually from the root Postgkyl directory simply by using:
```bash
pytest [-v]
```
## Authors
The full list of authors can be found [here](AUTHORS.md).
## License
See [Gkyl License](http://gkyl.readthedocs.io/en/latest/license.html)
for usage conditions.
[^1]: This does *not* require any additional modifications of `PYTHONPATH`. If
Postgkyl was used previously through `PYTHONPATH`, we strongly recommend
removing the path to the Postgkyl repository from the variable.
Raw data
{
"_id": null,
"home_page": null,
"name": "postgkyl",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.10",
"maintainer_email": "Petr Cagas <p.cagas@hzdr.de>",
"keywords": "plasma, Gkeyll",
"author": null,
"author_email": "Ammar Hakim <a.hakim@pppl.gov>, Petr Cagas <p.cagas@hzdr.de>",
"download_url": "https://files.pythonhosted.org/packages/07/3d/012b992213b7a5996cb8ce0bdb18833ceaa0e60ce944148c5c20c27a7758/postgkyl-1.7.5.tar.gz",
"platform": null,
"description": "# Postgkyl\n\n\n\nThis is the Postgkyl project. It is both Python library and command-line tool\ndesigned to provide unified access to Gkeyll data together with a broad variety\nof analytical and visualization tools.\n\n## Documentation\n\nFull documentation of the Gkeyll project is available at\n[ReadTheDocs](http://gkeyll.rtfd.io).\n\n## Dependencies and Installation\n\nPostgkyl requires the following packages:\n\n* [click](https://pypi.org/project/click/)\n* [matplotlib](https://pypi.org/project/matplotlib/)\n* [msgpack](https://pypi.org/project/msgpack/)\n* [numpy](https://pypi.org/project/numpy/)\n* [scipy](https://pypi.org/project/scipy/)\n* [sympy](https://pypi.org/project/sympy/)\n* [tables](https://pypi.org/project/tables/)\n\nNote that Posgkyl currently does not work with NumPy >= 2.0; the update is in\nthe works. In addition, there are two optional dependencies:\n\n* [adios2](https://pypi.org/project/adios2/)\n* [pytest](https://pypi.org/project/pytest/)\n\nADIOS 2 is required for reading Gkeyll 2 `bp` output files and it is not needed\nwhen working only with `gkylzero`. [pytest](https://docs.pytest.org/en/stable/)\nis required only for developers.\n\n### Setting up virtual environment (recommended)\n\nWe strongly recommend creating a virtual Python environment for everybody\nworking with more than one Python project (this includes even using both\nPostgkyl and Sphinx). The two recommended options are\n[venv](https://docs.python.org/3/library/venv.html) and\n[mamba](https://mamba.readthedocs.io/en/latest/).\n\nWith `venv`, one can create the virtual environment with:\n\n```bash\npython -m venv /path/to/new/virtual/environments/pgkyl\n```\n\nthen activate it with:\n\n| bash/zsh | `source <venv>/bin/activate` |\n| fish | `source <venv>/bin/activate.fish` |\n| csh/tcsh | `source <venv>/bin/activate.csh` |\n\nand deactivate with:\n\n```bash\ndeactivate\n```\n\nWith `mamba`, one can create the virtual environment with:\n\n```bash\nmamba create -n pgkyl\n```\n\nthen activate with:\n\n```bash\nmamba activate pgkyl\n```\n\nand deactivate with:\n\n```bash\nmamba deactivate\n```\n\nNote that with `mamba`, one can also use the provided `environment.yml` file,\nwhich also includes dependency specifications:\n\n```bash\nmamba env create -f environment.yml\n```\n\n### Installing Postgkyl\n\nThe Postgkyl itself is installed with `pip`.[^1] Developers and uses who want to\nhave the most up-to-date version should install Postgkyl from the source code:\n\n```bash\ngit clone git@github.com:ammarhakim/postgkyl.git\ncd postgkyl\npip install -e .[adios,test]\n```\n\nAlternatively, Postgkyl can be installed directly from [PyPI](https://pypi.org/project/postgkyl/):\n\n```bash\npip install -e postgkyl[adios,test]\n```\n\nNote that ADIOS2 is not available on PyPI for Mac OSX; therefore, Mac users who\nwant to use it need to install the dependency from elsewhere, for example, using\nthe above-mentioned `mamba` and then do *not* use the `adios` tag with `pip`.\n\n## Testing\n\nPostgkyl utilizes [pytest](https://docs.pytest.org/) for testing. The tests can\nbe called manually from the root Postgkyl directory simply by using:\n\n```bash\npytest [-v]\n```\n\n## Authors\n\nThe full list of authors can be found [here](AUTHORS.md).\n\n## License\n\nSee [Gkyl License](http://gkyl.readthedocs.io/en/latest/license.html)\nfor usage conditions.\n\n[^1]: This does *not* require any additional modifications of `PYTHONPATH`. If\n Postgkyl was used previously through `PYTHONPATH`, we strongly recommend\n removing the path to the Postgkyl repository from the variable.\n",
"bugtrack_url": null,
"license": "MIT License Copyright (c) 2016-2024 Ammar Hakim and the Gkeyll Team 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.",
"summary": "Python library and command-line tool for postprocessing (not only) Gkeyll data",
"version": "1.7.5",
"project_urls": {
"Bug Tracker": "https://github.com/ammarhakim/postgkyl/issues",
"Documentation": "https://gkeyll.readthedocs.io/",
"Repository": "https://github.com/ammarhakim/postgkyl"
},
"split_keywords": [
"plasma",
" gkeyll"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "eb06310205d6e92a966aad6b39eade829d464d8e970e8a2f638a216a5718fe48",
"md5": "a1cbd62b5be820a822368c7fe47495ec",
"sha256": "a3f209cf645978c8581af5072a1937f687a7b188e59f6f4a528b33b02fe38369"
},
"downloads": -1,
"filename": "postgkyl-1.7.5-py3-none-any.whl",
"has_sig": false,
"md5_digest": "a1cbd62b5be820a822368c7fe47495ec",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10",
"size": 2075859,
"upload_time": "2024-08-30T08:15:45",
"upload_time_iso_8601": "2024-08-30T08:15:45.880444Z",
"url": "https://files.pythonhosted.org/packages/eb/06/310205d6e92a966aad6b39eade829d464d8e970e8a2f638a216a5718fe48/postgkyl-1.7.5-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "073d012b992213b7a5996cb8ce0bdb18833ceaa0e60ce944148c5c20c27a7758",
"md5": "a6896f11daf9b4bfbbfb58272b561677",
"sha256": "904c37356a716a895b1df818f8da22c926a8f4e9d79d28bdc0486df8f99a7766"
},
"downloads": -1,
"filename": "postgkyl-1.7.5.tar.gz",
"has_sig": false,
"md5_digest": "a6896f11daf9b4bfbbfb58272b561677",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10",
"size": 3563565,
"upload_time": "2024-08-30T08:15:48",
"upload_time_iso_8601": "2024-08-30T08:15:48.231708Z",
"url": "https://files.pythonhosted.org/packages/07/3d/012b992213b7a5996cb8ce0bdb18833ceaa0e60ce944148c5c20c27a7758/postgkyl-1.7.5.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-08-30 08:15:48",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "ammarhakim",
"github_project": "postgkyl",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "postgkyl"
}
