| Name | batogram JSON |
| Version |
1.3.0
JSON |
| download |
| home_page | |
| Summary | Batogram is a GUI program for rendering spectrograms from full spectrum recordings of bat calls. |
| upload_time | 2024-02-26 11:29:12 |
| maintainer | |
| docs_url | None |
| author | |
| requires_python | >=3.9 |
| license | Copyright (c) 2023 John Mears 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 |
bat
spectrogram
chiropterology
fourier
ultrasonic
ultrasound
echo
guano
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
Batogram
========
Batogram is an open source application for viewing bat call spectrograms.
Some capabilities and features:
* Rendering of spectrograms from .wav files.
* Audio playback: direct, heterodyne and time division, write to .wav file.
* Auto selection of many parameters for simple operation.
* Efficient rendering with graceful handling of larger data files.
* Pan and scale using the mouse, keys or by manual selection.
* Graphical markers allow time and frequency ranges to be conveniently read.
* Handling of multichannel data files, including stereo.
* Ability to correct for microphone frequency response.
* Basic side by side comparison of two spectrograms.
* Support for reassignment spectrograms for increased resolution.
* Display of GUANO metadata, including the ability to click to open the location in Google Maps.
* Runs on Windows, Linux operating systems, maybe macOS.
Installation
------------
### Windows
There are currently two approaches to installing Batogram on Windows. The first and simplest
method is as follows:
* Download a Batogram executable for Windows from Github. Available releases are listed
[here](https://github.com/jmears63/batogram/releases). You need the file named batogram.exe, listed
under Assets.
* Probably Windows Defender will warn you of the danger of downloading such files from unknown
sources. Assess the risk and decide if you going ahead. Assuming you are, proceed to the
next step.
* Copy the downloaded executable to your Windows desktop, so that you can find it when you want it.
* Double click it on the desktop to run it. The first time you run it, it will take a little longer to start
up than usual. You will notice a command window launched alongside Batogram - ignore it. This is to
aid debugging, and will be removed in a future release.
The second installation method is to install Python on your Windows computer, and then follow the
same steps as the Linux installation. If you take this route, I assume you know what you are doing.
### Linux
On Linux, Batogram is currently installed from the command line using pip, as below.
You need to have Python 3.9 as a minimum.
# Create a virtual environment at a convenient location in your home directory:
mkdir ~/batogram
cd batogram
python3 -m venv venv
source venv/bin/activate
# It's good practice to have pip up to date:
pip install pip --upgrade
# You may need to install some dependencies. On fedora it looks as follows.
# More information on pyaudio installation here: https://people.csail.mit.edu/hubert/pyaudio/
sudo dnf install python3-devel gcc portaudio-devel python3-tkinter
# Install batogram and its dependencies. This may take a few moments.
pip install batogram
# Batogram is now in PATH. You can run it with this simple command:
batogram
### macOS (experimental)
It should be possible to follow the same steps as the Linux installation to install and run
batogram. However, I am not an expert on Apple products, and don't have any macOS systems to
test this on.
Usage
-----
Refer to files in the docs directory for more information. In particular, see
[batogram.md](docs/batogram.md) for usage notes.
Licence
-------
This project is licensed under the MIT License - see the LICENSE file for details.
Contributing
------------
I welcome bug reports, and requests for minor improvements and major new features.
Please submit these via github. I will prioritize them and get to them when I can.
I also welcome sample .wav files containing representative bat calls of different species.
My hope this that this will grow into a useful collection of reference calls for comparison.
For the moment, while the structure of the code is fairly rapid flux, so I am not accepting
pull requests other than for small fixes. This may change in the future.
Credits
-------
In no particular order:
* [Pictogrammers Team](https://www.iconarchive.com/show/material-icons-by-pictogrammers/bat-icon.html) for the application icon.
* [Tucker Beck](https://code.activestate.com/recipes/576688-tooltip-for-tkinter/) for tooltip code.
* [Remix Icon](https://remixicon.com/) for icons.
* [Kenneth Moreland](https://www.kennethmoreland.com/color-advice/) for colour maps.
* [David A. Riggs](https://github.com/riggsd/guano-py/blob/master/guano.py) for GUANO code.
* [Arnold Andreasson](https://github.com/arnoldandreasson) for testing and insights.
* [Peter Kovesi](https://colorcet.com/index.html) for colour maps.
About the Author
----------------
I am John Mears. I obtained a degree in physics in the University of Oxford
in the distant past. I have spent much of the last 40 years writing software
relating to scientific and email security applications. In my spare time I cycle,
play double bass in local amateur orchestras,
and [wander around at dusk](https://fitzharrys.wordpress.com/) with a bat detector of
my own design.
Raw data
{
"_id": null,
"home_page": "",
"name": "batogram",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": "",
"keywords": "bat,spectrogram,chiropterology,fourier,ultrasonic,ultrasound,echo,GUANO",
"author": "",
"author_email": "John Mears <john+batogram@themears.co.uk>",
"download_url": "https://files.pythonhosted.org/packages/72/ed/bd64eb23c367c484a289f386fff05dac61eb7c10c18acd0518805d934476/batogram-1.3.0.tar.gz",
"platform": null,
"description": "Batogram\n========\n\n![Screen Shot](docs/screenshot.png \"Screen Shot\")\n\nBatogram is an open source application for viewing bat call spectrograms.\n\nSome capabilities and features: \n* Rendering of spectrograms from .wav files.\n* Audio playback: direct, heterodyne and time division, write to .wav file.\n* Auto selection of many parameters for simple operation.\n* Efficient rendering with graceful handling of larger data files.\n* Pan and scale using the mouse, keys or by manual selection.\n* Graphical markers allow time and frequency ranges to be conveniently read.\n* Handling of multichannel data files, including stereo.\n* Ability to correct for microphone frequency response.\n* Basic side by side comparison of two spectrograms.\n* Support for reassignment spectrograms for increased resolution.\n* Display of GUANO metadata, including the ability to click to open the location in Google Maps.\n* Runs on Windows, Linux operating systems, maybe macOS.\n\nInstallation\n------------\n\n### Windows\n\nThere are currently two approaches to installing Batogram on Windows. The first and simplest\nmethod is as follows:\n\n* Download a Batogram executable for Windows from Github. Available releases are listed \n[here](https://github.com/jmears63/batogram/releases). You need the file named batogram.exe, listed\nunder Assets.\n* Probably Windows Defender will warn you of the danger of downloading such files from unknown\nsources. Assess the risk and decide if you going ahead. Assuming you are, proceed to the\nnext step.\n* Copy the downloaded executable to your Windows desktop, so that you can find it when you want it.\n* Double click it on the desktop to run it. The first time you run it, it will take a little longer to start \nup than usual. You will notice a command window launched alongside Batogram - ignore it. This is to\naid debugging, and will be removed in a future release.\n\nThe second installation method is to install Python on your Windows computer, and then follow the \nsame steps as the Linux installation. If you take this route, I assume you know what you are doing.\n\n### Linux\n\nOn Linux, Batogram is currently installed from the command line using pip, as below.\nYou need to have Python 3.9 as a minimum. \n\n # Create a virtual environment at a convenient location in your home directory:\n mkdir ~/batogram\n cd batogram\n python3 -m venv venv\n source venv/bin/activate\n\n # It's good practice to have pip up to date:\n pip install pip --upgrade\n\n # You may need to install some dependencies. On fedora it looks as follows.\n # More information on pyaudio installation here: https://people.csail.mit.edu/hubert/pyaudio/\n sudo dnf install python3-devel gcc portaudio-devel python3-tkinter\n\n # Install batogram and its dependencies. This may take a few moments.\n pip install batogram\n \n # Batogram is now in PATH. You can run it with this simple command:\n batogram\n\n### macOS (experimental)\n\nIt should be possible to follow the same steps as the Linux installation to install and run\nbatogram. However, I am not an expert on Apple products, and don't have any macOS systems to\ntest this on.\n\nUsage\n-----\n\nRefer to files in the docs directory for more information. In particular, see\n[batogram.md](docs/batogram.md) for usage notes.\n\nLicence\n-------\n\nThis project is licensed under the MIT License - see the LICENSE file for details.\n\nContributing\n------------\n\nI welcome bug reports, and requests for minor improvements and major new features.\nPlease submit these via github. I will prioritize them and get to them when I can.\n\nI also welcome sample .wav files containing representative bat calls of different species.\nMy hope this that this will grow into a useful collection of reference calls for comparison.\n\nFor the moment, while the structure of the code is fairly rapid flux, so I am not accepting\npull requests other than for small fixes. This may change in the future.\n\nCredits\n-------\n\nIn no particular order:\n* [Pictogrammers Team](https://www.iconarchive.com/show/material-icons-by-pictogrammers/bat-icon.html) for the application icon.\n* [Tucker Beck](https://code.activestate.com/recipes/576688-tooltip-for-tkinter/) for tooltip code.\n* [Remix Icon](https://remixicon.com/) for icons.\n* [Kenneth Moreland](https://www.kennethmoreland.com/color-advice/) for colour maps.\n* [David A. Riggs](https://github.com/riggsd/guano-py/blob/master/guano.py) for GUANO code.\n* [Arnold Andreasson](https://github.com/arnoldandreasson) for testing and insights.\n* [Peter Kovesi](https://colorcet.com/index.html) for colour maps.\n\nAbout the Author\n----------------\n\nI am John Mears. I obtained a degree in physics in the University of Oxford\nin the distant past. I have spent much of the last 40 years writing software\nrelating to scientific and email security applications. In my spare time I cycle,\nplay double bass in local amateur orchestras, \nand [wander around at dusk](https://fitzharrys.wordpress.com/) with a bat detector of\nmy own design.\n\n",
"bugtrack_url": null,
"license": "Copyright (c) 2023 John Mears 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": "Batogram is a GUI program for rendering spectrograms from full spectrum recordings of bat calls.",
"version": "1.3.0",
"project_urls": {
"Homepage": "https://github.com/jmears63/batogram"
},
"split_keywords": [
"bat",
"spectrogram",
"chiropterology",
"fourier",
"ultrasonic",
"ultrasound",
"echo",
"guano"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "72edbd64eb23c367c484a289f386fff05dac61eb7c10c18acd0518805d934476",
"md5": "4414b89a278163c723a9fe51003869cb",
"sha256": "92bccd3dc59cf25db4d18a58970ee143a60674010eda534dc6f48cdd26398f5a"
},
"downloads": -1,
"filename": "batogram-1.3.0.tar.gz",
"has_sig": false,
"md5_digest": "4414b89a278163c723a9fe51003869cb",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 169520,
"upload_time": "2024-02-26T11:29:12",
"upload_time_iso_8601": "2024-02-26T11:29:12.375544Z",
"url": "https://files.pythonhosted.org/packages/72/ed/bd64eb23c367c484a289f386fff05dac61eb7c10c18acd0518805d934476/batogram-1.3.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-02-26 11:29:12",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "jmears63",
"github_project": "batogram",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"requirements": [],
"lcname": "batogram"
}
