Move ocean and visualization conda-package scripts
#597
Conversation
This merge also fixes a few PEP8 issues with coastal alteration. The original scripts are left as stubs that call the entry point functions.
This merge also fixes a few PEP8 issues with moc. The original script is left as stubs that calls the entry point function.
|
Tested as part of MPAS-Dev/compass#881. |
|
@sbrus89, can I ask you to represent the Ocean team by reviewing this (and MPAS-Dev/compass#881 if you like)? |
|
You can get these changes by installing the 1.0.0rc2 package from the |
|
@xylar, sure I can take a look. Thanks for making these changes. |
| @@ -71,12 +71,7 @@ | |||
| 'landice/mesh_tools_li/create_landice_grid_from_generic_MPAS_grid.py', | |||
| 'landice/mesh_tools_li/define_cullMask.py', | |||
| 'landice/mesh_tools_li/interpolate_to_mpasli_grid.py', | |||
There was a problem hiding this comment.
Are changes needed for these other scripts as well?
There was a problem hiding this comment.
Those are in #596, which I haven't asked you to review.
| cd ${SRC_DIR}/conda_package/ocean/smooth_topo | ||
| cd ${SRC_DIR}/ocean/smooth_topo |
There was a problem hiding this comment.
I don't understand the changes in this file and how they relate to the main objective of the PR, but I'm sure that's just because of my relative conda package ignorance.
There was a problem hiding this comment.
We were copying the ocean and several other directories into the conda_package directory so the tools found there could be included in the conda package. A major purpose of this PR is to no longer make those copies but rather to require that the conda package takes no python code from outside the conda_package directory. So that change is on purpose.
There was a problem hiding this comment.
We can still build the C++ and Fortran tools that are outside of conda_package but we need to point to them where they are, not where they used to be copied to.
|
Thanks @sbrus89! I really appreciate the prompt review! |
This merge aims to move 5 scrips used primarily or exclusively by MPAS-Ocean in Compass into the
mpas_toolspackage as entry points.The motivation for this is that we are engaging in Python package modernization on all MPAS-Dev and E3SM-Project repos, and in that process we discovered that modern packaging approaches do not support standalone scripts as the old approach did.
The code from 4 of the 5 scripts has been moved into modules within
mpas_tools(the 5th script, the paraview VTK extractor, was already a stub). They are inside of functions, as required for entry points into a Python package, in all cases. The original scripts are preserved as stubs that call the entry points.The entry points cannot have the same names as the original scripts: the
.pyextention is not allowed.A few fixes have been made to update the coastal alteration and MOC modules for better PEP8 compliance.
The documentation has been updated to reflect the new names of the command-line tools.