# Intended Use
The Salient SDK is a convenience wrapper around Salient Predictions' customer-facing
[web API](https://api.salientpredictions.com/v2/documentation/api/). It also contains utility functions for manipulating and analyzing the data delivered from the API.
# Setting up the SDK
## Prerequisites
The Salient SDK requires Python 3.11 to use. If you have Python installed, you can check your version with:
```bash
python --version
```
To get version 3.11:
```bash
# Ubuntu:
sudo apt update
sudo apt install software-properties-common
sudo add-apt-repository ppa:deadsnakes/ppa
sudo apt update
sudo apt install python3.11
```
```bash
# macOS:
/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"
brew update
brew install python@3.11
```
## Installing the SDK
The easiest way to get the Salient SDK is to install it like any other package:
```bash
pip install salientsdk
```
# Usage
To access the Salient API you will need a `username` and `password` provided by
your Salient representative. The universal credentials `testusr` and `testpwd`
have limited permissions for testing and validation purposes:
```bash
python -m salientsdk.data_timeseries -lat 42 -lon -73 -fld all --start 2020-01-01 --end 2020-12-31 -u testusr -p testpwd
```
In a python script:
```python
import salientsdk as sk
import xarray as xr
import netcdf4
session = sk.login("testusr","testpwd")
history = sk.data_timeseries(loc = Location(lat=42, lon=-73), field="all", variable="temp")
print(xr.open_file(history))
```
See all available functions in the [API Reference](api.md).
The [examples](https://github.com/Salient-Predictions/salientsdk/tree/main/examples) directory contains `ipynb` notebooks to help you get started with common operations.
# License
This SDK is licensed for use by Salient customers [details](LICENSE.md).
Copyright 2024 [Salient Predictions](https://www.salientpredictions.com/)
Raw data
{
"_id": null,
"home_page": "https://salientpredictions.com",
"name": "salientsdk",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.11",
"maintainer_email": null,
"keywords": "weather, climate, forecasting, sdk, salient, s2s",
"author": "Salient Predictions",
"author_email": "help@salientpredictions.com",
"download_url": "https://files.pythonhosted.org/packages/21/ba/5acce3777bd67150befe6b45645430e5b67a1b9f96f45988ccc4569913a0/salientsdk-0.1.3.tar.gz",
"platform": null,
"description": "\n# Intended Use\n\nThe Salient SDK is a convenience wrapper around Salient Predictions' customer-facing \n[web API](https://api.salientpredictions.com/v2/documentation/api/). It also contains utility functions for manipulating and analyzing the data delivered from the API.\n\n# Setting up the SDK\n\n## Prerequisites \n\nThe Salient SDK requires Python 3.11 to use. If you have Python installed, you can check your version with:\n\n```bash\npython --version\n```\n\nTo get version 3.11:\n\n```bash\n# Ubuntu:\nsudo apt update\nsudo apt install software-properties-common\nsudo add-apt-repository ppa:deadsnakes/ppa\nsudo apt update\nsudo apt install python3.11\n```\n\n```bash\n# macOS:\n/bin/bash -c \"$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)\"\nbrew update\nbrew install python@3.11\n```\n\n## Installing the SDK\n\nThe easiest way to get the Salient SDK is to install it like any other package:\n\n```bash\npip install salientsdk\n```\n\n\n\n\n\n\n\n# Usage\n\nTo access the Salient API you will need a `username` and `password` provided by\nyour Salient representative. The universal credentials `testusr` and `testpwd` \nhave limited permissions for testing and validation purposes:\n\n```bash\npython -m salientsdk.data_timeseries -lat 42 -lon -73 -fld all --start 2020-01-01 --end 2020-12-31 -u testusr -p testpwd\n```\n\nIn a python script:\n\n```python\nimport salientsdk as sk\nimport xarray as xr\nimport netcdf4\n\nsession = sk.login(\"testusr\",\"testpwd\")\nhistory = sk.data_timeseries(loc = Location(lat=42, lon=-73), field=\"all\", variable=\"temp\")\nprint(xr.open_file(history))\n```\n\nSee all available functions in the [API Reference](api.md).\n\nThe [examples](https://github.com/Salient-Predictions/salientsdk/tree/main/examples) directory contains `ipynb` notebooks to help you get started with common operations. \n\n# License\n\nThis SDK is licensed for use by Salient customers [details](LICENSE.md).\n\n\nCopyright 2024 [Salient Predictions](https://www.salientpredictions.com/)\n",
"bugtrack_url": null,
"license": "docs/LICENSE.md",
"summary": "Salient Predictions Software Development Kit",
"version": "0.1.3",
"project_urls": {
"Documentation": "https://sdk.salientpredictions.com",
"Homepage": "https://salientpredictions.com",
"Repository": "https://github.com/Salient-Predictions/salientsdk"
},
"split_keywords": [
"weather",
" climate",
" forecasting",
" sdk",
" salient",
" s2s"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "7f18c4eedbc032b3c9161b217455d7c6348041a185de76407eac10a8da38161b",
"md5": "adee5afd7518f469a0b05a770e6b3105",
"sha256": "c7caeaf4700734efac8b2fb4635d94b2e0ab8f4b78f700e1f4fdc67278875574"
},
"downloads": -1,
"filename": "salientsdk-0.1.3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "adee5afd7518f469a0b05a770e6b3105",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.11",
"size": 17036,
"upload_time": "2024-04-03T14:20:56",
"upload_time_iso_8601": "2024-04-03T14:20:56.614166Z",
"url": "https://files.pythonhosted.org/packages/7f/18/c4eedbc032b3c9161b217455d7c6348041a185de76407eac10a8da38161b/salientsdk-0.1.3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "21ba5acce3777bd67150befe6b45645430e5b67a1b9f96f45988ccc4569913a0",
"md5": "ec8446665c31dbdce1987cd0caa38a36",
"sha256": "cdf6a34a2a5a73f75c6f004ab6eee6e2c419f68f14a643d1549689afbc5e1b82"
},
"downloads": -1,
"filename": "salientsdk-0.1.3.tar.gz",
"has_sig": false,
"md5_digest": "ec8446665c31dbdce1987cd0caa38a36",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.11",
"size": 12957,
"upload_time": "2024-04-03T14:20:58",
"upload_time_iso_8601": "2024-04-03T14:20:58.439974Z",
"url": "https://files.pythonhosted.org/packages/21/ba/5acce3777bd67150befe6b45645430e5b67a1b9f96f45988ccc4569913a0/salientsdk-0.1.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-03 14:20:58",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "Salient-Predictions",
"github_project": "salientsdk",
"github_not_found": true,
"lcname": "salientsdk"
}
JSON
