Rebase PR

.github/workflows/python-publish.yml

@@ -0,0 +1,43 @@
+name: Publish nwmurl to PyPi
+
+on:
+  push:
+    branches:
+      - main
+
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    environment: production
+    steps:
+      - name: var APP_ID
+        run: echo " My App ID is ${{ vars.APP_KEY }}"
+
+      - name: SECRET API_KEY
+        run: echo " My secret ID is ${{ secrets.PYPI_API_TOKEN }}"
+
+      - name: Checkout code
+        uses: actions/checkout@v2
+
+      - name: Set up Python
+        uses: actions/setup-python@v2
+        with:
+          python-version: 3.x
+
+      - name: Print Repository URL
+        run: |
+          REPO_URL="https://github.com/${{ github.repository }}"
+          echo "Repository URL: $REPO_URL"
+
+      - name: Install dependencies
+        run: pip install setuptools wheel
+      - name: List Secrets
+        run: |
+          echo "Available secrets:"
+          env
+      - name: Build and deploy package
+        run: |
+          python setup.py sdist bdist_wheel
+          pip install twine==4.0.2
+          echo "PYPI_API_TOKEN: ${{ secrets.SEPEHR }}"  # Print the API token
+          twine upload -u '__token__' -p ${{ secrets.PYPI_API_TOKEN }} dist/*

.github/workflows/secrets.yaml

@@ -0,0 +1,41 @@
+name: Secrets and Environment Variables
+
+on:
+  workflow_dispatch
+
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    environment: production
+    steps:
+      - name: var APP_ID
+        run: echo " My App ID is ${{ vars.APP_KEY }}"
+
+      - name: SECRET API_KEY
+        run: echo " My secret ID is ${{ secrets.PYPI_API_TOKEN }}"
+
+      - name: Checkout code
+        uses: actions/checkout@v2
+
+      - name: Set up Python
+        uses: actions/setup-python@v2
+        with:
+          python-version: 3.x
+
+      - name: Print Repository URL
+        run: |
+          REPO_URL="https://github.com/${{ github.repository }}"
+          echo "Repository URL: $REPO_URL"
+
+      - name: Install dependencies
+        run: pip install setuptools wheel
+      - name: List Secrets
+        run: |
+          echo "Available secrets:"
+          env
+      - name: Build and deploy package
+        run: |
+          python setup.py sdist bdist_wheel
+          pip install twine==4.0.2
+          echo "PYPI_API_TOKEN: ${{ secrets.SEPEHR }}"  # Print the API token
+          twine upload -u '__token__' -p ${{ secrets.PYPI_API_TOKEN }} dist/*

README.md

@@ -1,3 +1,4 @@
+
 # nwmurl
 
 This library contains utility functions to generate National Water Model data URLs
@@ -9,7 +10,7 @@ Developed by CIROH 2023
 
 2. The code will generate a list of JSON header URLs tailored to your specified parameters using the `generate_urls` function.
 
-## Customize Your Data Retrieval
+## Customize Your Data Retrieval for Operational Dataset
 - `start_date`: A string representing the starting date in the format \"YYYYMMDDHHMM".
 - `end_date`: A string representing the ending date in the same format.
 - `fcst_cycle`: A list of integers specifying forecast cycle numbers, e.g., `[0, 1, 2, 3, 4]`. These cycles represent specific points in time for which URLs will be generated.
@@ -47,18 +48,102 @@ Developed by CIROH 2023
     - `8`: "s3://noaa-nwm-pds/".
     - `9`: "https://ciroh-nwm-zarr-copy.s3.amazonaws.com/national-water-model/".
 - `meminput `:  An integer representing the ensemble member designation ranging from 0 to 7
+- `write_to_file`:  A Boolean variable that saves the output urls into a .txt file if set 'True'
 
-
+## Customize Your Data Retrieval for Retrospective Dataset
+- `start_date`: A string representing the starting date in the format \"YYYYMMDDHHMM".
+- `end_date`: A string representing the ending date in the same format.
+- `urlbaseinput `:  An integer representing the NWM dataset. Available options include:
+	- `1`: "https://noaa-nwm-retrospective-2-1-pds.s3.amazonaws.com/".
+    - `2`: "s3://noaa-nwm-retrospective-2-1-pds/model_output/".
+- `selectet_object_type`: An integer representing the object type. Available options include:
+	- `1` for forcing data
+	- `2` for model_output
+
+- `Selectet_var_types`:  An integer or string representing the variable of interest within the NWM data. Available options include:
+	- `1`: ".CHRTOUT_DOMAIN1.comp"
+    - `2`: ".GWOUT_DOMAIN1.comp"
+    - `3`: ".LAKEOUT_DOMAIN1.comp"
+    - `4`: ".LDASOUT_DOMAIN1.comp"
+    - `5`: ".RTOUT_DOMAIN1.comp"
+    - `6`: ".LDASIN_DOMAIN1.comp"
+- `write_to_file`: A Boolean A Boolean variable that saves the output urls into a .txt file if set `True`
 ## Examples of how to use 
 
 
 
-1. Clone the repository to your local machine:
+1. For Operational dataset:
+```
+import nwmurl
+
+start_date = "202201120000"
+end_date   = "202201130000"
+fcst_cycle = [0,8]
+lead_time = [1,18]
+varinput = 1
+geoinput = 1
+runinput = 1
+urlbaseinput = 2
+meminput = 1
+write_to_file = False
+
+file_list = nwmurl.generate_urls_operational(
+    start_date, end_date, fcst_cycle,
+    lead_time,
+    varinput,
+    geoinput,
+    runinput,
+    urlbaseinput,
+    meminput,
+    write_to_file
+)
+```
+
+2. For Retrospective dataset:
 ```
-  git clone https://github.com/CIROH-UA/data_access_example.git
+import nwmurl
+
+start_date = "200701010000"
+end_date = "200701030800"
+urlbaseinput = 2
+selected_var_types = [1, 2]
+selected_object_types = [1]  
+write_to_file = True
+
+file_list = nwmurl.generate_urls_retro(
+    start_date,
+    end_date,
+    urlbaseinput,
+    selected_object_types,
+    selected_var_types,
+    write_to_file
+)
 ```
 
-2. Navigate to the repository folder:
+## How to Contribute
+
+We welcome contributions to nwmurl! To contribute to the development of this library, please follow these steps:
+
+1. Fork the repository on GitHub.
+
+2. Clone your fork to your local machine:` 
+
+	`git clone https://github.com/your-username/nwmurl.git`
+
+ 3. Create a new branch for your contribution:` 
+
+	`git checkout -b feature/your-feature-name`
+
+
+4. Make your code changes and improvements.
+
+5. Before submitting a pull request, make sure to update the package version in `setup.py` if necessary.
+
+6. Commit your changes with descriptive commit messages.
+
+7. Push your changes to your fork:`` 
+
 
+8. Open a pull request on the main repository, describing your changes and why they should be merged.
 
-3. Launch the Jupyter Notebook to execute the example
+We appreciate your contributions and will review your pull request as soon as possible. Thank you for helping improve nwmurl!