# TiSKit
Routines for time series data processing
Uses the obspy seismological Trace, Stream (data) and Inventory (metadata)
classes, but should work for non-seismology datasets as well
[Documentation](https://tiskit.readthedocs.io/en/latest/index.html)
## Classes
- `CleanRotator`: rotate data to minimize noise on vertical channel
- `DataCleaner`: Transfer_Function-based data cleaning
- `Decimator`: Decimate time series and update metadata with the decimator's
response
- `SpectralDensity`: Calculate and manipulate spectral density functions.
- `TimeSpans`: Specify time spans to be removed, kept, zeroed, etc.
- `TransferFunctions`: Transfer functions for a given input channel.
## Functions
- `FIR_corr`: transform zero-phase data to minimum phase (only works for
LCHEAPO loggers, need to update to calculate/work for any
zero-phase filter)
- `readMSEED`: read in MSEED data, including if the file is too big (> 2 GB)
for obspy's read() function
- `rptransient`: calculate and remove periodic transient (VERY manual!).
Based on Matlab code by E Wielandt, used in Deen et al., 2017
- `PetersonNoiseModel`: return the Peterson High and Low Noise Models
## `seismo_tools` submodule: seismology-specific functions
- `plot_response`: plot instrument response (command line?)
- `plot_sensitivity`: plot instrument sensitivity (command line?)
## Installation
First, install `obspy` using the instructions on their webpage.
Then, in the pip/conda environment that contains obspy...
### From this repository
Clone or download this repository, then from within the main repository directory, run:
`pip install .`
You can also install in editable mode (for developers), with:
`pip install -e .`
### Using `pip`
Type `pip install tiskit-py`
Note that I had to call this module `tiskit-py` on PyPI, rather than `tiskit`,
so you may have to change the `import` calls in your code from `import tiskit`
to `import tiskit-py as tiskit`
Raw data
{
"_id": null,
"home_page": "https://github.com/WayneCrawford/tiskit",
"name": "tiskit-py",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": "",
"keywords": "oceanography,marine,OBS",
"author": "Wayne Crawford",
"author_email": "crawford@ipgp.fr",
"download_url": "https://files.pythonhosted.org/packages/df/3b/584e91401810483d684b3d718057210555180fee5cc2fceb453d2074c047/tiskit-py-0.3.3.tar.gz",
"platform": null,
"description": "# TiSKit\n\nRoutines for time series data processing\n\nUses the obspy seismological Trace, Stream (data) and Inventory (metadata)\nclasses, but should work for non-seismology datasets as well\n\n\n[Documentation](https://tiskit.readthedocs.io/en/latest/index.html)\n\n\n## Classes\n\n- `CleanRotator`: rotate data to minimize noise on vertical channel\n- `DataCleaner`: Transfer_Function-based data cleaning\n- `Decimator`: Decimate time series and update metadata with the decimator's\n response\n- `SpectralDensity`: Calculate and manipulate spectral density functions.\n- `TimeSpans`: Specify time spans to be removed, kept, zeroed, etc.\n- `TransferFunctions`: Transfer functions for a given input channel.\n \n \n## Functions\n\n- `FIR_corr`: transform zero-phase data to minimum phase (only works for\n LCHEAPO loggers, need to update to calculate/work for any\n zero-phase filter)\n- `readMSEED`: read in MSEED data, including if the file is too big (> 2 GB)\n for obspy's read() function\n- `rptransient`: calculate and remove periodic transient (VERY manual!). \n \tBased on Matlab code by E Wielandt, used in Deen et al., 2017\n\n- `PetersonNoiseModel`: return the Peterson High and Low Noise Models\n\n\n## `seismo_tools` submodule: seismology-specific functions\n\n- `plot_response`: plot instrument response (command line?)\n- `plot_sensitivity`: plot instrument sensitivity (command line?)\n\n\n## Installation\n\nFirst, install `obspy` using the instructions on their webpage.\nThen, in the pip/conda environment that contains obspy...\n\n### From this repository\n\nClone or download this repository, then from within the main repository directory, run:\n\n`pip install .`\n\nYou can also install in editable mode (for developers), with:\n\n`pip install -e .`\n\n### Using `pip`\n\nType `pip install tiskit-py`\n\nNote that I had to call this module `tiskit-py` on PyPI, rather than `tiskit`,\nso you may have to change the `import` calls in your code from `import tiskit`\nto `import tiskit-py as tiskit`\n",
"bugtrack_url": null,
"license": "",
"summary": "TIme Series toolKIT",
"version": "0.3.3",
"project_urls": {
"Homepage": "https://github.com/WayneCrawford/tiskit"
},
"split_keywords": [
"oceanography",
"marine",
"obs"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "392b2b0952d54d81a6c2ef3c10492d16d2498e23f6e5cb6e3e5f28614f53cda1",
"md5": "da80002342c0f60eda9a6ebe1e855239",
"sha256": "b2286d39a3a86906ebc7259e295969de424b390a0a3f2ae56bed993628552b62"
},
"downloads": -1,
"filename": "tiskit_py-0.3.3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "da80002342c0f60eda9a6ebe1e855239",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 138197,
"upload_time": "2023-07-12T22:08:51",
"upload_time_iso_8601": "2023-07-12T22:08:51.287218Z",
"url": "https://files.pythonhosted.org/packages/39/2b/2b0952d54d81a6c2ef3c10492d16d2498e23f6e5cb6e3e5f28614f53cda1/tiskit_py-0.3.3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "df3b584e91401810483d684b3d718057210555180fee5cc2fceb453d2074c047",
"md5": "6136fd961024115e2fe62f3e3af534f9",
"sha256": "89b315038028aca4eb2debb1ffdda0e79e83832faceb6403adf421e9f3913b1e"
},
"downloads": -1,
"filename": "tiskit-py-0.3.3.tar.gz",
"has_sig": false,
"md5_digest": "6136fd961024115e2fe62f3e3af534f9",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 114163,
"upload_time": "2023-07-12T22:08:53",
"upload_time_iso_8601": "2023-07-12T22:08:53.041062Z",
"url": "https://files.pythonhosted.org/packages/df/3b/584e91401810483d684b3d718057210555180fee5cc2fceb453d2074c047/tiskit-py-0.3.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-07-12 22:08:53",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "WayneCrawford",
"github_project": "tiskit",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "tiskit-py"
}
JSON
