ocstrack 0.1.0__tar.gz

ocstrack-0.1.0/LICENSE.txt

@@ -0,0 +1,121 @@
+Creative Commons Legal Code
+
+CC0 1.0 Universal
+
+    CREATIVE COMMONS CORPORATION IS NOT A LAW FIRM AND DOES NOT PROVIDE
+    LEGAL SERVICES. DISTRIBUTION OF THIS DOCUMENT DOES NOT CREATE AN
+    ATTORNEY-CLIENT RELATIONSHIP. CREATIVE COMMONS PROVIDES THIS
+    INFORMATION ON AN "AS-IS" BASIS. CREATIVE COMMONS MAKES NO WARRANTIES
+    REGARDING THE USE OF THIS DOCUMENT OR THE INFORMATION OR WORKS
+    PROVIDED HEREUNDER, AND DISCLAIMS LIABILITY FOR DAMAGES RESULTING FROM
+    THE USE OF THIS DOCUMENT OR THE INFORMATION OR WORKS PROVIDED
+    HEREUNDER.
+
+Statement of Purpose
+
+The laws of most jurisdictions throughout the world automatically confer
+exclusive Copyright and Related Rights (defined below) upon the creator
+and subsequent owner(s) (each and all, an "owner") of an original work of
+authorship and/or a database (each, a "Work").
+
+Certain owners wish to permanently relinquish those rights to a Work for
+the purpose of contributing to a commons of creative, cultural and
+scientific works ("Commons") that the public can reliably and without fear
+of later claims of infringement build upon, modify, incorporate in other
+works, reuse and redistribute as freely as possible in any form whatsoever
+and for any purposes, including without limitation commercial purposes.
+These owners may contribute to the Commons to promote the ideal of a free
+culture and the further production of creative, cultural and scientific
+works, or to gain reputation or greater distribution for their Work in
+part through the use and efforts of others.
+
+For these and/or other purposes and motivations, and without any
+expectation of additional consideration or compensation, the person
+associating CC0 with a Work (the "Affirmer"), to the extent that he or she
+is an owner of Copyright and Related Rights in the Work, voluntarily
+elects to apply CC0 to the Work and publicly distribute the Work under its
+terms, with knowledge of his or her Copyright and Related Rights in the
+Work and the meaning and intended legal effect of CC0 on those rights.
+
+1. Copyright and Related Rights. A Work made available under CC0 may be
+protected by copyright and related or neighboring rights ("Copyright and
+Related Rights"). Copyright and Related Rights include, but are not
+limited to, the following:
+
+  i. the right to reproduce, adapt, distribute, perform, display,
+     communicate, and translate a Work;
+ ii. moral rights retained by the original author(s) and/or performer(s);
+iii. publicity and privacy rights pertaining to a person's image or
+     likeness depicted in a Work;
+ iv. rights protecting against unfair competition in regards to a Work,
+     subject to the limitations in paragraph 4(a), below;
+  v. rights protecting the extraction, dissemination, use and reuse of data
+     in a Work;
+ vi. database rights (such as those arising under Directive 96/9/EC of the
+     European Parliament and of the Council of 11 March 1996 on the legal
+     protection of databases, and under any national implementation
+     thereof, including any amended or successor version of such
+     directive); and
+vii. other similar, equivalent or corresponding rights throughout the
+     world based on applicable law or treaty, and any national
+     implementations thereof.
+
+2. Waiver. To the greatest extent permitted by, but not in contravention
+of, applicable law, Affirmer hereby overtly, fully, permanently,
+irrevocably and unconditionally waives, abandons, and surrenders all of
+Affirmer's Copyright and Related Rights and associated claims and causes
+of action, whether now known or unknown (including existing as well as
+future claims and causes of action), in the Work (i) in all territories
+worldwide, (ii) for the maximum duration provided by applicable law or
+treaty (including future time extensions), (iii) in any current or future
+medium and for any number of copies, and (iv) for any purpose whatsoever,
+including without limitation commercial, advertising or promotional
+purposes (the "Waiver"). Affirmer makes the Waiver for the benefit of each
+member of the public at large and to the detriment of Affirmer's heirs and
+successors, fully intending that such Waiver shall not be subject to
+revocation, rescission, cancellation, termination, or any other legal or
+equitable action to disrupt the quiet enjoyment of the Work by the public
+as contemplated by Affirmer's express Statement of Purpose.
+
+3. Public License Fallback. Should any part of the Waiver for any reason
+be judged legally invalid or ineffective under applicable law, then the
+Waiver shall be preserved to the maximum extent permitted taking into
+account Affirmer's express Statement of Purpose. In addition, to the
+extent the Waiver is so judged Affirmer hereby grants to each affected
+person a royalty-free, non transferable, non sublicensable, non exclusive,
+irrevocable and unconditional license to exercise Affirmer's Copyright and
+Related Rights in the Work (i) in all territories worldwide, (ii) for the
+maximum duration provided by applicable law or treaty (including future
+time extensions), (iii) in any current or future medium and for any number
+of copies, and (iv) for any purpose whatsoever, including without
+limitation commercial, advertising or promotional purposes (the
+"License"). The License shall be deemed effective as of the date CC0 was
+applied by Affirmer to the Work. Should any part of the License for any
+reason be judged legally invalid or ineffective under applicable law, such
+partial invalidity or ineffectiveness shall not invalidate the remainder
+of the License, and in such case Affirmer hereby affirms that he or she
+will not (i) exercise any of his or her remaining Copyright and Related
+Rights in the Work or (ii) assert any associated claims and causes of
+action with respect to the Work, in either case contrary to Affirmer's
+express Statement of Purpose.
+
+4. Limitations and Disclaimers.
+
+ a. No trademark or patent rights held by Affirmer are waived, abandoned,
+    surrendered, licensed or otherwise affected by this document.
+ b. Affirmer offers the Work as-is and makes no representations or
+    warranties of any kind concerning the Work, express, implied,
+    statutory or otherwise, including without limitation warranties of
+    title, merchantability, fitness for a particular purpose, non
+    infringement, or the absence of latent or other defects, accuracy, or
+    the present or absence of errors, whether or not discoverable, all to
+    the greatest extent permissible under applicable law.
+ c. Affirmer disclaims responsibility for clearing rights of other persons
+    that may apply to the Work or any use thereof, including without
+    limitation any person's Copyright and Related Rights in the Work.
+    Further, Affirmer disclaims responsibility for obtaining any necessary
+    consents, permissions or other rights required for any use of the
+    Work.
+ d. Affirmer understands and acknowledges that Creative Commons is not a
+    party to this document and has no duty or obligation with respect to
+    this CC0 or use of the Work.

ocstrack-0.1.0/PKG-INFO

@@ -0,0 +1,134 @@
+Metadata-Version: 2.4
+Name: ocstrack
+Version: 0.1.0
+Summary: Satellite data download, crop, and collocation with model outputs
+Author-email: Felicio Cassalho <felicio.cassalho@noaa.gov>
+License: MIT
+Project-URL: Homepage, https://github.com/noaa-ocs-modeling/OCSTrack
+Project-URL: Repository, https://github.com/noaa-ocs-modeling/OCSTrack
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE.txt
+Requires-Dist: numpy
+Requires-Dist: xarray
+Requires-Dist: scipy
+Requires-Dist: tqdm
+Requires-Dist: requests
+Requires-Dist: netcdf4
+Requires-Dist: h5netcdf
+Dynamic: license-file
+
+# OCSTrack
+OCSTrack is an object-oriented Python package for the along-track collocation of satellite data with ocean circulation and wave model outputs.
+It simplifies the process of aligning diverse datasets, making it easier to compare and analyze satellite observations against model simulations.
+
+## Key Features
+### Satellite Altimetry Data Support
+
+Seamlessly integrates with NOAA [CoastalWatch](https://coastwatch.noaa.gov/cwn/products/along-track-significant-wave-height-wind-speed-and-sea-level-anomaly-multiple-altimeters.html) altimetry data, providing access to a wide range of missions:
+ * Jason-2
+ * Jason-3
+ * Sentinel-3A
+ * Sentinel-3B
+ * Sentinel-6A
+ * CryoSat-2
+ * SARAL
+ * SWOT
+
+### Ocean Model Data Support
+ Supports outputs from various ocean circulation and wave models:
+ * [SCHISM+WWM](https://github.com/schism-dev/schism)
+ * WaveWatch3 (to be implemented)
+ * ADCIRC+SWAN (to be implemented)
+
+
+## Installation
+
+1.  **Create and activate a new conda environment:**
+    This command creates an environment named `ocstrack` and installs all dependencies from `conda-forge`.
+    ```bash
+    conda create -n ocstrack -c conda-forge python=3.10 numpy xarray scipy tqdm requests netcdf4 h5netcdf
+    conda activate ocstrack
+    ```
+
+2.  **Install `ocstrack` from GitHub:**
+    Finally, install this package using `pip`.
+    ```bash
+    pip install "git+[https://github.com/noaa-ocs-modeling/OCSTrack.git](https://github.com/noaa-ocs-modeling/OCSTrack.git)"
+    ```
+
+## Usage
+Here's a typical workflow demonstrating how to use OCSTrack to download satellite data, load model outputs, and perform collocation.
+```
+import numpy as np
+import xarray as xr
+# Assuming ocstrack is installed and available in your environment
+from ocstrack.Model.model import SCHISM
+from ocstrack.Satellite.satellite import SatelliteData
+from ocstrack.Satellite import get_sat
+from ocstrack.Collocation.collocate import Collocate
+from ocstrack.utils import convert_longitude
+
+
+# 1. Download Satellite Data
+#    Specify your desired date range, list of satellites, output directory, and geographical bounding box.
+get_sat.get_multi_sat(start_date="2019-07-30",
+                      end_date="2019-08-04",
+                      sat_list=['sentinel3a','sentinel3b','jason2','jason3','cryosat2','saral'],
+                      output_dir=r"Your/Path/Here/",
+                      lat_min=49.109,
+                      lat_max=66.304309,
+                      lon_min=156.6854,
+                      lon_max=-156.864,
+                     )
+
+# 2. Define File Paths
+#    Set the paths for your downloaded satellite data, model run, and where you want to save the collocated output.
+sat_path = "/path/to/your/multisat_cropped_2019-07-30_2019-08-04.nc"
+model_path = "/path/to/your/model/run/"
+output_path =  "/path/to/your/collocated_output.nc"
+s_time,e_time = "2019-08-01", "2019-08-03"
+
+# 3. Load Satellite Data
+#    Initialize the SatelliteData object with your satellite data file.
+sat_data = SatelliteData(sat_path)
+#    It's crucial to ensure longitude conventions match between satellite and model data.
+#    Use convert_longitude if needed (mode=1 for converting to 0-360 degrees).
+sat_data.lon = convert_longitude(sat_data.lon, mode=1)
+
+# 4. Load Model Data
+#    Instantiate the SCHISM model object, specifying the run directory and model variable details.
+model_run = SCHISM(
+                    rundir=model_path,
+                    model_dict={'var': 'sigWaveHeight',
+                                'startswith': 'out2d_', # File name prefix for 2D outputs
+                                'var_type': '2D',
+                                'model': 'SCHISM'},
+                    start_date=np.datetime64(s_time),
+                    end_date=np.datetime64(e_time)
+                  )
+
+# 5. Perform Collocation
+#    Create a Collocate object, providing the loaded model and satellite data.
+coll = Collocate(
+                 model_run=model_run,
+                 satellite=sat_data,
+                 # dist_coast=dist_coast,
+                 n_nearest=3,
+                 # search_radius = 3000,
+                 temporal_interp=True
+                 )
+ds_coll = coll.run(output_path=output_path) # Execute the collocation and save the results
+```
+
+## Contributing
+We welcome contributions to OCSTrack! If you have ideas for improvements, new features, or find a bug, please don't hesitate to open an issue or submit a pull request on our GitHub repository. Your input helps make OCSTrack better for everyone.
+
+### Contact
+<sub><sup>Contact: felicio.cassalho@noaa.gov </sup></sub>
+
+![NOAA logo](https://user-images.githubusercontent.com/72229285/216712553-c1e4b2fa-4b6d-4eab-be0f-f7075b6151d1.png)
+
+
+#### Acknowledgements:
+*OCSTrack was inspired by the MATLAB-based [WW3-tools](https://github.com/NOAA-EMC/WW3-tools) and [wave-tools](https://github.com/NOAA-EMC/WW3-tools) collocation tools developed for WaveWatch3.*

ocstrack-0.1.0/README.md

@@ -0,0 +1,114 @@
+# OCSTrack
+OCSTrack is an object-oriented Python package for the along-track collocation of satellite data with ocean circulation and wave model outputs.
+It simplifies the process of aligning diverse datasets, making it easier to compare and analyze satellite observations against model simulations.
+
+## Key Features
+### Satellite Altimetry Data Support
+
+Seamlessly integrates with NOAA [CoastalWatch](https://coastwatch.noaa.gov/cwn/products/along-track-significant-wave-height-wind-speed-and-sea-level-anomaly-multiple-altimeters.html) altimetry data, providing access to a wide range of missions:
+ * Jason-2
+ * Jason-3
+ * Sentinel-3A
+ * Sentinel-3B
+ * Sentinel-6A
+ * CryoSat-2
+ * SARAL
+ * SWOT
+
+### Ocean Model Data Support
+ Supports outputs from various ocean circulation and wave models:
+ * [SCHISM+WWM](https://github.com/schism-dev/schism)
+ * WaveWatch3 (to be implemented)
+ * ADCIRC+SWAN (to be implemented)
+
+
+## Installation
+
+1.  **Create and activate a new conda environment:**
+    This command creates an environment named `ocstrack` and installs all dependencies from `conda-forge`.
+    ```bash
+    conda create -n ocstrack -c conda-forge python=3.10 numpy xarray scipy tqdm requests netcdf4 h5netcdf
+    conda activate ocstrack
+    ```
+
+2.  **Install `ocstrack` from GitHub:**
+    Finally, install this package using `pip`.
+    ```bash
+    pip install "git+[https://github.com/noaa-ocs-modeling/OCSTrack.git](https://github.com/noaa-ocs-modeling/OCSTrack.git)"
+    ```
+
+## Usage
+Here's a typical workflow demonstrating how to use OCSTrack to download satellite data, load model outputs, and perform collocation.
+```
+import numpy as np
+import xarray as xr
+# Assuming ocstrack is installed and available in your environment
+from ocstrack.Model.model import SCHISM
+from ocstrack.Satellite.satellite import SatelliteData
+from ocstrack.Satellite import get_sat
+from ocstrack.Collocation.collocate import Collocate
+from ocstrack.utils import convert_longitude
+
+
+# 1. Download Satellite Data
+#    Specify your desired date range, list of satellites, output directory, and geographical bounding box.
+get_sat.get_multi_sat(start_date="2019-07-30",
+                      end_date="2019-08-04",
+                      sat_list=['sentinel3a','sentinel3b','jason2','jason3','cryosat2','saral'],
+                      output_dir=r"Your/Path/Here/",
+                      lat_min=49.109,
+                      lat_max=66.304309,
+                      lon_min=156.6854,
+                      lon_max=-156.864,
+                     )
+
+# 2. Define File Paths
+#    Set the paths for your downloaded satellite data, model run, and where you want to save the collocated output.
+sat_path = "/path/to/your/multisat_cropped_2019-07-30_2019-08-04.nc"
+model_path = "/path/to/your/model/run/"
+output_path =  "/path/to/your/collocated_output.nc"
+s_time,e_time = "2019-08-01", "2019-08-03"
+
+# 3. Load Satellite Data
+#    Initialize the SatelliteData object with your satellite data file.
+sat_data = SatelliteData(sat_path)
+#    It's crucial to ensure longitude conventions match between satellite and model data.
+#    Use convert_longitude if needed (mode=1 for converting to 0-360 degrees).
+sat_data.lon = convert_longitude(sat_data.lon, mode=1)
+
+# 4. Load Model Data
+#    Instantiate the SCHISM model object, specifying the run directory and model variable details.
+model_run = SCHISM(
+                    rundir=model_path,
+                    model_dict={'var': 'sigWaveHeight',
+                                'startswith': 'out2d_', # File name prefix for 2D outputs
+                                'var_type': '2D',
+                                'model': 'SCHISM'},
+                    start_date=np.datetime64(s_time),
+                    end_date=np.datetime64(e_time)
+                  )
+
+# 5. Perform Collocation
+#    Create a Collocate object, providing the loaded model and satellite data.
+coll = Collocate(
+                 model_run=model_run,
+                 satellite=sat_data,
+                 # dist_coast=dist_coast,
+                 n_nearest=3,
+                 # search_radius = 3000,
+                 temporal_interp=True
+                 )
+ds_coll = coll.run(output_path=output_path) # Execute the collocation and save the results
+```
+
+## Contributing
+We welcome contributions to OCSTrack! If you have ideas for improvements, new features, or find a bug, please don't hesitate to open an issue or submit a pull request on our GitHub repository. Your input helps make OCSTrack better for everyone.
+
+### Contact
+<sub><sup>Contact: felicio.cassalho@noaa.gov </sup></sub>
+
+![NOAA logo](https://user-images.githubusercontent.com/72229285/216712553-c1e4b2fa-4b6d-4eab-be0f-f7075b6151d1.png)
+
+
+#### Acknowledgements:
+*OCSTrack was inspired by the MATLAB-based [WW3-tools](https://github.com/NOAA-EMC/WW3-tools) and [wave-tools](https://github.com/NOAA-EMC/WW3-tools) collocation tools developed for WaveWatch3.*

ocstrack-0.1.0/ocstrack/Collocation/__init__.py

@@ -0,0 +1 @@
+