# SIF-Tools
SIF-Tools is a light-weight Python toolkit designed to read `.sif` data files from an Andor Solis spectrometer. This toolkit includes a set of utilities for opening, analyzing, and plotting data from `.sif` files, providing a convenient way to handle spectrometer data in scientific workflows.
This Toolkit borrows, and is adapted, from [sif_parser](https://github.com/fujiisoup/sif_parser) by [fujiisoup](https://github.com/fujiisoup).
## Features
- **Read .sif files:** Efficiently load and parse `.sif` files from Andor Solis spectrometers.
- **Data manipulation:** Tools for handling and processing spectrometer data.
- **Visualization:** Plot data directly from `.sif` files.
## Requirements
- Python >= 3.6
- NumPy
- Scipy
## Installation
* Pip install
```bash
pip install sif-toolkit
```
* Clone the repository
```bash
git clone https://github.com/BjornFS/SIF-Toolkit.git
```
## Usage
### Importing SIF-Tools in a Python Script
Calling functions directly:
```python
from sif_tools import sif2array
file = '/Users/user/location/file.sif'
data = sif2array(target=file, reduce_noise=False, window='narrow')
```
or
```python
from sif_tools import hyperspectrum
bg = 'test_background.sif'
directory = 'UnitTests/UnitTest files'
data = hyperspectrum(directory = directory, background = bg, size = (4,4), reduce_noise=True, window='pinched')
```
which produces the data structure to create:
See [examples](https://github.com/BjornFS/SIF-Tools/tree/main/examples) for more functions and usage.
## Support
If you encounter any issues or have questions, feel free to open an issue on the [GitHub repository](https://github.com/yourusername/SIF-Toolkit/issues).
## Contributing
We welcome contributions! Please fork the repository and submit pull requests.
## Authors
- Bjorn Schroder, Technical University of Denmark
- Bjornfschroder@gmail.com
Raw data
{
"_id": null,
"home_page": "https://github.com/BjornFS/SIF-Tools",
"name": "sif-tools",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": null,
"keywords": null,
"author": "Bjorn F. Schroder N.",
"author_email": "Bjornfschroder@gmail.com",
"download_url": null,
"platform": null,
"description": "# SIF-Tools\n\nSIF-Tools is a light-weight Python toolkit designed to read `.sif` data files from an Andor Solis spectrometer. This toolkit includes a set of utilities for opening, analyzing, and plotting data from `.sif` files, providing a convenient way to handle spectrometer data in scientific workflows.\n\nThis Toolkit borrows, and is adapted, from [sif_parser](https://github.com/fujiisoup/sif_parser) by [fujiisoup](https://github.com/fujiisoup). \n\n## Features\n\n- **Read .sif files:** Efficiently load and parse `.sif` files from Andor Solis spectrometers.\n- **Data manipulation:** Tools for handling and processing spectrometer data.\n- **Visualization:** Plot data directly from `.sif` files.\n\n## Requirements\n\n- Python >= 3.6\n- NumPy\n- Scipy\n\n## Installation\n\n* Pip install\n```bash\npip install sif-toolkit\n```\n\n* Clone the repository\n```bash\ngit clone https://github.com/BjornFS/SIF-Toolkit.git\n```\n\n## Usage\n\n### Importing SIF-Tools in a Python Script\n\nCalling functions directly:\n\n```python \nfrom sif_tools import sif2array\n\nfile = '/Users/user/location/file.sif'\ndata = sif2array(target=file, reduce_noise=False, window='narrow')\n```\n\nor \n\n```python \nfrom sif_tools import hyperspectrum\n\nbg = 'test_background.sif'\ndirectory = 'UnitTests/UnitTest files'\n\ndata = hyperspectrum(directory = directory, background = bg, size = (4,4), reduce_noise=True, window='pinched')\n```\n\nwhich produces the data structure to create:\n\n\n\n\n\nSee [examples](https://github.com/BjornFS/SIF-Tools/tree/main/examples) for more functions and usage.\n\n\n\n\n## Support\n\nIf you encounter any issues or have questions, feel free to open an issue on the [GitHub repository](https://github.com/yourusername/SIF-Toolkit/issues).\n\n## Contributing\n\nWe welcome contributions! Please fork the repository and submit pull requests.\n\n## Authors\n\n- Bjorn Schroder, Technical University of Denmark\n- Bjornfschroder@gmail.com\n",
"bugtrack_url": null,
"license": null,
"summary": "A light-weight package for Andor SIF file analysis",
"version": "1.1.18",
"project_urls": {
"Homepage": "https://github.com/BjornFS/SIF-Tools"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "f3c15e795e87fa1e1b1f9ee3688a078b3c8fd2b4b1810d6fedc5609f6f59de40",
"md5": "ae591e384d4a02911649c92271bdd1c4",
"sha256": "a5e428ef063e10677c8ccccd2cb20b0616d23535d3df02b35372ad3309fea71e"
},
"downloads": -1,
"filename": "sif_tools-1.1.18-py3-none-any.whl",
"has_sig": false,
"md5_digest": "ae591e384d4a02911649c92271bdd1c4",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.6",
"size": 16288,
"upload_time": "2024-08-28T08:38:34",
"upload_time_iso_8601": "2024-08-28T08:38:34.585814Z",
"url": "https://files.pythonhosted.org/packages/f3/c1/5e795e87fa1e1b1f9ee3688a078b3c8fd2b4b1810d6fedc5609f6f59de40/sif_tools-1.1.18-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-08-28 08:38:34",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "BjornFS",
"github_project": "SIF-Tools",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "sif-tools"
}
JSON
