| Name | pyngb JSON |
| Version |
0.1.1
JSON |
| download |
| home_page | None |
| Summary | Unofficial parser for NETZSCH STA (Simultaneous Thermal Analysis) NGB instrument binary files. Not affiliated with, endorsed by, or approved by NETZSCH-Gerätebau GmbH. |
| upload_time | 2025-11-06 18:34:27 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.9 |
| license | MIT License
Copyright (c) 2025-present GraysonBellamy <gbellamy@umd.edu>
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 |
binary-parsing
netzsch
ngb
scientific-data
sta
thermal-analysis
unofficial
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# pyNGB - NETZSCH STA File Parser
[](https://badge.fury.io/py/pyngb)
[](https://www.python.org/downloads/)
[](https://opensource.org/licenses/MIT)
[](https://github.com/GraysonBellamy/pyngb/actions)
A high-performance Python library for parsing NETZSCH STA (Simultaneous Thermal Analysis) NGB files with comprehensive metadata extraction and analysis tools.
**⚠️ Disclaimer**: This package is not affiliated with NETZSCH-Gerätebau GmbH. NETZSCH is a trademark of NETZSCH-Gerätebau GmbH.
## Features
- **Fast Binary Parsing**: Optimized parsing with NumPy and PyArrow (0.1-1 sec/file)
- **Complete Metadata**: Extract instrument settings, sample info, and experimental conditions
- **Baseline Correction**: Automatic baseline subtraction with validation
- **DTG Analysis**: Derivative thermogravimetry calculation with smoothing options
- **Batch Processing**: Parallel processing of multiple files
- **Data Export**: Convert to Parquet, CSV, and JSON formats
- **CLI Support**: Command-line interface for automation
## Installation
```bash
pip install pyngb
```
## Quick Example
```python
from pyngb import read_ngb
import polars as pl
import json
# Load NGB file with embedded metadata
table = read_ngb("experiment.ngb-ss3")
df = pl.from_arrow(table)
# Access data
print(f"Loaded {df.height} data points")
print(f"Temperature range: {df['sample_temperature'].min():.1f} to {df['sample_temperature'].max():.1f} °C")
# Access metadata
metadata = json.loads(table.schema.metadata[b'file_metadata'])
print(f"Sample: {metadata.get('sample_name', 'Unknown')}")
# Baseline correction
corrected = read_ngb("sample.ngb-ss3", baseline_file="baseline.ngb-bs3")
# DTG analysis
from pyngb.api.analysis import add_dtg
table_with_dtg = add_dtg(table, method="savgol", smooth="medium")
```
## Command Line Usage
```bash
# Convert single file
python -m pyngb sample.ngb-ss3
# Batch processing with baseline correction
python -m pyngb *.ngb-ss3 -b baseline.ngb-bs3 -f parquet -o ./processed/
# Get help
python -m pyngb --help
```
## Documentation
- **[Getting Started](docs/getting-started.md)** - Installation and first steps
- **[User Guide](docs/user-guide.md)** - Core functionality and examples
- **[API Reference](docs/api-reference.md)** - Complete function documentation
- **[Troubleshooting](docs/troubleshooting.md)** - Common issues and solutions
- **[Contributing](docs/contributing.md)** - Development guidelines
## License
MIT License. See [LICENSE.txt](LICENSE.txt) for details.
## Support
- **Issues**: [GitHub Issues](https://github.com/GraysonBellamy/pyngb/issues)
- **Discussions**: [GitHub Discussions](https://github.com/GraysonBellamy/pyngb/discussions)
---
Made with ❤️ for the scientific community
Raw data
{
"_id": null,
"home_page": null,
"name": "pyngb",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": null,
"keywords": "binary-parsing, netzsch, ngb, scientific-data, sta, thermal-analysis, unofficial",
"author": null,
"author_email": "Grayson Bellamy <gbellamy@umd.edu>",
"download_url": "https://files.pythonhosted.org/packages/e0/ec/ccd11557e239a51ef303aa1b74446f0fb0892ed062d317af2e99b10f9769/pyngb-0.1.1.tar.gz",
"platform": null,
"description": "# pyNGB - NETZSCH STA File Parser\n\n[](https://badge.fury.io/py/pyngb)\n[](https://www.python.org/downloads/)\n[](https://opensource.org/licenses/MIT)\n[](https://github.com/GraysonBellamy/pyngb/actions)\n\nA high-performance Python library for parsing NETZSCH STA (Simultaneous Thermal Analysis) NGB files with comprehensive metadata extraction and analysis tools.\n\n**\u26a0\ufe0f Disclaimer**: This package is not affiliated with NETZSCH-Ger\u00e4tebau GmbH. NETZSCH is a trademark of NETZSCH-Ger\u00e4tebau GmbH.\n\n## Features\n\n- **Fast Binary Parsing**: Optimized parsing with NumPy and PyArrow (0.1-1 sec/file)\n- **Complete Metadata**: Extract instrument settings, sample info, and experimental conditions\n- **Baseline Correction**: Automatic baseline subtraction with validation\n- **DTG Analysis**: Derivative thermogravimetry calculation with smoothing options\n- **Batch Processing**: Parallel processing of multiple files\n- **Data Export**: Convert to Parquet, CSV, and JSON formats\n- **CLI Support**: Command-line interface for automation\n\n## Installation\n\n```bash\npip install pyngb\n```\n\n## Quick Example\n\n```python\nfrom pyngb import read_ngb\nimport polars as pl\nimport json\n\n# Load NGB file with embedded metadata\ntable = read_ngb(\"experiment.ngb-ss3\")\ndf = pl.from_arrow(table)\n\n# Access data\nprint(f\"Loaded {df.height} data points\")\nprint(f\"Temperature range: {df['sample_temperature'].min():.1f} to {df['sample_temperature'].max():.1f} \u00b0C\")\n\n# Access metadata\nmetadata = json.loads(table.schema.metadata[b'file_metadata'])\nprint(f\"Sample: {metadata.get('sample_name', 'Unknown')}\")\n\n# Baseline correction\ncorrected = read_ngb(\"sample.ngb-ss3\", baseline_file=\"baseline.ngb-bs3\")\n\n# DTG analysis\nfrom pyngb.api.analysis import add_dtg\ntable_with_dtg = add_dtg(table, method=\"savgol\", smooth=\"medium\")\n```\n\n## Command Line Usage\n\n```bash\n# Convert single file\npython -m pyngb sample.ngb-ss3\n\n# Batch processing with baseline correction\npython -m pyngb *.ngb-ss3 -b baseline.ngb-bs3 -f parquet -o ./processed/\n\n# Get help\npython -m pyngb --help\n```\n\n## Documentation\n\n- **[Getting Started](docs/getting-started.md)** - Installation and first steps\n- **[User Guide](docs/user-guide.md)** - Core functionality and examples\n- **[API Reference](docs/api-reference.md)** - Complete function documentation\n- **[Troubleshooting](docs/troubleshooting.md)** - Common issues and solutions\n- **[Contributing](docs/contributing.md)** - Development guidelines\n\n## License\n\nMIT License. See [LICENSE.txt](LICENSE.txt) for details.\n\n## Support\n\n- **Issues**: [GitHub Issues](https://github.com/GraysonBellamy/pyngb/issues)\n- **Discussions**: [GitHub Discussions](https://github.com/GraysonBellamy/pyngb/discussions)\n\n---\n\nMade with \u2764\ufe0f for the scientific community\n",
"bugtrack_url": null,
"license": "MIT License\n \n Copyright (c) 2025-present GraysonBellamy <gbellamy@umd.edu>\n \n 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:\n \n The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.\n \n 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": "Unofficial parser for NETZSCH STA (Simultaneous Thermal Analysis) NGB instrument binary files. Not affiliated with, endorsed by, or approved by NETZSCH-Ger\u00e4tebau GmbH.",
"version": "0.1.1",
"project_urls": {
"Changelog": "https://github.com/GraysonBellamy/pyngb/blob/main/CHANGELOG.md",
"Documentation": "https://graysonbellamy.github.io/pyngb/",
"Homepage": "https://github.com/GraysonBellamy/pyngb",
"Issues": "https://github.com/GraysonBellamy/pyngb/issues",
"Repository": "https://github.com/GraysonBellamy/pyngb.git"
},
"split_keywords": [
"binary-parsing",
" netzsch",
" ngb",
" scientific-data",
" sta",
" thermal-analysis",
" unofficial"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "055110e3a3a651c4f07aa3a9594c9530027b416c3571657e28605c38ffb5ffde",
"md5": "69be47fc6eee7adacf15129da11e45e1",
"sha256": "ae8257ff96b8e9a2871185f8bfc03f0a29c53ab24e6dafefc1b41ee3fee5d308"
},
"downloads": -1,
"filename": "pyngb-0.1.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "69be47fc6eee7adacf15129da11e45e1",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 69915,
"upload_time": "2025-11-06T18:34:26",
"upload_time_iso_8601": "2025-11-06T18:34:26.350948Z",
"url": "https://files.pythonhosted.org/packages/05/51/10e3a3a651c4f07aa3a9594c9530027b416c3571657e28605c38ffb5ffde/pyngb-0.1.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "e0ecccd11557e239a51ef303aa1b74446f0fb0892ed062d317af2e99b10f9769",
"md5": "001b49c5ba60109984bf01c7d15d74dd",
"sha256": "6fbc98d37f3fb3929c0205b2b5e35e96aae0a63715d0ac86f989b2694531142d"
},
"downloads": -1,
"filename": "pyngb-0.1.1.tar.gz",
"has_sig": false,
"md5_digest": "001b49c5ba60109984bf01c7d15d74dd",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 1791000,
"upload_time": "2025-11-06T18:34:27",
"upload_time_iso_8601": "2025-11-06T18:34:27.840403Z",
"url": "https://files.pythonhosted.org/packages/e0/ec/ccd11557e239a51ef303aa1b74446f0fb0892ed062d317af2e99b10f9769/pyngb-0.1.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-11-06 18:34:27",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "GraysonBellamy",
"github_project": "pyngb",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "pyngb"
}
