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

Generate netcdf file with check data; delete obsolete files. #64

Merged
merged 2 commits into from
Apr 18, 2024
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
131 changes: 0 additions & 131 deletions GNUmakefile.example

This file was deleted.

5 changes: 4 additions & 1 deletion README
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
TEOS-10 V3.05 GSW Oceanographic Toolbox in C
============================================

This is a translation of the original Fortran-90 source code into C. Unlike
This began as a translation of the original Fortran-90 source code into C. Unlike
the Fortran-90 and Matlab versions of the toolbox, functions in the C version
are primarily scalar. You should download the documentation from
http://teos-10.org, but should look at gswteos-10.h for the C API.
Expand Down Expand Up @@ -89,3 +89,6 @@ ChangeLog:
2011-09-23: gsw-3.0 Initial creation.

Frank Delahoyde <[email protected]>

For more recent changes, see the repo on Github:
https://github.com/TEOS-10/GSW-C
62 changes: 23 additions & 39 deletions README-developer
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,8 @@ Files for users
README -- The README file distributed with the
teos-10.org distribution.
LICENSE -- GSW C software license.
Makefile -- makefile supplied in the teos-10.org
distribution.
Makefile -- Simple default makefile for building the library and
test runner program, gsw_check.
gswteos-10.h -- GSW function prototype definitions
gsw_internal_const.h -- Common parameters used to compile the GSW-C
library.
Expand All @@ -18,7 +18,7 @@ gsw_oceanographic_toolbox.c
gsw_saar.c -- gsw_saar and gsw_deltasa_atlas (modified).
gsw_saar_data.h -- static global absolute salinity anomaly data
used by gsw_saar.c
gsw_check_data.h -- static check data used by gsw_ check functions.c
gsw_check_data.h -- static check data used by gsw_check_functions.c
gsw_check_functions.c -- C implementation of the check functions used
to validate the correct building of the GSW-C
Oceanographic Toolbox.
Expand All @@ -29,55 +29,39 @@ Files for development
=====================

README-developer -- This file.
GNUmakefile -- GNU make makefile used to manage the building
and maintenance of the gsw_c_v3.05.zip file on
teos-10.org, as well as RPMs for RedHat Linux
systems.
gsw_data_v3_0.nc -- A redundant and hopefully current version of
the netcdf file hosted on github as
TEOS-10/datafile. gsw_check_data.h and
gsw_saar_data.h are generated from this file
using the supplied utilities
make_check_data.py and make_saar_data.py.
make_check_data.py -- Utility to generate gsw_check_data.h from
gsw_data_v3_0.nc. **Do not use**
make_saar_data.py -- Utility to generate gsw_saar_data.h from
gsw_data_v3_0.nc. **Do not use**
make_data_from_mat.py -- Utility to generate check data and SAAR data from
gsw_matlab_v3_06_11/library/gsw_data_v3_0.mat.
the gsw_data_v3_0.mat targeted by this release,
presently v3_06_16.
You need to edit the file to supply the correct
path. The geostrophic streamfunction values are
patched in from geo_strf_dyn_height.npy to match
the pchip-based version being used here.
libgswteos-10.spec.proto
-- template used to create libgswteos-10.spec,
the configuration file for rpmbuild on RedHat
Linux platforms.


The file GNUmakefile is supplied for use on Linux/GNU systems. It has two
major purposes:

* To build a zip archive of the distribution suitable for TEOS-10.org; and
* To set up a versioned source distribution suitable for building source
and binary RPMs on RedHat-like Linux systems.

Please note that the current distribution on teos-10.org
(http://teos-10.org/software/gsw_c_v3.05.zip) is a subset of this github
directory and is accurately described by the supplied README file.
path to the matfile for your directory structure.
geo_strf_dyn_height.npy -- Geostrophic streamfunction test values used by
make_data_from_mat.py to match the pchip-based
interpolation used here; for the geostrophic
streamfunction we do not try to exactly match the
Matlab version.
gsw_check_data.nc -- Netcdf version of the information in
gsw_check_data.h. The file is written by
make_data_from_mat.py. It is intended for use by
GSW-Julia, and possibly others.
gsw_data_ncdump.txt -- Edited text from the "ncdump -h" of a netcdf file
that was originally generated by Paul Barker from
an earlier version of gsw_data_v3_0.mat. It is
used by make_data_from_mat.py to find the array
dimensions when generating gsw_check_data.nc.

Notes for contributors
======================

It is anticipated that the primary use for this C library will be
to provide core functionality in the GSW-Python and GSW-R libraries.
to provide core functionality in the GSW-Python, GSW-R, and GSW-Julia
libraries.

If additional core GSW functions are added here, they should be consistent
with their GSW-Matlab versions and with the general style of functions
presently in the C library. Pull Requests for new functions should
include the corresponding tests in gsw_check_functions.c and test data in
gsw_check_data.h. The latter should be the result of re-running the
make_check_data.py utility; gsw_check_data.h should not be hand-edited.
make_data_from_mat utility; gsw_check_data.h should not be hand-edited.

Code style for C should be generally consistent with the existing code
with respect to brackets and indentation, with the proviso that new
Expand Down
1 change: 1 addition & 0 deletions gsw_check_data.h
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@
** version_date: 15th_May_2011
** version_number: 3.06.16
** mat_zip_version: 3_06_16
** This file created on: 2024-02-12 11:26:21.045021
*/

/*
Expand Down
Binary file added gsw_check_data.nc
Binary file not shown.
Loading
Loading