# seisplot
Plotting of seismic data using variable-density or variable-area wiggle displays.
## Description
The seisplot module provides a single, highly flexible method *plot()* to
display seismic data. A second method *toggle()* can be used to create
animations that can be saved as images or movies.
The module was designed to get decent displays of seismic data in a way that
is more convenient than going through many individual Matplotlib function calls
explicitly. However, if required Matplotlib methods can also be called directly.
The code is pure Python and kept deliberately simple to get students
participating our Geophysics classes and exercises going with Python and
seismic data.
## Key features
* Variable-density image plots.
* Variable-area wiggle plots.
* Highly configurable settings like colors, line widths, colorbars, labels,
axis ticks, grid lines, etc.
* Animated toggles between two or more seismic image plots.
* Animated wipes between two seismic image plots.
<p align="center">
</p>
## Getting Started
### Dependencies
Required: numpy, matplotlib
### Installation
*Install from PyPI:*
```
$> pip install seisplot
```
*Install directly from gitlab:*
```
$> pip install git+https://gitlab.kit.edu/thomas.hertweck/seisplot.git
```
*Editable install from source:*
This version is intended for experts who would like to test the latest
version or make modifications. Normal users should prefer to install a
stable version.
```
$> git clone https://gitlab.kit.edu/thomas.hertweck/seisplot.git
```
Once you acquired the source, you can install an editable version of seisplot
with:
```
$> cd seisplot
$> pip install -e .
```
## Brief tutorial
For a demonstration of various features and much more, please visit the
"examples" folder where several Jupyter notebooks (tutorials) are available.
Plotting seismic data (for instance, read with our __seisio__ package and
therefore available as Numpy structured array including trace headers) can be
as simple as:
```
import seisplot
fig, ax = seisplot.plot(data, haxis="offset", width=4, height=6,
vlabel="Time (s)", hlabel="Offset (m)",
vmajorticks=0.2, vminorticks=0.1,
hminorticks=500, vgrid="major")
```
The variables `fig` and `ax` are standard Matplotlib figure and axis handles
that can be used to tweak the display further. You could also create those
first using `fig, ax = plt.subplots(1, 1)` and pass them to the *plot()* method.
In this way, it is possible to, for instance, create several seismic displays
in one figure, or create displays that share the y-axis (usually "time").
A display toggle can, for instance, be produced in the following way:
```
ani, fig, ax = seisplot.toggle([data_1, data_2, data_diff],
interval=1000, repeat_delay=0,
hlabel="offset (m)", vlabel="time (s)")
```
The returned animation-artist object can be used to save an animated image
or a movie.
An animated wipe can, for instance, be produced in the following way:
```
ani, fig, ax = seisplot.wipe(data_1, data_2, blit=True,
nwipe=30, wipecolor="blue",
interval=5, repeat_delay=0,
hlabel="offset (m)", vlabel="time (s)")
```
Again, the returned animation-artist object can be used to save an animated
image or a movie.
## Main author
Dr. Thomas Hertweck, geophysics@email.de
## License
This project is licensed under the LGPL v3.0 License - see the LICENSE.md
file for details
Raw data
{
"_id": null,
"home_page": null,
"name": "seisplot",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": "Thomas Hertweck <geophysics@email.de>",
"keywords": "seismic, display, image, wiggle, variable-density, variable-area",
"author": null,
"author_email": "Thomas Hertweck <geophysics@email.de>",
"download_url": "https://files.pythonhosted.org/packages/8f/14/aaaf654133af540cbabb208f1547da33c209c1a1550c1b25f64fce619b58/seisplot-1.2.0.tar.gz",
"platform": null,
"description": "# seisplot\n\nPlotting of seismic data using variable-density or variable-area wiggle displays.\n\n## Description\n\nThe seisplot module provides a single, highly flexible method *plot()* to\ndisplay seismic data. A second method *toggle()* can be used to create\nanimations that can be saved as images or movies.\n\nThe module was designed to get decent displays of seismic data in a way that\nis more convenient than going through many individual Matplotlib function calls\nexplicitly. However, if required Matplotlib methods can also be called directly.\nThe code is pure Python and kept deliberately simple to get students\nparticipating our Geophysics classes and exercises going with Python and\nseismic data.\n\n## Key features\n\n* Variable-density image plots.\n* Variable-area wiggle plots.\n* Highly configurable settings like colors, line widths, colorbars, labels,\n axis ticks, grid lines, etc.\n* Animated toggles between two or more seismic image plots.\n* Animated wipes between two seismic image plots.\n\n<p align=\"center\">\n![Image plot](img/img1.png \"Variable-density image plot\")\n![Wiggle plot](img/img2.png \"Variable-area wiggle plot\")\n![Velocity plot](img/img3.png \"Non-seismic data plot\")\n![Fielddata plot](img/img4.png \"Trace-normalized field data plot\")\n![Toggle plot](img/img5.apng \"Toggle of image plots\")\n![Wipe plot](img/img6.apng \"Wipe of image plots\")\n\n</p>\n\n## Getting Started\n\n### Dependencies\n\nRequired: numpy, matplotlib\n\n### Installation\n\n*Install from PyPI:*\n\n```\n$> pip install seisplot\n```\n\n*Install directly from gitlab:*\n\n```\n$> pip install git+https://gitlab.kit.edu/thomas.hertweck/seisplot.git\n```\n\n*Editable install from source:*\n\nThis version is intended for experts who would like to test the latest\nversion or make modifications. Normal users should prefer to install a\nstable version.\n\n```\n$> git clone https://gitlab.kit.edu/thomas.hertweck/seisplot.git\n```\n\nOnce you acquired the source, you can install an editable version of seisplot\nwith:\n\n```\n$> cd seisplot\n$> pip install -e .\n```\n\n## Brief tutorial\n\nFor a demonstration of various features and much more, please visit the\n\"examples\" folder where several Jupyter notebooks (tutorials) are available.\n\nPlotting seismic data (for instance, read with our __seisio__ package and\ntherefore available as Numpy structured array including trace headers) can be\nas simple as:\n\n```\nimport seisplot\n\nfig, ax = seisplot.plot(data, haxis=\"offset\", width=4, height=6,\n vlabel=\"Time (s)\", hlabel=\"Offset (m)\",\n vmajorticks=0.2, vminorticks=0.1,\n hminorticks=500, vgrid=\"major\")\n```\nThe variables `fig` and `ax` are standard Matplotlib figure and axis handles\nthat can be used to tweak the display further. You could also create those\nfirst using `fig, ax = plt.subplots(1, 1)` and pass them to the *plot()* method.\nIn this way, it is possible to, for instance, create several seismic displays\nin one figure, or create displays that share the y-axis (usually \"time\").\n\nA display toggle can, for instance, be produced in the following way:\n\n```\nani, fig, ax = seisplot.toggle([data_1, data_2, data_diff],\n interval=1000, repeat_delay=0,\n hlabel=\"offset (m)\", vlabel=\"time (s)\")\n```\nThe returned animation-artist object can be used to save an animated image\nor a movie.\n\nAn animated wipe can, for instance, be produced in the following way:\n\n```\nani, fig, ax = seisplot.wipe(data_1, data_2, blit=True,\n nwipe=30, wipecolor=\"blue\",\n interval=5, repeat_delay=0,\n hlabel=\"offset (m)\", vlabel=\"time (s)\")\n```\nAgain, the returned animation-artist object can be used to save an animated\nimage or a movie.\n\n## Main author\n\nDr. Thomas Hertweck, geophysics@email.de\n\n## License\n\nThis project is licensed under the LGPL v3.0 License - see the LICENSE.md\nfile for details\n",
"bugtrack_url": null,
"license": null,
"summary": "Plotting of seismic data",
"version": "1.2.0",
"project_urls": {
"Repository": "https://gitlab.kit.edu/thomas.hertweck/seisplot"
},
"split_keywords": [
"seismic",
" display",
" image",
" wiggle",
" variable-density",
" variable-area"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "9aa6be1ff5fe450cca0463984c39e21faf111b84631319f3422ba68de3083d6e",
"md5": "fc54b561475afc72c2587cb28a889aa0",
"sha256": "b7407f1c1eb3edc9740eb0db18e64f06205bd25917e3530f0fa439180fac2adb"
},
"downloads": -1,
"filename": "seisplot-1.2.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "fc54b561475afc72c2587cb28a889aa0",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 5722305,
"upload_time": "2025-01-25T19:39:38",
"upload_time_iso_8601": "2025-01-25T19:39:38.620376Z",
"url": "https://files.pythonhosted.org/packages/9a/a6/be1ff5fe450cca0463984c39e21faf111b84631319f3422ba68de3083d6e/seisplot-1.2.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "8f14aaaf654133af540cbabb208f1547da33c209c1a1550c1b25f64fce619b58",
"md5": "5d5a93959ccee189b636393a97ebbacb",
"sha256": "de3ceda69d4fd6d97a24a243c1cf8f75e08c39de304f9d3cd13ff4556778fc70"
},
"downloads": -1,
"filename": "seisplot-1.2.0.tar.gz",
"has_sig": false,
"md5_digest": "5d5a93959ccee189b636393a97ebbacb",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 5724222,
"upload_time": "2025-01-25T19:39:41",
"upload_time_iso_8601": "2025-01-25T19:39:41.868262Z",
"url": "https://files.pythonhosted.org/packages/8f/14/aaaf654133af540cbabb208f1547da33c209c1a1550c1b25f64fce619b58/seisplot-1.2.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-01-25 19:39:41",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "seisplot"
}
JSON