Change woa13 to woa23

.gitmodules

@@ -1,3 +1,3 @@
-[submodule "initial_conditions_WOA"]
-	path = initial_conditions_WOA
-	url = https://github.com/COSIMA/initial_conditions_WOA.git
+[submodule "initial_conditions_WOA23/ocean-ic"]
+	path = initial_conditions_WOA23/ocean-ic
+	url = git@github.com:COSIMA/ocean-ic.git

LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   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.

README

@@ -1,70 +1,15 @@
-Tools to produce conservative temperature and salinity from World Ocean Atlas data, and regrid them to the ACCESS-OM2 model grids.
+Tools to produce conservative temperature and salinity from World Ocean Atlas 2023 data, and regrid them to the ACCESS-OM3 model grids.
 
 	1. Run inte.csh to create temperature and salinity files, using monthly data instead of 
-           seasonal dta in the upper 1500m. Results are put in /g/data/ik11/inputs/access-om2/woa13/monthly
+           seasonal dta in the upper 1500m. Results are put in /g/data/ik11/inputs/access-om3/woa23/monthly
 
 	2. Run make_inital_conditions.sh in the directory initial_conditions_WOA/ for regridding.
-           Results are put in /g/data/ik11/inputs/access-om2/woa13/[01]*
+           Results are put in /g/data/ik11/inputs/access-om3/woa23/[01]*
 
 	3. If you're happy with the results, run finalise.sh to git commit and add commit info to the .nc metadata
 
-	4. If you have permissions you can run copy_to_input_rc.sh to copy January initial conditions to /g/data/ik11/inputs/access-om2/input_rc
+	4. If you have permissions you can run copy_to_input_rc.sh to copy January initial conditions to /g/data/ik11/inputs/access-om3/input_rc
 
 This repository contains submodules, so clone it with
 
-git clone --recursive https://github.com/COSIMA/initial_conditions_access-om2.git
-
---------------
-
-2017-11-14 Fanghua Wu
-
-======================================================================================
-Summary about processing the 12-month data for different degree versions:
-======================================================================================
-
-01 version
-======================================================================================
-                  Resource Usage on 2017-10-09 21:43:12:
-   Job Id:             9558755.r-man2
-   Project:            x77
-   Exit Status:        0
-   Service Units:      131.75
-   NCPUs Requested:    8                      NCPUs Used: 8
-                                           CPU Time Used: 07:10:09
-   Memory Requested:   64.0GB                Memory Used: 18.22GB
-   Walltime requested: 12:00:00            Walltime Used: 05:29:23
-   JobFS requested:    400.0GB                JobFS used: 3.3GB
-======================================================================================
-
-025 version
-======================================================================================
-                  Resource Usage on 2017-10-01 12:02:43:
-   Job Id:             9277169.r-man2
-   Project:            x77
-   Exit Status:        0
-   Service Units:      17.33
-   NCPUs Requested:    8                      NCPUs Used: 8
-                                           CPU Time Used: 01:14:23
-   Memory Requested:   64.0GB                Memory Used: 4.62GB
-   Walltime requested: 01:00:00            Walltime Used: 00:43:20
-   JobFS requested:    400.0GB                JobFS used: 757.63MB
-======================================================================================
-
-10 version
-======================================================================================
-                  Resource Usage on 2017-10-01 11:14:44:
-   Job Id:             9277004.r-man2
-   Project:            x77
-   Exit Status:        0
-   Service Units:      5.48
-   NCPUs Requested:    8                      NCPUs Used: 8
-                                           CPU Time Used: 00:19:43
-   Memory Requested:   64.0GB                Memory Used: 3.18GB
-   Walltime requested: 01:00:00            Walltime Used: 00:13:42
-   JobFS requested:    400.0GB                JobFS used: 299.24MB
-======================================================================================
-
-
-2020-06-24: Andrew Kiss
- - copied from /g/data/hh5/tmp/cosima/observations/postprocessing/woa13/tools/
- - set up git repo
+git clone --recursive https://github.com/ACCESS-NRI/initial_conditions_access-om3.git

copy_to_input_rc.sh

@@ -1,7 +1,9 @@
 #!/usr/bin/env sh
+# Copyright 2023 ACCESS-NRI and contributors. See the top-level COPYRIGHT file for details.
+# SPDX-License-Identifier: Apache-2.0
 
-srcpath=/g/data/ik11/inputs/access-om2/woa13
-dstpath=/g/data/ik11/inputs/access-om2/input_rc
+srcpath=/g/data/ik11/inputs/access-om3/woa23
+dstpath=/g/data/ik11/inputs/access-om3/input_rc
 
 echo "WARNING: About to copy initial conditions from ${srcpath} to ${dstpath}"
 read -p "Proceed? (y/n) " yesno
@@ -13,8 +15,8 @@ esac
 set -e
 set -x
 
-cp --preserve --remove-destination ${srcpath}/10/woa13_ts_01_mom10.nc   ${dstpath}/mom_1deg/ocean_temp_salt.res.nc
-cp --preserve --remove-destination ${srcpath}/025/woa13_ts_01_mom025.nc ${dstpath}/mom_025deg/ocean_temp_salt.res.nc
-cp --preserve --remove-destination ${srcpath}/01/woa13_ts_01_mom01.nc   ${dstpath}/mom_01deg/ocean_temp_salt.res.nc
+cp --preserve --remove-destination ${srcpath}/10/woa23_ts_01_mom10.nc   ${dstpath}/mom_1deg/ocean_temp_salt.res.nc
+cp --preserve --remove-destination ${srcpath}/025/woa23_ts_01_mom025.nc ${dstpath}/mom_025deg/ocean_temp_salt.res.nc
+cp --preserve --remove-destination ${srcpath}/01/woa23_ts_01_mom01.nc   ${dstpath}/mom_01deg/ocean_temp_salt.res.nc
 
 echo "done"

finalise.sh

@@ -1,4 +1,6 @@
 #!/usr/bin/env sh
+# Copyright 2023 ACCESS-NRI and contributors. See the top-level COPYRIGHT file for details.
+# SPDX-License-Identifier: Apache-2.0
 # Commit changes and push, then add metadata to note how changes were made
 
 module load nco
@@ -17,17 +19,17 @@ set -e
 git commit -am "update" || true
 git push || true
 
-outpath=/g/data/ik11/inputs/access-om2/woa13
+outpath=/g/data/ik11/inputs/access-om3/woa23
 
 dirs=("10" "025" "01")
 for d in ${dirs[@]}; do
-   for f in ${outpath}/${d}/woa13_ts_??_mom${d}.nc; do
-      ncatted -O -h -a history,global,a,c," | Created on $(date) using https://github.com/COSIMA/initial_conditions_access-om2/tree/$(git rev-parse --short HEAD)" $f
+   for f in ${outpath}/${d}/woa23_ts_??_mom${d}.nc; do
+      ncatted -O -h -a history,global,a,c," | Created on $(date) using https://github.com/ACCESS-NRI/initial_conditions_access-om3.git/tree/$(git rev-parse --short HEAD)" $f
    done
 done
 
-for f in ${outpath}/monthly/woa13_*.nc; do
-      ncatted -O -h -a history,global,a,c," | Created on $(date) using https://github.com/COSIMA/initial_conditions_access-om2/tree/$(git rev-parse --short HEAD)" $f
+for f in ${outpath}/monthly/woa23_*.nc; do
+      ncatted -O -h -a history,global,a,c," | Created on $(date) using https://github.com/ACCESS-NRI/initial_conditions_access-om3.git/tree/$(git rev-parse --short HEAD)" $f
 done
 
 set +e

initial_conditions_WOA23/README

@@ -0,0 +1,10 @@
+# Initial Condition Files for MOM Ocean Grids Using World Ocean Atlas 2023 (WOA23)
+
+This repository contains the tools and scripts to generate initial condition files for 3 MOM ocean grids from World Ocean Atlas 2023 (WOA23) data. The repository leverages Nic Hannah's `ocean-ic` code for interpolating the salt and temperature fields onto the 3D MOM ocean grids.
+
+# Generate Initial Conditions
+
+This script generates initial condition files for a specific MOM ocean grid using WOA23 data. The grid and data paths are provided as environment variables, execute the following script with the grid, input and output directories as a command-line argument:
+
+qsub -v GRIDDIR="<path_to_grid_directory>",INPUT_DIR="<path_to_input_directory>",OUTPUT_DIR="<path_to_output_directory>" -P $PROJECT make_initial_conditions.sh  
+