# Abberior-STED
This package interfaces the ``specpy`` package provided by Abberior GmbH using simple functions to configure the microscope.
*This package is not maintained by Abberior.*
## Installation
Install the ``specpy`` package provided with the Imspector software for your specific python version.
### PyPI
Installation from PyPI is done with
```bash
pip install abberior-sted
```
### Local install
The repository can be cloned locally and installed in editable mode
```bash
git clone https://https://github.com/FLClab/Abberior-STED
pip install -e Abberior-STED
```
## Usage
One the repository is installed, the user may simply import ``abberior`` as such
```python
from abberior import microscope, user, utils
```
## Debug
There is a debug mode that was implemented for testing purposes when ``specpy`` is not installed on the current computer. This is interesting in cases where you want to test a new part of the code while not being on a real microscope. To use the debug mode, the user may simply import the ``abberior`` module as you would normally do
```python
>>> from abberior import microscope, user, utils
No module named 'specpy'
Calling these functions might raise an error.
Falling back to the debug files...
```
Raw data
{
"_id": null,
"home_page": null,
"name": "abberior-sted",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "abberior sted imspector specpy",
"author": null,
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/2a/48/2657275070a660690f0510c9a864f24a739c6b7eb8999c9f27d8360dc386/abberior-sted-0.0.3.tar.gz",
"platform": null,
"description": "# Abberior-STED\n\nThis package interfaces the ``specpy`` package provided by Abberior GmbH using simple functions to configure the microscope. \n\n*This package is not maintained by Abberior.*\n\n## Installation \n\nInstall the ``specpy`` package provided with the Imspector software for your specific python version.\n\n### PyPI\n\nInstallation from PyPI is done with\n```bash\npip install abberior-sted\n```\n\n### Local install\n\nThe repository can be cloned locally and installed in editable mode\n```bash\ngit clone https://https://github.com/FLClab/Abberior-STED\npip install -e Abberior-STED\n```\n\n## Usage\n\nOne the repository is installed, the user may simply import ``abberior`` as such\n```python \nfrom abberior import microscope, user, utils\n```\n\n## Debug \n\nThere is a debug mode that was implemented for testing purposes when ``specpy`` is not installed on the current computer. This is interesting in cases where you want to test a new part of the code while not being on a real microscope. To use the debug mode, the user may simply import the ``abberior`` module as you would normally do\n\n```python \n>>> from abberior import microscope, user, utils\nNo module named 'specpy'\nCalling these functions might raise an error.\n\nFalling back to the debug files...\n```\n",
"bugtrack_url": null,
"license": "CC-BY-4.0 license",
"summary": "Interface to Imspector control software for Abberior STED microscopes",
"version": "0.0.3",
"project_urls": {
"Documentation": "https://github.com/FLClab/Abberior-STED",
"Source": "https://github.com/FLClab/Abberior-STED"
},
"split_keywords": [
"abberior",
"sted",
"imspector",
"specpy"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "a72f057bb7294427e8566ccd8756de50d79e89e965e357d77c2f74170dcc02f6",
"md5": "a59cafaea7477ea66320b028875dd4ef",
"sha256": "a3a6be5d551bf8d6060a9304fe2d6af08057fde8a6fffa6ad7c64931699c2281"
},
"downloads": -1,
"filename": "abberior_sted-0.0.3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "a59cafaea7477ea66320b028875dd4ef",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 31441,
"upload_time": "2024-04-06T11:55:41",
"upload_time_iso_8601": "2024-04-06T11:55:41.382022Z",
"url": "https://files.pythonhosted.org/packages/a7/2f/057bb7294427e8566ccd8756de50d79e89e965e357d77c2f74170dcc02f6/abberior_sted-0.0.3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "2a482657275070a660690f0510c9a864f24a739c6b7eb8999c9f27d8360dc386",
"md5": "3aef81d19e9fc7c525d93371f21d2f49",
"sha256": "67de0e3a5d3856416a25e0912b56039296d3da23cb0da84ef4bee40f42347c91"
},
"downloads": -1,
"filename": "abberior-sted-0.0.3.tar.gz",
"has_sig": false,
"md5_digest": "3aef81d19e9fc7c525d93371f21d2f49",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 30582,
"upload_time": "2024-04-06T11:55:43",
"upload_time_iso_8601": "2024-04-06T11:55:43.035605Z",
"url": "https://files.pythonhosted.org/packages/2a/48/2657275070a660690f0510c9a864f24a739c6b7eb8999c9f27d8360dc386/abberior-sted-0.0.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-06 11:55:43",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "FLClab",
"github_project": "Abberior-STED",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "abberior-sted"
}
JSON
