# PyUCalgarySRS
[](https://github.com/ucalgary-srs/pyUCalgarySRS/actions/workflows/tests_default.yml)
[](https://pypi.python.org/pypi/pyucalgarysrs/)
[](https://pypi.python.org/pypi/pyucalgarysrs/)
This is the Python library for retrieving and loading data provided by UCalgary Space Remote Sensing. More information including tutorials and dataset descriptions can be found on our open data platform at https://data.phys.ucalgary.ca.
> [!NOTE]
> This library is primarily a sub-dependency for higher-level data access and analysis support libraries [PyAuroraX](https://github.com/aurorax-space/pyaurorax) and [PyUCRio](https://github.com/ucalgary-srs/pyUCRio). We recommend using those libraries for accessing and analyzing optical (all-sky imager, spectrograph) data and riometer data, respectively.
PyUCalagarySRS currently supports Python 3.9+.
Some links to help:
- [PyUCalgarySRS API Reference](https://docs-pyucalgarysrs.phys.ucalgary.ca)
- [Crib sheets that utilize PyUCalgarySRS](https://data.phys.ucalgary.ca/working_with_data/index.html#crib-sheets)
- [UCalgary Space Remote Sensing Open Data Platform](https://data.phys.ucalgary.ca)
- [Usage examples](https://github.com/ucalgary-srs/pyUCalgarySRS/tree/main/examples)
## Installation
Installation can be done using pip:
```console
$ pip install pyucalgarysrs
```
For the most bleeding edge version of PyUCalgarySRS, you can install it directly from the Github repository:
```console
$ pip install pyucalgarysrs@git+https://github.com/ucalgary-srs/pyUCalgarySRS
[OR]
$ git clone https://github.com/ucalgary-srs/pyUCalgarySRS.git
$ cd pyUCalgarySRS
$ pip install .
```
## Usage
Below is how the library can be imported and initialized:
```python
import pyucalgarysrs
srs = pyucalgarysrs.PyUCalgarySRS()
```
A large collection of examples can be found in the [`examples`](https://github.com/ucalgary-srs/pyUCalgarySRS/tree/main/examples) directory.
Raw data
{
"_id": null,
"home_page": "https://github.com/ucalgary-srs/pyUCalgarySRS",
"name": "pyucalgarysrs",
"maintainer": "Darren Chaddock",
"docs_url": null,
"requires_python": "<4,>=3.9",
"maintainer_email": "dchaddoc@ucalgary.ca",
"keywords": null,
"author": "Darren Chaddock",
"author_email": "dchaddoc@ucalgary.ca",
"download_url": "https://files.pythonhosted.org/packages/c5/e7/db090fe19b81f17efd59e2431c57fbf88e7e7df598d5e9c38d2c672c982d/pyucalgarysrs-1.19.0.tar.gz",
"platform": null,
"description": "# PyUCalgarySRS\n\n[](https://github.com/ucalgary-srs/pyUCalgarySRS/actions/workflows/tests_default.yml)\n[](https://pypi.python.org/pypi/pyucalgarysrs/)\n[](https://pypi.python.org/pypi/pyucalgarysrs/)\n\nThis is the Python library for retrieving and loading data provided by UCalgary Space Remote Sensing. More information including tutorials and dataset descriptions can be found on our open data platform at https://data.phys.ucalgary.ca.\n\n> [!NOTE]\n> This library is primarily a sub-dependency for higher-level data access and analysis support libraries [PyAuroraX](https://github.com/aurorax-space/pyaurorax) and [PyUCRio](https://github.com/ucalgary-srs/pyUCRio). We recommend using those libraries for accessing and analyzing optical (all-sky imager, spectrograph) data and riometer data, respectively.\n\nPyUCalagarySRS currently supports Python 3.9+.\n\nSome links to help:\n- [PyUCalgarySRS API Reference](https://docs-pyucalgarysrs.phys.ucalgary.ca)\n- [Crib sheets that utilize PyUCalgarySRS](https://data.phys.ucalgary.ca/working_with_data/index.html#crib-sheets)\n- [UCalgary Space Remote Sensing Open Data Platform](https://data.phys.ucalgary.ca)\n- [Usage examples](https://github.com/ucalgary-srs/pyUCalgarySRS/tree/main/examples)\n\n## Installation\n\nInstallation can be done using pip:\n\n```console\n$ pip install pyucalgarysrs\n```\n\nFor the most bleeding edge version of PyUCalgarySRS, you can install it directly from the Github repository:\n\n```console\n$ pip install pyucalgarysrs@git+https://github.com/ucalgary-srs/pyUCalgarySRS\n\n[OR]\n\n$ git clone https://github.com/ucalgary-srs/pyUCalgarySRS.git\n$ cd pyUCalgarySRS\n$ pip install .\n```\n\n## Usage\n\nBelow is how the library can be imported and initialized:\n\n```python\nimport pyucalgarysrs\nsrs = pyucalgarysrs.PyUCalgarySRS()\n```\n\nA large collection of examples can be found in the [`examples`](https://github.com/ucalgary-srs/pyUCalgarySRS/tree/main/examples) directory. \n",
"bugtrack_url": null,
"license": "Apache-2.0",
"summary": "Tools for interacting with UCalgary Space Remote Sensing data",
"version": "1.19.0",
"project_urls": {
"Homepage": "https://github.com/ucalgary-srs/pyUCalgarySRS",
"Repository": "https://github.com/ucalgary-srs/pyUCalgarySRS"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "1a594662a92b7b4da9110f3fdee298c7feca9b1a355a034857604f1c8df84c70",
"md5": "4ddd2c6217309e95b3bf5da522da796a",
"sha256": "049b27715490f59b2dea0ec6ef4ee0f58fde42ee71ebbcbc0d7b199623f22bf0"
},
"downloads": -1,
"filename": "pyucalgarysrs-1.19.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "4ddd2c6217309e95b3bf5da522da796a",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4,>=3.9",
"size": 93773,
"upload_time": "2025-02-11T01:02:49",
"upload_time_iso_8601": "2025-02-11T01:02:49.230033Z",
"url": "https://files.pythonhosted.org/packages/1a/59/4662a92b7b4da9110f3fdee298c7feca9b1a355a034857604f1c8df84c70/pyucalgarysrs-1.19.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "c5e7db090fe19b81f17efd59e2431c57fbf88e7e7df598d5e9c38d2c672c982d",
"md5": "0b837348b661f1f50c56c7c4a23ee6ac",
"sha256": "9d09b0fc8578ffe3ba25933ac3909f6ae7892fe7138382477c78fba8eb29ae8b"
},
"downloads": -1,
"filename": "pyucalgarysrs-1.19.0.tar.gz",
"has_sig": false,
"md5_digest": "0b837348b661f1f50c56c7c4a23ee6ac",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4,>=3.9",
"size": 54408,
"upload_time": "2025-02-11T01:02:51",
"upload_time_iso_8601": "2025-02-11T01:02:51.295467Z",
"url": "https://files.pythonhosted.org/packages/c5/e7/db090fe19b81f17efd59e2431c57fbf88e7e7df598d5e9c38d2c672c982d/pyucalgarysrs-1.19.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-02-11 01:02:51",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "ucalgary-srs",
"github_project": "pyUCalgarySRS",
"travis_ci": false,
"coveralls": true,
"github_actions": true,
"lcname": "pyucalgarysrs"
}
JSON
