# parrot 🦜
**parrot** stands for **P**rocessing **A**ll **R**apidly & **R**eliably **O**btained **T**Hz-traces.
parrot is a Python package to load, process, and plot continuously recorded THz data (along with delay line position
data), obtained with electro-optic sampling (EOS), photoconductive antenna (PCA) receivers or similar
techniques.
The documentation of parrot can be found [here](https://timvog.github.io/parrot/).
***
## How to install
If you have Python/pip installed, just enter:
```python
pip install superparrot
```
and it should install correctly. (The name `parrot` was unfortunately already taken on pypi.org, hence the different
name for `pip install superparrot`. However, after installation you can import it as `parrot`.)
***
## How to use
Go to [GitHub](https://github.com/TimVog/parrot/) and look at the files placed in the root directory. If you have
Anaconda (or Python + Jupyter notebook) installed, try the `Example.ipynb` notebook in the root directory.
If you prefer classic Python, check out `Example_compact.py` in the root directory. The distribution comes with some
example data that allows you to see the capabilities of parrot.
***
## Further information
Check out the documentation [here](https://timvog.github.io/parrot/).
***
## I have a problem / I have an idea / I found a bug
Please open an issue on [GitHub](https://github.com/TimVog/parrot/issues).
Raw data
{
"_id": null,
"home_page": null,
"name": "superparrot",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": "DR, SNR, THz, Terahertz, averaging, dataprocessing, dynamic range, signal-to-noise ratio",
"author": null,
"author_email": "Tim Vogel <32876663+TimVog@users.noreply.github.com>",
"download_url": "https://files.pythonhosted.org/packages/2b/59/e97b89a823c5c97c9f6b4b4e0ea701dd9285e40cb17a0fc0be0d05dc18f9/superparrot-0.1.2.tar.gz",
"platform": null,
"description": "# parrot \ud83e\udd9c\n\n**parrot** stands for **P**rocessing **A**ll **R**apidly & **R**eliably **O**btained **T**Hz-traces.\n\nparrot is a Python package to load, process, and plot continuously recorded THz data (along with delay line position\ndata), obtained with electro-optic sampling (EOS), photoconductive antenna (PCA) receivers or similar\ntechniques.\n\nThe documentation of parrot can be found [here](https://timvog.github.io/parrot/).\n\n***\n\n## How to install\n\nIf you have Python/pip installed, just enter:\n\n```python\npip install superparrot\n```\n\nand it should install correctly. (The name `parrot` was unfortunately already taken on pypi.org, hence the different\nname for `pip install superparrot`. However, after installation you can import it as `parrot`.)\n\n***\n\n## How to use\n\nGo to [GitHub](https://github.com/TimVog/parrot/) and look at the files placed in the root directory. If you have\nAnaconda (or Python + Jupyter notebook) installed, try the `Example.ipynb` notebook in the root directory.\nIf you prefer classic Python, check out `Example_compact.py` in the root directory. The distribution comes with some\nexample data that allows you to see the capabilities of parrot.\n\n***\n\n## Further information\n\nCheck out the documentation [here](https://timvog.github.io/parrot/).\n\n***\n\n## I have a problem / I have an idea / I found a bug\n\nPlease open an issue on [GitHub](https://github.com/TimVog/parrot/issues).",
"bugtrack_url": null,
"license": null,
"summary": "parrot is able to to process and average continuously recorded THz data.",
"version": "0.1.2",
"project_urls": {
"Documentation": "https://timvog.github.io/parrot/",
"Source": "https://github.com/TimVog/parrot"
},
"split_keywords": [
"dr",
" snr",
" thz",
" terahertz",
" averaging",
" dataprocessing",
" dynamic range",
" signal-to-noise ratio"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "b83712e089fcdc822e4d2af99effd316b4b7036014d3e62cc8c38234584bc7e4",
"md5": "2bfdc3d13cf7809f754de543fe9b08f7",
"sha256": "abe3bb9c7b9cea470c52e998f6e5c132e9b15ac418f55d70d0e1e589d46a054f"
},
"downloads": -1,
"filename": "superparrot-0.1.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "2bfdc3d13cf7809f754de543fe9b08f7",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 80192775,
"upload_time": "2024-07-20T18:26:01",
"upload_time_iso_8601": "2024-07-20T18:26:01.332293Z",
"url": "https://files.pythonhosted.org/packages/b8/37/12e089fcdc822e4d2af99effd316b4b7036014d3e62cc8c38234584bc7e4/superparrot-0.1.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "2b59e97b89a823c5c97c9f6b4b4e0ea701dd9285e40cb17a0fc0be0d05dc18f9",
"md5": "7897d8d88b6a75e1f7ac90f75913b59e",
"sha256": "c7bf4d1b0147316ed4731e41692c119e7c994bdf88eedc6eb9114d17b68660cc"
},
"downloads": -1,
"filename": "superparrot-0.1.2.tar.gz",
"has_sig": false,
"md5_digest": "7897d8d88b6a75e1f7ac90f75913b59e",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 81281416,
"upload_time": "2024-07-20T18:27:15",
"upload_time_iso_8601": "2024-07-20T18:27:15.297376Z",
"url": "https://files.pythonhosted.org/packages/2b/59/e97b89a823c5c97c9f6b4b4e0ea701dd9285e40cb17a0fc0be0d05dc18f9/superparrot-0.1.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-07-20 18:27:15",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "TimVog",
"github_project": "parrot",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "superparrot"
}