pyucalgarysrs 1.0.0__tar.gz

pyucalgarysrs-1.0.0/LICENSE

@@ -0,0 +1,13 @@
+Copyright 2024 University of Calgary
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

pyucalgarysrs-1.0.0/PKG-INFO

@@ -0,0 +1,65 @@
+Metadata-Version: 2.1
+Name: pyucalgarysrs
+Version: 1.0.0
+Summary: Tools for interacting with UCalgary Space Remote Sensing data
+Home-page: https://github.com/ucalgary-srs/pyUCalgarySRS
+Author: Darren Chaddock
+Author-email: dchaddoc@ucalgary.ca
+Requires-Python: >=3.9
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Requires-Dist: h5py (>=3.1.0,<4.0.0)
+Requires-Dist: humanize (>=4.4.0,<5.0.0)
+Requires-Dist: joblib (>=1.0.0,<2.0.0)
+Requires-Dist: numpy (>=1.21.0,<2.0.0)
+Requires-Dist: opencv-python (>=4.4.0,<5.0.0)
+Requires-Dist: requests (>=2.28.0,<3.0.0)
+Requires-Dist: scipy (>=1.6.0,<2.0.0)
+Requires-Dist: texttable (>=1.6.4,<2.0.0)
+Requires-Dist: tqdm (>=4.61.2,<5.0.0)
+Project-URL: Repository, https://github.com/ucalgary-srs/pyUCalgarySRS
+Description-Content-Type: text/markdown
+
+# PyUCalgarySRS
+
+[![GitHub tests](https://github.com/ucalgary-srs/pyUCalgarySRS/actions/workflows/test_linux.yml/badge.svg)](https://github.com/ucalgary-srs/pyUCalgarySRS/actions/workflows/test_linux.yml)
+[![PyPI version](https://img.shields.io/pypi/v/pyucalgarysrs.svg)](https://pypi.python.org/pypi/pyucalgarysrs/)
+[![PyPI Python versions](https://img.shields.io/pypi/pyversions/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.
+
+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)
+
+## Installation
+
+Installation can be done using pip:
+
+```
+pip install pyucalgarysrs
+```
+
+If you want the most bleeding edge version of PyUCalgarySRS, you can install it directly from the Github repository:
+
+```console
+$ git clone https://github.com/ucalgary-srs/pyUCalgarySRS.git
+$ cd pyUCalgarySRS
+$ pip install .
+```
+
+## Usage
+
+Below is how the library can be imported:
+
+```python
+import pyucalgarysrs
+srs = pyucalgarysrs.PyUCalgarySRS()
+```
+

pyucalgarysrs-1.0.0/README.md

@@ -0,0 +1,39 @@
+# PyUCalgarySRS
+
+[![GitHub tests](https://github.com/ucalgary-srs/pyUCalgarySRS/actions/workflows/test_linux.yml/badge.svg)](https://github.com/ucalgary-srs/pyUCalgarySRS/actions/workflows/test_linux.yml)
+[![PyPI version](https://img.shields.io/pypi/v/pyucalgarysrs.svg)](https://pypi.python.org/pypi/pyucalgarysrs/)
+[![PyPI Python versions](https://img.shields.io/pypi/pyversions/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.
+
+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)
+
+## Installation
+
+Installation can be done using pip:
+
+```
+pip install pyucalgarysrs
+```
+
+If you want the most bleeding edge version of PyUCalgarySRS, you can install it directly from the Github repository:
+
+```console
+$ git clone https://github.com/ucalgary-srs/pyUCalgarySRS.git
+$ cd pyUCalgarySRS
+$ pip install .
+```
+
+## Usage
+
+Below is how the library can be imported:
+
+```python
+import pyucalgarysrs
+srs = pyucalgarysrs.PyUCalgarySRS()
+```

pyucalgarysrs-1.0.0/pyproject.toml

@@ -0,0 +1,86 @@
+[build-system]
+requires = ["poetry-core>=1.0.0"]
+build-backend = "poetry.core.masonry.api"
+
+[tool.poetry]
+name = "pyucalgarysrs"
+version = "1.0.0"
+description = "Tools for interacting with UCalgary Space Remote Sensing data"
+readme = "README.md"
+homepage = "https://github.com/ucalgary-srs/pyUCalgarySRS"
+repository = "https://github.com/ucalgary-srs/pyUCalgarySRS"
+authors = ["Darren Chaddock <dchaddoc@ucalgary.ca>"]
+# license = 
+packages = [
+    { include = "pyucalgarysrs" },
+]
+
+[tool.poetry.dependencies]
+python = ">=3.9"
+requests = "^2.28.0"
+humanize = "^4.4.0"
+texttable = "^1.6.4"
+tqdm = "^4.61.2"
+numpy = "^1.21.0"
+joblib = "^1.0.0"
+opencv-python = "^4.4.0"
+h5py = "^3.1.0"
+scipy = "^1.6.0"
+
+[tool.poetry.group.dev.dependencies]
+ruff = "0.4.9"
+pytest = "8.2.2"
+pycodestyle = "2.12.0"
+yapf = "0.40.2"
+pytest-xdist = "3.6.1"
+pytest-sugar = "1.0.0"
+pytest-cov = "5.0.0"
+bandit = "1.7.9"
+pyright = "1.1.367"
+pdoc3 = "0.10.0"
+
+[tool.ruff]
+line-length = 150
+lint.select = ["E", "F", "B", "N"]
+lint.ignore = [
+    "F403",  # `from .schemas import *` used; unable to detect undefined names
+    "F405",  # `Union` may be undefined, or defined from star imports
+    "B006",  # Do not use mutable data structures for argument defaults
+]
+exclude = ["pyucalgarysrs/__init__.py"]
+
+[tool.yapf]
+based_on_style = "pep8"
+column_limit = 150
+allow_split_before_dict_value = false
+
+[tool.yapfignore]
+ignore_patterns = [
+    "temp/**/*.py",
+]
+
+[tool.pyright]
+include = [
+    "pyucalgarysrs/**/*.py",
+]
+typeCheckingMode = "standard"
+
+[tool.pytest.ini_options]
+# addopts = -p no:warnings
+testpaths = [
+    "tests/test_suite/**/*.py",
+]
+markers = [
+    "top_level: top level PyUCalgarySRS object tests",
+    "data_datasets: data distribution dataset tests",
+    "data_observatories: data distribution observatory tests",
+    "data_geturls: data distribution get_urls tests",
+    "data_download: data distribution download tests",
+    "data_read: data distribution read tests",
+    "atm: auroral transport model tests",
+]
+
+[tool.bandit]
+exclude_dirs = ["src/test_suite"]
+tests = []
+skips = ["B110"]

pyucalgarysrs-1.0.0/pyucalgarysrs/__init__.py

@@ -0,0 +1,80 @@
+# Copyright 2024 University of Calgary
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+"""
+The PyUCalgarySRS library provides a way to interact with the UCalgary Space
+Remote Sensing (SRS) Open Data Platform. It enables users to programmatically
+download and read data, and utilize the TREx Auroral Transport Model (ATM). 
+This library leverages the UCalgary SRS API for some functions.
+
+For more information about the data available and usage examples, visit the 
+[Open Data Platform website](https://data.phys.ucalgary.ca).
+
+Installation:
+```console
+$ pip install pyucalgarysrs
+```
+
+Basic usage:
+```python
+> import pyucalgarysrs
+> srs = pyucalgarysrs.PyUCalgarySRS()
+```
+"""
+
+# versioning info
+__version__ = "1.0.0"
+
+# documentation
+__pdoc__ = {"pyucalgarysrs": False}
+__all__ = ["PyUCalgarySRS"]
+
+# pull in top level class
+from .pyucalgarysrs import PyUCalgarySRS
+
+# pull in exceptions
+from .exceptions import (
+    SRSError,
+    SRSInitializationError,
+    SRSPurgeError,
+    SRSAPIError,
+    SRSUnsupportedReadError,
+    SRSDownloadError,
+)
+
+# pull in schemas
+from .data.classes import (
+    Dataset,
+    FileListingResponse,
+    FileDownloadResult,
+    Calibration,
+    CalibrationGenerationInfo,
+    Data,
+    Skymap,
+    SkymapGenerationInfo,
+    ProblematicFile,
+    Observatory,
+)
+from .models.atm.classes_forward import (
+    ATMForwardOutputFlags,
+    ATMForwardRequest,
+    ATMForwardResult,
+    ATMForwardResultRequestInfo,
+)
+from .models.atm.classes_inverse import (
+    ATMInverseForwardParams,
+    ATMInverseOutputFlags,
+    ATMInverseRequest,
+    ATMInverseResult,
+    ATMInverseResultRequestInfo,
+)