# boutdata
[](https://travis-ci.org/boutproject/boutdata)
[](https://codecov.io/gh/boutproject/boutdata)
[](https://www.python.org/)
[](https://pypi.org/project/boutdata/)
[](https://www.python.org/dev/peps/pep-0008/)
[](https://github.com/boutproject/boutdata/blob/master/LICENSE)
pip-package of what is found in `BOUT-dev/tools/pylib/boutdata`.
Note that `BOUT-dev/tools/pylib/boutdata` will likely be replaced by this repo
in `BOUT++ v4.3.0`.
See [this issue](https://github.com/boutproject/BOUT-dev/issues/1347),
[this pull request](https://github.com/boutproject/BOUT-dev/pull/1766) and
[this pull request](https://github.com/boutproject/BOUT-dev/pull/1740) for details.
> **NOTE**: This package will likely be superseded by
[`xBOUT`](https://github.com/boutproject/xBOUT) in the near future
# Dependencies
`boutdata` depends on `boututils` which again depends on
[`netcfd4`](https://github.com/Unidata/netcdf4-python) which requires
[`HDF5`](https://www.h5py.org) and
[`netcdf-4`](https://github.com/Unidata/netcdf-c/releases) are
installed, and that the `nc-config` utility is in your `PATH`. This
can be install with
```
sudo apt-get install libhdf5-serial-dev netcdf-bin libnetcdf-dev
```
in ubuntu
# Install
`pip install boutdata`
or in a Conda environment:
`conda install -c conda-forge boutdata`
### Examples
Reading data from dump files:
```
from boutdata import collect
ni = collect("Ni")
```
When boutdata is installed as a package (e.g. with pip or conda), a
command-line program is provided as an interface to squashoutput:
```
$ bout-squashoutput
```
bout-squashoutput provides tab-completion of arguments if argcomplete is
installed and activated (see
[https://kislyuk.github.io/argcomplete/](https://kislyuk.github.io/argcomplete/)).
Raw data
{
"_id": null,
"home_page": "",
"name": "boutdata",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": "",
"keywords": "bout++,bout,plasma,physics,data-extraction,data-analysis,data-visualization",
"author": "",
"author_email": "Ben Dudson <benjamin.dudson@york.ac.uk>",
"download_url": "https://files.pythonhosted.org/packages/3c/bb/146893b8064cdaa46168bb402a94282ccd0af62a5770a02fdadaefa2f8cb/boutdata-0.2.1.tar.gz",
"platform": null,
"description": "# boutdata\n\n[](https://travis-ci.org/boutproject/boutdata)\n[](https://codecov.io/gh/boutproject/boutdata)\n[](https://www.python.org/)\n[](https://pypi.org/project/boutdata/)\n[](https://www.python.org/dev/peps/pep-0008/)\n[](https://github.com/boutproject/boutdata/blob/master/LICENSE)\n\npip-package of what is found in `BOUT-dev/tools/pylib/boutdata`.\nNote that `BOUT-dev/tools/pylib/boutdata` will likely be replaced by this repo\nin `BOUT++ v4.3.0`.\nSee [this issue](https://github.com/boutproject/BOUT-dev/issues/1347),\n[this pull request](https://github.com/boutproject/BOUT-dev/pull/1766) and\n[this pull request](https://github.com/boutproject/BOUT-dev/pull/1740) for details.\n\n> **NOTE**: This package will likely be superseded by\n [`xBOUT`](https://github.com/boutproject/xBOUT) in the near future\n\n# Dependencies\n\n`boutdata` depends on `boututils` which again depends on\n[`netcfd4`](https://github.com/Unidata/netcdf4-python) which requires\n[`HDF5`](https://www.h5py.org) and\n[`netcdf-4`](https://github.com/Unidata/netcdf-c/releases) are\ninstalled, and that the `nc-config` utility is in your `PATH`. This\ncan be install with\n\n```\nsudo apt-get install libhdf5-serial-dev netcdf-bin libnetcdf-dev\n```\n\nin ubuntu\n\n# Install\n\n`pip install boutdata`\n\nor in a Conda environment:\n\n`conda install -c conda-forge boutdata`\n\n### Examples\nReading data from dump files:\n\n```\nfrom boutdata import collect\nni = collect(\"Ni\")\n```\n\nWhen boutdata is installed as a package (e.g. with pip or conda), a\ncommand-line program is provided as an interface to squashoutput:\n```\n$ bout-squashoutput\n```\nbout-squashoutput provides tab-completion of arguments if argcomplete is\ninstalled and activated (see\n[https://kislyuk.github.io/argcomplete/](https://kislyuk.github.io/argcomplete/)).\n",
"bugtrack_url": null,
"license": "GNU Lesser General Public License v3 or later (LGPLv3+)",
"summary": "Python package for collecting BOUT++ data",
"version": "0.2.1",
"project_urls": {
"project": "https://github.com/boutproject/boutdata"
},
"split_keywords": [
"bout++",
"bout",
"plasma",
"physics",
"data-extraction",
"data-analysis",
"data-visualization"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "79309c1d39f1e4320a36e159313a3ef69e4c19caad57c39e894a35e821906179",
"md5": "82392598d6c8895c6251a5d4b866f704",
"sha256": "fc272fb73664ba7c3f4c10a995adda8bb34315c2ef3c74a644788b66cb46e5c9"
},
"downloads": -1,
"filename": "boutdata-0.2.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "82392598d6c8895c6251a5d4b866f704",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 79233,
"upload_time": "2023-10-30T09:35:24",
"upload_time_iso_8601": "2023-10-30T09:35:24.292174Z",
"url": "https://files.pythonhosted.org/packages/79/30/9c1d39f1e4320a36e159313a3ef69e4c19caad57c39e894a35e821906179/boutdata-0.2.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "3cbb146893b8064cdaa46168bb402a94282ccd0af62a5770a02fdadaefa2f8cb",
"md5": "2144da8b451f4254c973d0984d34aa8f",
"sha256": "043cddaeb38b128d2525f2005f48a5b7717ff5832a932183a4bef1d3eae389e0"
},
"downloads": -1,
"filename": "boutdata-0.2.1.tar.gz",
"has_sig": false,
"md5_digest": "2144da8b451f4254c973d0984d34aa8f",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 75233,
"upload_time": "2023-10-30T09:35:27",
"upload_time_iso_8601": "2023-10-30T09:35:27.631295Z",
"url": "https://files.pythonhosted.org/packages/3c/bb/146893b8064cdaa46168bb402a94282ccd0af62a5770a02fdadaefa2f8cb/boutdata-0.2.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-10-30 09:35:27",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "boutproject",
"github_project": "boutdata",
"travis_ci": false,
"coveralls": true,
"github_actions": true,
"lcname": "boutdata"
}
JSON
