splitnc 0.0.0__tar.gz

splitnc-0.0.0/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.

splitnc-0.0.0/PKG-INFO

@@ -0,0 +1,144 @@
+Metadata-Version: 2.4
+Name: splitnc
+Version: 0.0.0
+Summary: Split multi-field ESM1.6 files into single-field files
+Author-email: Joshua Torrance <joshua.torrance@anu.edu.au>, Spencer Wong <spencer.wong@anu.edu.au>
+Maintainer-email: Joshua Torrance <joshua.torrance@anu.edu.au>
+License-Expression: Apache-2.0
+Project-URL: Repository, https://github.com/ACCESS-NRI/splitnc
+Keywords: ACCESS-NRI,netcdf
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: netcdf4
+Requires-Dist: xarray
+Provides-Extra: test
+Requires-Dist: pytest; extra == "test"
+Requires-Dist: netCDF4; extra == "test"
+Requires-Dist: xarray>2025.1.2; extra == "test"
+Dynamic: license-file
+
+# splitnc
+This script splits multi-field netCDF files into single-field files.
+It is designed to work on ESM1.6's atmosphere and ice files.
+
+## Automatic Field Identification
+By default `splitnc` will attempt to identify the fields for a multi-field netCDF files by looking for variables that no other variables depend on.
+A variable that no others depend on is likely to be a field.
+E.g. many variables depend on `time`, but none depend on `sea_surface_temperature`.
+
+Alternatively the fields to separate to individual files can be specified as a comma separated list with the `--field-vars` command line option.
+`--field-vars` interprets each item as regex, e.g. one could use `--field-vars fld_.+` to match all variable names that start with the string `fld_`.
+
+## "Ancillary" Variables
+
+Some variables with no dependents should not be separated into individual files, these variables must be manually identified with the `--shared-vars` command line option.
+These variables will then be present in every output file.
+Regex is also supported for this option.
+
+If there are ancillary fields that should only be present in only some of the output field files then multiple invocations of `splitnc` using `--field-vars` and `--shared-vars` will be required.
+
+Example of these variables are the `latitude_longitude` found in atmosphere files or the `uarea`, `tmask`, `tarea`, `VGRDb`, `VGRDi`, `VGRDs` variables from ice files.
+
+## Config File
+
+The `-c`/`--command-line-file` option can be used to supply a filepath to a file that contains command line options.
+If this option is used, all other options supplied on the command line will be ignored.
+Newline characters in the file will be treated as whitespace, i.e. newlines can be used as well as spaces to separate command line arguments.
+
+For example to replicate this command line,
+```
+splitnc --verbose --overwrite --output-dir /output/directory --shared-vars latitude_longitude --rename-regex "(?P<newname>.+)_\d+" /input/directory/*.nc
+```
+the following file could be used;
+```
+--verbose
+--overwrite
+--output-dir /output/directory
+--shared-vars latitude_longitude
+--rename-regex "(?P<newname>.+)_\d+"
+/input/directory/*.nc
+```
+
+## Command Line Options
+
+```quote
+usage: splitnc [-h] [--field-vars FIELD_VAR1,FIELD_VAR2,...] [--shared-vars SHARED_VAR1,SHARED_VAR2,...]
+               [--output-name-pattern OUTPUT_NAME_PATTERN] [--rename-regex REGEX] [--output-dir OUTPUT_DIR] [--overwrite] [-v]
+               [-c COMMAND_LINE_FILE]
+               [filepaths ...]
+
+Splits a multi-field netCDF file into separate one-field files
+
+positional arguments:
+  filepaths             One or more filepaths to process
+
+options:
+  -h, --help            show this help message and exit
+  --field-vars FIELD_VAR1,FIELD_VAR2,...
+                        Specify the names of the field variables to split into separate files - dimensions, bounds, and
+                        coordinates of these fields will be included in each file. Disables automatic field variable
+                        identification. Regex patterns can be used here.
+  --shared-vars SHARED_VAR1,SHARED_VAR2,...
+                        Specify the names of variables that should be shared across files that cannot be automatically
+                        identified, as a comma separated list. Regex patterns can be used here.
+  --excluded-vars EXCLUDED_VAR1,EXCLUDED_VAR2,...
+                        Specify the names of variables that should be excluded from files. This option can be used with
+                        automatic identification of field variables. Regex patterns can be used here.
+  --rename-regex REGEX  Look for duplicated coordinate names that match the given regex and rename them to the first
+                        "newname" capture group in the regex. E.g. "(?P<newname>.*)_\d+" will match "time_0" and rename
+                        it to "time".
+  --use-esm1p6-filenames
+                        Use the ESM1.6 filename pattern for the output files:
+                        access-esm1p6.{component}.{dimensions}.{field}.{freq}.{time_cell_method}.{datestamp}.nc
+                        splitnc will attempt to deduce all the components of the filename. If this option is not given
+                        {field}_{original_filename} will be used.
+  --fix-cell-methods    Correct cell_methods by adding 'time: point' to cell_methods for variables that have 'time' but
+                        not 'time_bnds' and no other 'time' cell_methods.
+  --file-freq FILE_FREQ
+                        Specify the frequency of the files (not the data), e.g. if each file contains a month of data
+                        then the file-frequency is '1mon'. Used to determine the resolution of the timestamp for ESM1.6
+                        filenames. Follows the ACCESS frequency vocabulary (e.g. '1yr', '1mon', '1day', '1hr'), any
+                        unrecognised frequency will use the full timestamp. Defaults to '1yr'.
+  --output-dir OUTPUT_DIR
+                        Output directory for the processed files. If not given output files will be placed in the same
+                        directory as the original file.
+  --overwrite           Overwrite existing files
+  --dont-update-history
+                        Disable automatic update of history attribute
+  -v, --verbose
+  -c COMMAND_LINE_FILE, --command-line-file COMMAND_LINE_FILE
+                        A file containing a list of command-line arguments. Newlines in this file will be ignored. If
+                        supplied all other command line arguments will be ignored.
+```
+
+## Example Usage
+
+`splitnc` just needs the `xarray` and `netCDF4` python modules.
+On Gadi use load any module with `xarray`, such as `conda/analysis3`.
+Alternatively create a new python environment and install `xarray` and `netCDF4`.
+
+### Atmosphere
+To use this script for split multi-field atmosphere files from ACCESS-ESM1.6:
+```bash
+splitnc --shared-vars latitude_longitude  --rename-regex "(?P<newname>.+)_\\d+" $INPUT_DIR/*.nc
+```
+
+`splitnc` will automatically determine which variables are fields by looking at which variables depend on other variables.
+Variables with nothing depending on them are deemed to be fields.
+Alternatively one could use `--field-vars fld_.+` to match the variable names in these files.
+
+The `--rename-regex` option with the supplied regex will rename variables like
+`time_0` or `pseudo_level_0` are renamed to `time` or `pseudo_level`.
+
+The `--shared-vars` option will ensure that the variable `latitude_longitude` is
+included in all files even though none of the field variable depend on it.
+
+### Ice
+To use this script for split multi-field ice files from ACCESS-ESM1.6:
+```bash
+splitnc --shared-vars uarea,tmask,tarea --excluded-vars VGRD. $INPUT_DIR/*.nc
+```
+
+In comparison to the atmosphere files, ice files have different shared-vars and there are no duplicated variables that require renaming.
+The variables `VGRDb`, `VGRDi`, and `VGRDs` are not required and can thus be excluded from the output.

splitnc-0.0.0/README.md

@@ -0,0 +1,124 @@
+# splitnc
+This script splits multi-field netCDF files into single-field files.
+It is designed to work on ESM1.6's atmosphere and ice files.
+
+## Automatic Field Identification
+By default `splitnc` will attempt to identify the fields for a multi-field netCDF files by looking for variables that no other variables depend on.
+A variable that no others depend on is likely to be a field.
+E.g. many variables depend on `time`, but none depend on `sea_surface_temperature`.
+
+Alternatively the fields to separate to individual files can be specified as a comma separated list with the `--field-vars` command line option.
+`--field-vars` interprets each item as regex, e.g. one could use `--field-vars fld_.+` to match all variable names that start with the string `fld_`.
+
+## "Ancillary" Variables
+
+Some variables with no dependents should not be separated into individual files, these variables must be manually identified with the `--shared-vars` command line option.
+These variables will then be present in every output file.
+Regex is also supported for this option.
+
+If there are ancillary fields that should only be present in only some of the output field files then multiple invocations of `splitnc` using `--field-vars` and `--shared-vars` will be required.
+
+Example of these variables are the `latitude_longitude` found in atmosphere files or the `uarea`, `tmask`, `tarea`, `VGRDb`, `VGRDi`, `VGRDs` variables from ice files.
+
+## Config File
+
+The `-c`/`--command-line-file` option can be used to supply a filepath to a file that contains command line options.
+If this option is used, all other options supplied on the command line will be ignored.
+Newline characters in the file will be treated as whitespace, i.e. newlines can be used as well as spaces to separate command line arguments.
+
+For example to replicate this command line,
+```
+splitnc --verbose --overwrite --output-dir /output/directory --shared-vars latitude_longitude --rename-regex "(?P<newname>.+)_\d+" /input/directory/*.nc
+```
+the following file could be used;
+```
+--verbose
+--overwrite
+--output-dir /output/directory
+--shared-vars latitude_longitude
+--rename-regex "(?P<newname>.+)_\d+"
+/input/directory/*.nc
+```
+
+## Command Line Options
+
+```quote
+usage: splitnc [-h] [--field-vars FIELD_VAR1,FIELD_VAR2,...] [--shared-vars SHARED_VAR1,SHARED_VAR2,...]
+               [--output-name-pattern OUTPUT_NAME_PATTERN] [--rename-regex REGEX] [--output-dir OUTPUT_DIR] [--overwrite] [-v]
+               [-c COMMAND_LINE_FILE]
+               [filepaths ...]
+
+Splits a multi-field netCDF file into separate one-field files
+
+positional arguments:
+  filepaths             One or more filepaths to process
+
+options:
+  -h, --help            show this help message and exit
+  --field-vars FIELD_VAR1,FIELD_VAR2,...
+                        Specify the names of the field variables to split into separate files - dimensions, bounds, and
+                        coordinates of these fields will be included in each file. Disables automatic field variable
+                        identification. Regex patterns can be used here.
+  --shared-vars SHARED_VAR1,SHARED_VAR2,...
+                        Specify the names of variables that should be shared across files that cannot be automatically
+                        identified, as a comma separated list. Regex patterns can be used here.
+  --excluded-vars EXCLUDED_VAR1,EXCLUDED_VAR2,...
+                        Specify the names of variables that should be excluded from files. This option can be used with
+                        automatic identification of field variables. Regex patterns can be used here.
+  --rename-regex REGEX  Look for duplicated coordinate names that match the given regex and rename them to the first
+                        "newname" capture group in the regex. E.g. "(?P<newname>.*)_\d+" will match "time_0" and rename
+                        it to "time".
+  --use-esm1p6-filenames
+                        Use the ESM1.6 filename pattern for the output files:
+                        access-esm1p6.{component}.{dimensions}.{field}.{freq}.{time_cell_method}.{datestamp}.nc
+                        splitnc will attempt to deduce all the components of the filename. If this option is not given
+                        {field}_{original_filename} will be used.
+  --fix-cell-methods    Correct cell_methods by adding 'time: point' to cell_methods for variables that have 'time' but
+                        not 'time_bnds' and no other 'time' cell_methods.
+  --file-freq FILE_FREQ
+                        Specify the frequency of the files (not the data), e.g. if each file contains a month of data
+                        then the file-frequency is '1mon'. Used to determine the resolution of the timestamp for ESM1.6
+                        filenames. Follows the ACCESS frequency vocabulary (e.g. '1yr', '1mon', '1day', '1hr'), any
+                        unrecognised frequency will use the full timestamp. Defaults to '1yr'.
+  --output-dir OUTPUT_DIR
+                        Output directory for the processed files. If not given output files will be placed in the same
+                        directory as the original file.
+  --overwrite           Overwrite existing files
+  --dont-update-history
+                        Disable automatic update of history attribute
+  -v, --verbose
+  -c COMMAND_LINE_FILE, --command-line-file COMMAND_LINE_FILE
+                        A file containing a list of command-line arguments. Newlines in this file will be ignored. If
+                        supplied all other command line arguments will be ignored.
+```
+
+## Example Usage
+
+`splitnc` just needs the `xarray` and `netCDF4` python modules.
+On Gadi use load any module with `xarray`, such as `conda/analysis3`.
+Alternatively create a new python environment and install `xarray` and `netCDF4`.
+
+### Atmosphere
+To use this script for split multi-field atmosphere files from ACCESS-ESM1.6:
+```bash
+splitnc --shared-vars latitude_longitude  --rename-regex "(?P<newname>.+)_\\d+" $INPUT_DIR/*.nc
+```
+
+`splitnc` will automatically determine which variables are fields by looking at which variables depend on other variables.
+Variables with nothing depending on them are deemed to be fields.
+Alternatively one could use `--field-vars fld_.+` to match the variable names in these files.
+
+The `--rename-regex` option with the supplied regex will rename variables like
+`time_0` or `pseudo_level_0` are renamed to `time` or `pseudo_level`.
+
+The `--shared-vars` option will ensure that the variable `latitude_longitude` is
+included in all files even though none of the field variable depend on it.
+
+### Ice
+To use this script for split multi-field ice files from ACCESS-ESM1.6:
+```bash
+splitnc --shared-vars uarea,tmask,tarea --excluded-vars VGRD. $INPUT_DIR/*.nc
+```
+
+In comparison to the atmosphere files, ice files have different shared-vars and there are no duplicated variables that require renaming.
+The variables `VGRDb`, `VGRDi`, and `VGRDs` are not required and can thus be excluded from the output.

splitnc-0.0.0/pyproject.toml

@@ -0,0 +1,42 @@
+[project]
+name = "splitnc"
+dynamic = ["version"]
+authors = [
+    {name = "Joshua Torrance", email="joshua.torrance@anu.edu.au"},
+    {name = "Spencer Wong", email="spencer.wong@anu.edu.au"},
+]
+maintainers = [
+    {name = "Joshua Torrance", email="joshua.torrance@anu.edu.au"},
+]
+description = "Split multi-field ESM1.6 files into single-field files"
+readme = "README.md"
+license = "Apache-2.0"
+keywords = ["ACCESS-NRI", "netcdf"]
+requires-python = ">=3.9"
+dependencies = [
+    "netcdf4",
+    "xarray",
+]
+
+[project.optional-dependencies]
+    test = [
+        "pytest",
+        "netCDF4",
+        "xarray>2025.1.2",
+    ]
+
+[project.urls]
+    Repository = "https://github.com/ACCESS-NRI/splitnc"
+
+[project.scripts]
+splitnc = "splitnc:main"
+
+[build-system]
+build-backend = "setuptools.build_meta"
+requires = [
+    "setuptools",
+]
+
+[tool.pytest.ini_options]
+    testpaths = "test"
+    pythonpath = "src"

splitnc-0.0.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

splitnc-0.0.0/src/splitnc/__init__.py

@@ -0,0 +1 @@
+from .splitnc import *