Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Remove the ocean_model_grid_generator subproject. #223

Merged
merged 3 commits into from
May 30, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 0 additions & 3 deletions .gitmodules

This file was deleted.

4 changes: 0 additions & 4 deletions Makefile.am
Original file line number Diff line number Diff line change
Expand Up @@ -52,10 +52,6 @@ SUBDIRS = postprocessing/combine_restarts \
tools/simple_hydrog/rmvpr \
tools/nc_null_check

if ENABLE_OCEAN_MODEL_GRID_GENERATOR
SUBDIRS += tools/ocean_model_grid_generator
endif

if WITH_CHECK_PROGS
SUBDIRS += t
endif
44 changes: 6 additions & 38 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ These tools were largely written by members of the GFDL
primarily for use in the
[Flexible Modeling System](https://www.gfdl.noaa.gov/fms) (FMS)
[Runtime Environment](https://www.gfdl.noaa.gov/fre) (FRE) supporting the
work of the
work of the
[Geophysical Fluid Dynamics Laboratory](https://www.gfdl.noaa.gov)
(GFDL).

Expand Down Expand Up @@ -58,16 +58,8 @@ The tools available in FRE-NCtools are:


### Other Tools
The [Ocean Model Grid Generator](https://github.com/NOAA-GFDL/ocean_model_grid_generator)
is a collection of tools for creating finite element spherical tripolar grids for
GFDL's MOM based ocean models. Unlike the other tools, NCTools includes it as a submodule,
and also it is a Python3 project. Because of the former attribute, recursive
cloning (see below) is recommended. Because of the latter attribute,
the users python environment may need modification and/or options to the
autotools configure command may need to be specified. This includes the
``--disable-ocean-model-grid-generator`` option (default is enable)
and the ```--enable-venv``` option to build a Python venv containing the
Ocean Model Grid Generator script and all python dependencies.
The [Ocean Model Grid Generator](https://github.com/NOAA-GFDL/ocean_model_grid_generator) can be copied or cloned from its GFDL homepage.


### User Documentation
Documentation on using individual tools may be obtained by running
Expand Down Expand Up @@ -98,24 +90,13 @@ Contribution requirements include :
* The passing of existing unit tests when they are run in the CI system.
* The (potential) addition of unit tests when adding new functionality.
* For external projects, unit tests may be required and the unit tests
should be run on the external CI system.
should be run on the external CI system.

Additionally, since NCTools is distributable via the Spack package manager,
the NCTools team will need to be able to compile and distribute via Spack any
submodules and their dependencies. Contributors are encouraged to provide
Spack recipes for their projects.

## Cloning and submodules
The NCTools github repository contains Ocean Model Grid Generator's repository
as a submodule. After cloning NCTools, it must be initialized and updated for
its submodules:

```
git clone --recursive https://github.com/NOAA-GFDL/FRE-NCtools
cd FRE-NCtools
git submodule update --init --recursive
```

## Building and Installation - General Information
FRE-NCtools has a collection of C and Fortran sources. Within GFDL, FRE-NCtools
is built using a recent version of the GNU and Intel C and Fortran compilers.
Expand Down Expand Up @@ -164,26 +145,13 @@ configure --help=recursive

It is common to compile into a build directory (e.g. named `build`) and
install into an installation directory (e.g. with full path `<install path>`).
If the ocean_model_grid_generator is desired, it may be convenient to allow
the build system to set up a Python venv. These three choices can be
done with these steps:
```
cd FRE-NCtools
autoreconf -i
mkdir build && cd build
../configure --prefix=<install path> --enable-venv
make
make install
```

If the ocean_model_grid_generator is not desired, a similar configuration would
be achieved by :
For example:

```
cd FRE-NCtools
autoreconf -i
mkdir build && cd build
../configure --prefix=<install path> --disable-ocean-model-grid-generator
../configure --prefix=<install path>
make
make install
```
Expand Down
12 changes: 0 additions & 12 deletions configure.ac
Original file line number Diff line number Diff line change
Expand Up @@ -53,15 +53,6 @@ AC_ARG_ENABLE([quad-precision],
[],
[enable_quad_precision=no])

AC_ARG_ENABLE([ocean-model-grid-generator],
[AS_HELP_STRING([--enable-ocean-model-grid-generator],
[build and install the ocean model grid generator tool])])
AS_IF([test ${enable_ocean_model_grid_generator:-yes} = yes],
[enable_ocean_model_grid_generator=yes],
[enable_ocean_model_grid_generator=no])
AM_CONDITIONAL([ENABLE_OCEAN_MODEL_GRID_GENERATOR],
[test $enable_ocean_model_grid_generator = yes])

AC_PROG_CC([icc gcc])
AM_PROG_CC_C_O
## When autoconf v2.70 is more available, this can be replaced with:
Expand Down Expand Up @@ -163,9 +154,6 @@ AC_DEFINE([GIT_REVISION], "git_revision",
AC_DEFINE([GIT_HEADHASH], "git_hashval",
[Holds the 'git rev-parse HEAD' information if configure ran within a git working directory])

AS_IF([test $enable_ocean_model_grid_generator = yes],
AC_CONFIG_SUBDIRS([tools/ocean_model_grid_generator])
)

#Code for setting rpath based ncview's configure.in code.
echo "ac_computer_gnu: $ac_compiler_gnu"
Expand Down
1 change: 0 additions & 1 deletion site-configs/gfdl-ws/config.site
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,6 @@
#
# configure options
test -z "$with_mpi" && with_mpi=yes
test -z "$enable_venv" && enable_venv=yes
# Standard prefix location for FRE distribution
test "$prefix" = NONE && prefix=/home/fms/local/opt/fre-nctools/${PACKAGE_VERSION}/gfdl-ws

Expand Down
1 change: 0 additions & 1 deletion site-configs/gfdl/config.site
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,6 @@
#
# configure options
test -z "$with_mpi" && with_mpi=yes
test -z "$enable_venv" && enable_venv=yes
# Standard prefix location for FRE distribution
test "$prefix" = NONE && prefix=/home/fms/local/opt/fre-nctools/${PACKAGE_VERSION}/gfdl

Expand Down
1 change: 0 additions & 1 deletion site-configs/ncrc/config.site
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,6 @@
#
# configure options
test -z "$with_mpi" && with_mpi=yes
test -z "$enable_venv" && enable_venv=yes
# Standard prefix location for FRE distribution
test "$prefix" = NONE && prefix=/ncrc/home2/fms/local/opt/fre-nctools/${PACKAGE_VERSION}/ncrc

Expand Down
1 change: 0 additions & 1 deletion site-configs/ncrc5/config.site
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,6 @@
#
# configure options
test -z "$with_mpi" && with_mpi=yes
test -z "$enable_venv" && enable_venv=yes
# Standard prefix location for FRE distribution
test "$prefix" = NONE && prefix=/ncrc/home2/fms/local/opt/fre-nctools/${PACKAGE_VERSION}/ncrc

Expand Down
6 changes: 4 additions & 2 deletions tools/libfrencutils/affinity.c
Original file line number Diff line number Diff line change
@@ -1,7 +1,9 @@
/** \cond
*/
/***********************************************************************
* GNU Lesser General Public License
*
* This file is part of the GFDL FRE NetCDF tools package (FRE-NCTools).
* This file is part of the GFDL Flexible Modeling System (FMS).
*
* FMS is free software: you can redistribute it and/or modify it under
* the terms of the GNU Lesser General Public License as published by
Expand Down Expand Up @@ -36,6 +38,7 @@
#include <pthread.h>
#endif


/**
* gettid function for systems that do not have this function (e.g. on Mac OS.)
*/
Expand Down Expand Up @@ -134,4 +137,3 @@ int set_cpu_affinity(int cpu)
#endif
return 0;
}

1 change: 0 additions & 1 deletion tools/ocean_model_grid_generator
Submodule ocean_model_grid_generator deleted from 2b0766
Loading