# CYGNSS Library
CYGNSS Library is a Python package for working with CYGNSS data. The package can be used for downloading SRTM data. Please see How to use the package for more details.
## Installation
you can install it using `pip`.
```console
pip install -U cygnsslib
```
or you can clone the repository and install it using the following command
```console
pip install .
```
To use it with anaconda, install the environment as follows:
```console
conda create -n cygnss
source activate cygnss
conda install -c conda-forge --file requiremnts.txt
```
You can then remove the local copy if you wish. Alternatively, if you wish to be able to make changes to your local copy without having to reinstall the package for the changes to take effect (e.g., for development purposes), you can use the following instead:
```console
pip uninstall cygnsslib
```
### Required packages
Here the required Python packages:
```console
gdal geographiclib lxml matplotlib netcdf4 numpy openpyxl pandas pysftp requests tqdm paramiko
```
Note: `gdal` can be installed using conda
```console
conda install -c conda-forge gdal
```
or using [this method](https://mothergeo-py.readthedocs.io/en/latest/development/how-to/gdal-ubuntu-pkg.html) in Ubuntu
Also, you need the modified data-subscriber package from [https://github.com/MiXIL/data-subscriber](https://github.com/MiXIL/data-subscriber)
## How to Use The Package
The cygnsslib has several modules:
1. Identify CYGNSS DDMs within a specific region
2. Group DDMs within a specific distance
3. Download CYGNSS antenna pattern
4. CygDdmId Class, which work as CYGNSS DDM ID
5. Download CYGNSS data from PO.DAAC
6. Download SRTM data from NASA Earth Data
7. Other functionality related to CYGNSS data
For most of the library, you need to set the environment variable ``CYGNSS_L1_PATH`` to the path of the CYGNSS L1 data. i.e.
```console
CYGNSS_L1_PATH=/cygnss_data/L1/v3.1
```
Note the folder needs to be named as the version (e.g. `v3.1`)name in PODAAC, and the parent folder need to be `L1`
You can set the environment variable for the session in python as follows:
```python
import os
os.environ['CYGNSS_L1_PATH'] = '/cygnss_data/L1/v3.1'
```
For SRTM you can specify the main path by specifying the environment variable ``SRTM_PATH``. The files will be saved in `SRTM_PATH\hgt`
### Identify CYGNSS DDMs within a specific region
There are several ways to find the DDM within a region.
1. find all the DDMs that their SP location within a specific distance from a specific location.
2. find all the DDMs that their SP location is within the polygon in the specified kml file.
Below an example of the usage:
```python
import cygnsslib
import numpy as np
import datetime as dt
# this will make the strip get the path from os.environ["CYGNSS_L1_PATH"]
cygnss_l1_path = None
year = 2019
days_list = np.arange(1, 100)
ref_pos = (37.1906, -105.9921) # (lat,long)
radius = 10e3 # [m]
thesh_ddm_snr = 3.0 # split DDMs into above thesh_ddm_snr and below thesh_ddm_snr. Above this value the DDM image will be saved
thesh_noise = 1 # noise threshold, each pixel in the DDM below this value will be replaced by this value
kml_out_tag = f'my_data' # tag for all the output files, ex: my_data_above_thresh.kml
save_podaac_pass = True # if True and download_cygnss_data is True the PO DAAC username/password will be saved
# The default options are:
options = {'save_cvs': False,
'save_ddm_img': True,
'plt_tag': '',
'title_img_inc_ddm_time': False,
'img_save_type': ['png'],
'sheet_type': 'xls'}
out_folder_path = 'my_ddms'
cygnsslib.write_sp_within_radius(cygnss_l1_path, year, days_list, ref_pos, radius,
out_folder_path, kml_out_tag, thesh_ddm_snr, thesh_noise,
download_cygnss_data=True, out_options=options)
start_date = dt.date(year=2019, month=1, day=1)
end_date = dt.date(year=2019, month=6, day=10) # the end date included in the search
cygnsslib.write_sp_within_radius_between_dates(cygnss_l1_path, start_date, end_date, ref_pos=ref_pos,
radius=radius, out_folder_path=f'', out_file_tag=kml_out_tag, thresh_ddm_snr=thesh_ddm_snr,
plt_thresh_noise=thesh_noise, download_cygnss_data=True,
out_options=options, save_podaac_pass=save_podaac_pass)
in_kml = f'my_poly.kml'
cygnsslib.write_sp_from_kml(cygnss_l1_path, year, days_list, in_kml=in_kml, out_folder_path=f'', out_file_tag=kml_out_tag,
thresh_ddm_snr=thesh_ddm_snr, plt_thresh_noise=thesh_noise, download_cygnss_data=True,
out_options=options, save_podaac_pass=save_podaac_pass)
cygnsslib.write_sp_from_kml_between_dates(cygnss_l1_path, start_date, end_date, in_kml=in_kml, out_folder_path=f'', out_file_tag=kml_out_tag,
thresh_ddm_snr=thesh_ddm_snr, plt_thresh_noise=thesh_noise, download_cygnss_data=True,
out_options=options, save_podaac_pass=save_podaac_pass)
```
### Group DDMs within a specific distance
This will group DDMs within specific distance in one group. The kml file need to be the output of `write_sp_from_kml()` or `write_sp_within_radius_between_dates()` or `write_sp_from_kml()` or `write_sp_from_kml_between_dates()`
This function need to be used after identifying the DDMs within a specific region
```python
import cygnsslib
in_kml = f'my_data_above_thresh.kml'
max_dist = 1e3
out_kml = f'{in_kml[:-4]}_grp{max_dist:d}'
cygnsslib.group_sp_within_distance(in_kml, out_kml, max_dist, save_csv=True, sheet_type=f'xls')
```
### Download CYGNSS antenna pattern
This function will download cygnss antenna patterns
```python
import cygnsslib
antenna_patterns_folder_path = f'/data/cygnss_antenna_patterns'
cygnsslib.download_cyg_antenna_patterns(antenna_patterns_folder_path)
```
### CygDdmId Class
The ``CygDdmId`` class is basically work as an ID for the DDMs, with some features.
There are multiple static functions, which are
1. `get_land_prod_info_from_ocean_prod()`
2. `find_cygnss_file()`
3. `get_sample_id_from_time_rltv_tcs()`
4. `cyg_id_list_from_kml()`
The function `cyg_id_list_from_kml()` generate a list of objects of `CygDdmId` from a kml file. The kml file from The kml file need to be the output of `write_sp_from_kml()` or `write_sp_within_radius_between_dates()` or `write_sp_from_kml()` or `write_sp_from_kml_between_dates()`
#### Input parameters
THe input parameters are:
1. `file_name` [req]: `None` or the file name. It's better to set it to `None`.
2. `year` [req]: data year
3. `day` [req]: day of the year
4. `sc_num` [req]: spacecraft id, (1-8)
5. `ch_id` [req]: channel id (1-4)
6. `samp_id` [req]: sample id (zero-based)
7. `land_samp_id` [optional]: sample id of the land product (zero-based)
8. `sample_time_sec` [optional]: time (in seconds) of the selected DDM (sample) from the beginning of the day
9. `land_file_name` [optional]: land product file name
10. `ddm_tag` [optional]: DDM tag
### Methods
The current implemented methods are:
1. `set_land_sample_id()`: set `land_samp_id`
2. `set_ddm_time()`: set `sample_time_sec`
3. `set_land_file_name()`: set `land_file_name`
4. `fill_file_name()`: fill file name automatically
5. `fill_land_parameters()`: fill land product parameters, which are `land_file_name`, `land_samp_id` and `sample_time_sec`
6. `get_utc_time()`: return DDM time
### Examples
There are many usage for this class here few
```python
from cygnsslib import CygDdmId
year = 2019
day = 123
sc_num = 2
ch_id = 3
sample_id = 440
cyg_ddm_id = CygDdmId.CygDdmId(None, year, day, sc_num, ch_id, sample_id)
```
```python
from cygnsslib import CygDdmId
in_kml = f'my_data_above_thresh.kml'
cyg_ddmid_list = CygDdmId.cyg_id_list_from_kml(in_kml)
for cyg_ddmid in cyg_ddmid_list:
cyg_ddmid.fill_file_name()
cyg_ddmid.fill_land_parameters(l1_land_folder_name=f'v3Land')
```
### Download CYGNSS data from PO.DAAC
You can download both the standard DDMs and the rawif data. You can choose to download data between two dates or a list of days in the year.
If a file exists, the code will not re-download it.
Note if you select `check_md5_exist_file=True`, then the code will do an md5 check for existing files. This will ensure existing files are good. However, this will make it very slow.
Below an example of downloading DDMs and the rawif files. The files will be organized as they're in PODAAC.
```python
from cygnsslib import cygnss_download
import datetime as dt
import numpy as np
# Download data in the same year and range of days
days_list = np.arange(5, 10)
data_year = 2020
# list_sc_num = [3]
list_sc_num = None # Will download all the 8 spacecrafts
cyg_data_ver = f'v3.1'
cygnss_download.download_cyg_files(data_year, days_list, list_sc_num, cyg_data_ver, cyg_data_lvl=f'L1', checksum_exist_file=False)
# Downloading data between two dates (including end date)
st_date = dt.date(year=2019, month=1, day=12)
end_date = dt.date(year=2020, month=1, day=3)
cygnss_download.download_cyg_files_between_date(st_date, end_date, list_sc_num, cyg_data_ver=cyg_data_ver, cyg_data_lvl=f'L1',
checksum_exist_file=False)
# Downloading rawif data
download_l1_data = True # This will download the corresponding L1 data
cygnss_download.download_cyg_rawif_files(data_year, days_list, list_sc_num, save_podaac_pass=True,
download_l1_data=download_l1_data)
cygnss_download.download_rawif_cyg_files_between_date(st_date, end_date, list_sc_num, save_podaac_pass=True,
download_l1_data=download_l1_data)
```
#### PODAAC user/pass related notes
You can get the PO.DAAC Drive API Credentials from https://podaac-tools.jpl.nasa.gov/drive/
If you entered the wrong PODAAC user/pass, you'll be asked to re-enter them again. However, you need to re-start the code after that so the saved user/pass are loaded again.
You can reset your PODAAC user/pass and enter new user/pass using the following code. Note when you run the code, you'll be asked to enter the new user/pass
Note: if you want to remove the current user/pass, set `save_pass=False`
```python
from cygnsslib import cygnss_download
cygnss_download.get_podaac_cred(save_pass=True, reset_pass=True)
```
### Download SRTM data from NASA Earth Data
The files are in this URL: https://e4ftl01.cr.usgs.gov/MEASURES/SRTMGL1.003/2000.02.11/
The username/password can be obtained from https://urs.earthdata.nasa.gov/home
```python
from cygnsslib import srtm_download
import os
os.environ['SRTM_PATH'] = '/data/srtm_data' # The files will be downloaded into SRTM_PATH/hgt path
files_lat = [21, 22, 20]
files_lon = [29, 30]
srtm_download.download_srtm_ght_files(files_lat, files_lon, save_pass=True, unzipfile=False, remove_zippedfile=True)
```
#### EarthData username and pass related notes
You can reset your EarthData user/pass and enter new user/pass using the following code. Note when you run the code, you'll be asked to enter the new user/pass
```python
from cygnsslib import srtm_download
srtm_download.get_earthdata_cred()
```
### Other functionality related to CYGNSS data
Create a circle or a square on the ground and export it to kml file
```python
import cygnsslib
ref_pos = [37.1906, -105.9921] # [lat,long]
radius = 10e3 # [m]
out_kml = f'my_circle.kml'
cygnsslib.create_centered_polygon(ref_pos, radius, out_kml, shape=f"circle")
```
Create a kml file from a list of positions
```python
import cygnsslib
import numpy as np
lyr_name = f"my_pos"
point_names = ["Y1", "Y2", "Y3"]
loc_list = np.array([[-34.0, 145.0], [-34.0, 146.0], [-34.0, 148]])
out_kml = f"my_pos.kml"
cygnsslib.create_kml_from_list_points(loc_list, loc_names=point_names, out_kml=out_kml, lyr_name=lyr_name)
```
Get DDMs info from the kml file. The kml file need to be the output of `write_sp_from_kml()` or `write_sp_within_radius_between_dates()` or `write_sp_from_kml()` or `write_sp_from_kml_between_dates()`
The main goal of this function is extract the DDMs' parameters from the kml file. See ``CygDdmId`` Class for more functionality
```python
import cygnsslib
ddm_list = cygnsslib.get_list_ddm_info_from_kml(in_kml=f'my_data_above_thresh.kml')
```
Find CYGNSS Land product (experimental) from the standard ocean product. This function is still in developing.
```python
import cygnsslib
xls_in = f'my_xls.xlsx'
cygnsslib.find_land_prod_sample_id_from_excel(xls_in, xls_out=None, start_col=1, st_row=1)
```
## Contact Info
For more info, please contact:
Amer Melebari
Microwave Systems, Sensors and Imaging Lab (MiXiL)
University of Southern California
amelebar[AT]usc.edu
Raw data
{
"_id": null,
"home_page": "https://bitbucket.org/usc_mixil/cygnsslib",
"name": "cygnsslib",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": "",
"keywords": "",
"author": "Amer Melebari and James D. Campbell",
"author_email": "amelebar@usc.edu",
"download_url": "https://files.pythonhosted.org/packages/cc/84/407f6fc290ed8734338aacbe48d8ceaff9bb52b8d621666d7fb7aa6956ba/cygnsslib-1.3.5.tar.gz",
"platform": null,
"description": "# CYGNSS Library\n\nCYGNSS Library is a Python package for working with CYGNSS data. The package can be used for downloading SRTM data. Please see How to use the package for more details.\n\n\n## Installation\nyou can install it using `pip`.\n\n```console\npip install -U cygnsslib\n```\nor you can clone the repository and install it using the following command\n```console\npip install . \n```\nTo use it with anaconda, install the environment as follows:\n```console\nconda create -n cygnss \nsource activate cygnss \nconda install -c conda-forge --file requiremnts.txt\n```\nYou can then remove the local copy if you wish. Alternatively, if you wish to be able to make changes to your local copy without having to reinstall the package for the changes to take effect (e.g., for development purposes), you can use the following instead:\n```console\npip uninstall cygnsslib\n```\n### Required packages\nHere the required Python packages:\n```console\ngdal geographiclib lxml matplotlib netcdf4 numpy openpyxl pandas pysftp requests tqdm paramiko\n```\nNote: `gdal` can be installed using conda \n```console\nconda install -c conda-forge gdal \n```\nor using [this method](https://mothergeo-py.readthedocs.io/en/latest/development/how-to/gdal-ubuntu-pkg.html) in Ubuntu \nAlso, you need the modified data-subscriber package from [https://github.com/MiXIL/data-subscriber](https://github.com/MiXIL/data-subscriber) \n\n## How to Use The Package \nThe cygnsslib has several modules: \n1. Identify CYGNSS DDMs within a specific region \n2. Group DDMs within a specific distance \n3. Download CYGNSS antenna pattern \n4. CygDdmId Class, which work as CYGNSS DDM ID \n5. Download CYGNSS data from PO.DAAC \n6. Download SRTM data from NASA Earth Data \n7. Other functionality related to CYGNSS data \n\nFor most of the library, you need to set the environment variable ``CYGNSS_L1_PATH`` to the path of the CYGNSS L1 data. i.e. \n```console \nCYGNSS_L1_PATH=/cygnss_data/L1/v3.1\n``` \nNote the folder needs to be named as the version (e.g. `v3.1`)name in PODAAC, and the parent folder need to be `L1`\nYou can set the environment variable for the session in python as follows: \n```python \nimport os\nos.environ['CYGNSS_L1_PATH'] = '/cygnss_data/L1/v3.1'\n```\n\nFor SRTM you can specify the main path by specifying the environment variable ``SRTM_PATH``. The files will be saved in `SRTM_PATH\\hgt`\n### Identify CYGNSS DDMs within a specific region\n\nThere are several ways to find the DDM within a region. \n1. find all the DDMs that their SP location within a specific distance from a specific location. \n2. find all the DDMs that their SP location is within the polygon in the specified kml file. \n\nBelow an example of the usage:\n\n```python\nimport cygnsslib\nimport numpy as np\nimport datetime as dt\n\n# this will make the strip get the path from os.environ[\"CYGNSS_L1_PATH\"]\ncygnss_l1_path = None \nyear = 2019\ndays_list = np.arange(1, 100)\nref_pos = (37.1906, -105.9921) # (lat,long)\nradius = 10e3 # [m]\nthesh_ddm_snr = 3.0 # split DDMs into above thesh_ddm_snr and below thesh_ddm_snr. Above this value the DDM image will be saved\nthesh_noise = 1 # noise threshold, each pixel in the DDM below this value will be replaced by this value\nkml_out_tag = f'my_data' # tag for all the output files, ex: my_data_above_thresh.kml\nsave_podaac_pass = True # if True and download_cygnss_data is True the PO DAAC username/password will be saved\n# The default options are: \noptions = {'save_cvs': False,\n 'save_ddm_img': True,\n 'plt_tag': '',\n 'title_img_inc_ddm_time': False,\n 'img_save_type': ['png'],\n 'sheet_type': 'xls'}\n\nout_folder_path = 'my_ddms'\ncygnsslib.write_sp_within_radius(cygnss_l1_path, year, days_list, ref_pos, radius, \n out_folder_path, kml_out_tag, thesh_ddm_snr, thesh_noise, \n download_cygnss_data=True, out_options=options)\n\nstart_date = dt.date(year=2019, month=1, day=1)\nend_date = dt.date(year=2019, month=6, day=10) # the end date included in the search\ncygnsslib.write_sp_within_radius_between_dates(cygnss_l1_path, start_date, end_date, ref_pos=ref_pos,\n radius=radius, out_folder_path=f'', out_file_tag=kml_out_tag, thresh_ddm_snr=thesh_ddm_snr,\n plt_thresh_noise=thesh_noise, download_cygnss_data=True,\n out_options=options, save_podaac_pass=save_podaac_pass)\n\nin_kml = f'my_poly.kml'\ncygnsslib.write_sp_from_kml(cygnss_l1_path, year, days_list, in_kml=in_kml, out_folder_path=f'', out_file_tag=kml_out_tag,\n thresh_ddm_snr=thesh_ddm_snr, plt_thresh_noise=thesh_noise, download_cygnss_data=True,\n out_options=options, save_podaac_pass=save_podaac_pass)\ncygnsslib.write_sp_from_kml_between_dates(cygnss_l1_path, start_date, end_date, in_kml=in_kml, out_folder_path=f'', out_file_tag=kml_out_tag,\n thresh_ddm_snr=thesh_ddm_snr, plt_thresh_noise=thesh_noise, download_cygnss_data=True,\n out_options=options, save_podaac_pass=save_podaac_pass)\n```\n\n### Group DDMs within a specific distance\n\nThis will group DDMs within specific distance in one group. The kml file need to be the output of `write_sp_from_kml()` or `write_sp_within_radius_between_dates()` or `write_sp_from_kml()` or `write_sp_from_kml_between_dates()` \nThis function need to be used after identifying the DDMs within a specific region\n\n```python\nimport cygnsslib\n\nin_kml = f'my_data_above_thresh.kml'\nmax_dist = 1e3\nout_kml = f'{in_kml[:-4]}_grp{max_dist:d}'\ncygnsslib.group_sp_within_distance(in_kml, out_kml, max_dist, save_csv=True, sheet_type=f'xls')\n```\n\n### Download CYGNSS antenna pattern\nThis function will download cygnss antenna patterns\n\n```python\nimport cygnsslib\nantenna_patterns_folder_path = f'/data/cygnss_antenna_patterns'\ncygnsslib.download_cyg_antenna_patterns(antenna_patterns_folder_path)\n```\n\n### CygDdmId Class \nThe ``CygDdmId`` class is basically work as an ID for the DDMs, with some features. \nThere are multiple static functions, which are \n1. `get_land_prod_info_from_ocean_prod()` \n2. `find_cygnss_file()` \n3. `get_sample_id_from_time_rltv_tcs()` \n4. `cyg_id_list_from_kml()` \n\nThe function `cyg_id_list_from_kml()` generate a list of objects of `CygDdmId` from a kml file. The kml file from The kml file need to be the output of `write_sp_from_kml()` or `write_sp_within_radius_between_dates()` or `write_sp_from_kml()` or `write_sp_from_kml_between_dates()`\n\n#### Input parameters\nTHe input parameters are: \n1. `file_name` [req]: `None` or the file name. It's better to set it to `None`. \n2. `year` [req]: data year \n3. `day` [req]: day of the year \n4. `sc_num` [req]: spacecraft id, (1-8) \n5. `ch_id` [req]: channel id (1-4) \n6. `samp_id` [req]: sample id (zero-based) \n7. `land_samp_id` [optional]: sample id of the land product (zero-based) \n8. `sample_time_sec` [optional]: time (in seconds) of the selected DDM (sample) from the beginning of the day \n9. `land_file_name` [optional]: land product file name \n10. `ddm_tag` [optional]: DDM tag \n\n\n### Methods \nThe current implemented methods are: \n1. `set_land_sample_id()`: set `land_samp_id` \n2. `set_ddm_time()`: set `sample_time_sec` \n3. `set_land_file_name()`: set `land_file_name` \n4. `fill_file_name()`: fill file name automatically \n5. `fill_land_parameters()`: fill land product parameters, which are `land_file_name`, `land_samp_id` and `sample_time_sec` \n6. `get_utc_time()`: return DDM time \n\n### Examples \nThere are many usage for this class here few \n\n```python\nfrom cygnsslib import CygDdmId\nyear = 2019\nday = 123\nsc_num = 2\nch_id = 3\nsample_id = 440\ncyg_ddm_id = CygDdmId.CygDdmId(None, year, day, sc_num, ch_id, sample_id)\n```\n\n\n```python\nfrom cygnsslib import CygDdmId\n\nin_kml = f'my_data_above_thresh.kml'\ncyg_ddmid_list = CygDdmId.cyg_id_list_from_kml(in_kml)\nfor cyg_ddmid in cyg_ddmid_list:\n cyg_ddmid.fill_file_name()\n cyg_ddmid.fill_land_parameters(l1_land_folder_name=f'v3Land')\n```\n\n### Download CYGNSS data from PO.DAAC\n\nYou can download both the standard DDMs and the rawif data. You can choose to download data between two dates or a list of days in the year. \nIf a file exists, the code will not re-download it. \nNote if you select `check_md5_exist_file=True`, then the code will do an md5 check for existing files. This will ensure existing files are good. However, this will make it very slow.\n\nBelow an example of downloading DDMs and the rawif files. The files will be organized as they're in PODAAC.\n\n```python\nfrom cygnsslib import cygnss_download\nimport datetime as dt\nimport numpy as np\n\n# Download data in the same year and range of days\ndays_list = np.arange(5, 10)\ndata_year = 2020\n# list_sc_num = [3]\nlist_sc_num = None # Will download all the 8 spacecrafts \ncyg_data_ver = f'v3.1'\ncygnss_download.download_cyg_files(data_year, days_list, list_sc_num, cyg_data_ver, cyg_data_lvl=f'L1', checksum_exist_file=False)\n# Downloading data between two dates (including end date)\nst_date = dt.date(year=2019, month=1, day=12)\nend_date = dt.date(year=2020, month=1, day=3)\n\ncygnss_download.download_cyg_files_between_date(st_date, end_date, list_sc_num, cyg_data_ver=cyg_data_ver, cyg_data_lvl=f'L1',\n checksum_exist_file=False)\n\n# Downloading rawif data \ndownload_l1_data = True # This will download the corresponding L1 data\ncygnss_download.download_cyg_rawif_files(data_year, days_list, list_sc_num, save_podaac_pass=True,\n download_l1_data=download_l1_data)\ncygnss_download.download_rawif_cyg_files_between_date(st_date, end_date, list_sc_num, save_podaac_pass=True,\n download_l1_data=download_l1_data)\n\n```\n#### PODAAC user/pass related notes\nYou can get the PO.DAAC Drive API Credentials from https://podaac-tools.jpl.nasa.gov/drive/ \nIf you entered the wrong PODAAC user/pass, you'll be asked to re-enter them again. However, you need to re-start the code after that so the saved user/pass are loaded again. \n\nYou can reset your PODAAC user/pass and enter new user/pass using the following code. Note when you run the code, you'll be asked to enter the new user/pass \n\nNote: if you want to remove the current user/pass, set `save_pass=False` \n```python\nfrom cygnsslib import cygnss_download\n\ncygnss_download.get_podaac_cred(save_pass=True, reset_pass=True) \n```\n\n### Download SRTM data from NASA Earth Data\nThe files are in this URL: https://e4ftl01.cr.usgs.gov/MEASURES/SRTMGL1.003/2000.02.11/ \nThe username/password can be obtained from https://urs.earthdata.nasa.gov/home \n\n```python\nfrom cygnsslib import srtm_download\nimport os\nos.environ['SRTM_PATH'] = '/data/srtm_data' # The files will be downloaded into SRTM_PATH/hgt path\nfiles_lat = [21, 22, 20]\nfiles_lon = [29, 30]\nsrtm_download.download_srtm_ght_files(files_lat, files_lon, save_pass=True, unzipfile=False, remove_zippedfile=True) \n\n\n```\n#### EarthData username and pass related notes \nYou can reset your EarthData user/pass and enter new user/pass using the following code. Note when you run the code, you'll be asked to enter the new user/pass\n\n```python\nfrom cygnsslib import srtm_download\n\nsrtm_download.get_earthdata_cred() \n```\n### Other functionality related to CYGNSS data \n\nCreate a circle or a square on the ground and export it to kml file \n```python\nimport cygnsslib\nref_pos = [37.1906, -105.9921] # [lat,long]\nradius = 10e3 # [m]\nout_kml = f'my_circle.kml'\ncygnsslib.create_centered_polygon(ref_pos, radius, out_kml, shape=f\"circle\")\n```\nCreate a kml file from a list of positions \n```python\nimport cygnsslib\nimport numpy as np\nlyr_name = f\"my_pos\"\npoint_names = [\"Y1\", \"Y2\", \"Y3\"]\nloc_list = np.array([[-34.0, 145.0], [-34.0, 146.0], [-34.0, 148]])\nout_kml = f\"my_pos.kml\"\ncygnsslib.create_kml_from_list_points(loc_list, loc_names=point_names, out_kml=out_kml, lyr_name=lyr_name)\n```\n\nGet DDMs info from the kml file. The kml file need to be the output of `write_sp_from_kml()` or `write_sp_within_radius_between_dates()` or `write_sp_from_kml()` or `write_sp_from_kml_between_dates()`\nThe main goal of this function is extract the DDMs' parameters from the kml file. See ``CygDdmId`` Class for more functionality\n```python\nimport cygnsslib\n\nddm_list = cygnsslib.get_list_ddm_info_from_kml(in_kml=f'my_data_above_thresh.kml')\n\n```\nFind CYGNSS Land product (experimental) from the standard ocean product. This function is still in developing.\n```python\nimport cygnsslib\nxls_in = f'my_xls.xlsx'\ncygnsslib.find_land_prod_sample_id_from_excel(xls_in, xls_out=None, start_col=1, st_row=1)\n```\n\n## Contact Info \nFor more info, please contact: \nAmer Melebari \nMicrowave Systems, Sensors and Imaging Lab (MiXiL) \nUniversity of Southern California \namelebar[AT]usc.edu \n\n",
"bugtrack_url": null,
"license": "",
"summary": "Toolset for working with CYGNSS data and downloading CYGNSS data from PODAAC",
"version": "1.3.5",
"project_urls": {
"Homepage": "https://bitbucket.org/usc_mixil/cygnsslib"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "3f5f06bfe078f6f8a788f8547a34331d30d549b1dbdda1a9f3c3a5bc3c0bc66b",
"md5": "aabfae634cca3926f94857004feb7e78",
"sha256": "837ae453b1720e6cba97244ebe56e146e21ba06a5ad6de412aa737ca378a8971"
},
"downloads": -1,
"filename": "cygnsslib-1.3.5-py3-none-any.whl",
"has_sig": false,
"md5_digest": "aabfae634cca3926f94857004feb7e78",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 50611,
"upload_time": "2024-01-20T23:23:05",
"upload_time_iso_8601": "2024-01-20T23:23:05.475404Z",
"url": "https://files.pythonhosted.org/packages/3f/5f/06bfe078f6f8a788f8547a34331d30d549b1dbdda1a9f3c3a5bc3c0bc66b/cygnsslib-1.3.5-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "cc84407f6fc290ed8734338aacbe48d8ceaff9bb52b8d621666d7fb7aa6956ba",
"md5": "7ac6a6a7101f104f68c41a659542e079",
"sha256": "996afcb4ea2df076241fe076748ce2b33e2189600ee9e22f1eea571940ea9a2e"
},
"downloads": -1,
"filename": "cygnsslib-1.3.5.tar.gz",
"has_sig": false,
"md5_digest": "7ac6a6a7101f104f68c41a659542e079",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 46776,
"upload_time": "2024-01-20T23:23:07",
"upload_time_iso_8601": "2024-01-20T23:23:07.326991Z",
"url": "https://files.pythonhosted.org/packages/cc/84/407f6fc290ed8734338aacbe48d8ceaff9bb52b8d621666d7fb7aa6956ba/cygnsslib-1.3.5.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-01-20 23:23:07",
"github": false,
"gitlab": false,
"bitbucket": true,
"codeberg": false,
"bitbucket_user": "usc_mixil",
"bitbucket_project": "cygnsslib",
"lcname": "cygnsslib"
}
JSON