Skip to content

Commit

Permalink
Merge pull request #9 from JCSDA/feature/cd_v241_H2OtoRH
Browse files Browse the repository at this point in the history
Feature/cd_v241_H2OtoRH
  • Loading branch information
BenjaminTJohnson authored Mar 8, 2023
2 parents 4dbc317 + 2b6c829 commit b64fa71
Show file tree
Hide file tree
Showing 10 changed files with 858 additions and 126 deletions.
5 changes: 2 additions & 3 deletions Get_CRTM_Binary_Files.sh
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
#foldername="fix_REL-2.4.0" #rel 2.4.0 files
foldername="fix_REL-2.4.1_latest"
foldername="fix_REL-3.0.0_20230303"

filename="${foldername}.tgz"
if test -f "$filename"; then
Expand All @@ -14,7 +13,7 @@ if test -f "$filename"; then
else
#download, untar, move
echo "downloading $filename, please wait about 5 minutes (3.3 GB tar file)"
wget -q ftp://ftp.ssec.wisc.edu/pub/s4/CRTM/$filename # CRTM binary files
wget ftp://ftp.ssec.wisc.edu/pub/s4/CRTM/$filename # CRTM binary files, add "-q" to suppress output.
tar -zxvf $filename
mv $foldername fix
echo "fix/ directory created from downloaded $filename."
Expand Down
31 changes: 17 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,19 @@
CRTM REL-2.4.1-alpha
CRTM REL-3.0.0
====================

[![Build Status](https://app.travis-ci.com/JCSDA-internal/crtm.svg?token=r6aaq9P13fHcTi8yBgdM&branch=develop)](https://app.travis-ci.com/JCSDA-internal/crtm)

Preamble
--------

CRTM v2.4.1-alpha release (`REL-2.4.1-alpha`)
CRTM v3.0.0 release (`REL-3.0.0`)

v2.4.1-alpha Released on April 1, 2021
v3.0.0 Released March, 2023
v2.4.1-alpha Released on April 1, 2021 (internal realease only)
v2.4.0 Released on October 23, 2020

This is an alpha release of CRTM v2.4.1, some features may not be fully functional. Contact [email protected].
This is an experimental/early release of CRTM v3.0.0, some features may not be fully functional. Contact [email protected].
v3.x features will be rolled out in incremental updates.

Basic requirements:
(1) A Fortran 2003 compatible compiler
Expand Down Expand Up @@ -53,7 +55,7 @@ Contents

Configuration, building, and testing the library
================================================
JCSDA CRTM v2.4.x Build Instructions
JCSDA CRTM v3.0.x Build Instructions

- Development Repository Build
- Note: the development repository build differs from a release build.
Expand All @@ -67,7 +69,7 @@ The CRTM **development** repository directory structure looks like:
├── NOTES
├── README.md
├── Set_CRTM_Environment.sh
├── Uncompress_Binary_Files.sh (manually gunzip files in the fix/ directory after cloning)
├── Get_CRTM_Binary_Files.sh
├── <b>configuration/</b>
├── <b>documentation/</b>
├── <b>fix/</b>
Expand Down Expand Up @@ -121,8 +123,9 @@ But after a clean clone of the development repository, none of the links to sour

Configuration
-------------
Unlike version 2.4.0, the "`fix/`" directory is now provided in the CRTM via git-LFS. The files therein are gzipped (*.gz extension).
Uncompress_Binary_Files.sh script will traverse and gunzip all of the files.
At present, the 'fix/' directory is provided through ftp, rather than git-LFS. We're working on a way to make the process of getting binary data equitable and easy for all users.

The files therein are gzipped (*.gz extension). Use the Get_CRTM_Binary_Files.sh script to obtain and unpack the dataset.

At the top level (`crtm/`), the `configuration` directory contains the various compiler-specific configuration files.
<pre>
Expand Down Expand Up @@ -244,10 +247,10 @@ make install
Linking to the library
----------------------

Let's assume the above install was moved into "/home/username/CRTM/crtm_v2.4.1/", to use the library in this structure in your own application, the usual environment variables would need to be be modified something like:
Let's assume the above install was moved into "/home/username/CRTM/crtm_v3.0.0/", to use the library in this structure in your own application, the usual environment variables would need to be be modified something like:

<pre>
libroot="/home/username/CRTM/crtm_v2.4.1"
libroot="/home/username/CRTM/crtm_v3.0.0"
FCFLAGS="-I${libroot}/include ${FCFLAGS}"
LDFLAGS="-L${libroot}/lib ${LDFLAGS}"
LIBS="-lcrtm ${LIBS}"
Expand All @@ -260,11 +263,11 @@ To uninstall the library (assuming you haven't moved the installation directory

make uninstall

This will DELETE the created installation directory. So, for a library version, say, v2.4.1, if your configure script invocation was something like
This will DELETE the created installation directory. So, for a library version, say, v3.0.0, if your configure script invocation was something like

./configure --prefix=${PWD} ...other command line arguments...

then the "uninstall" target will delete the "${PWD}/crtm_v2.4.1" directory.
then the "uninstall" target will delete the "${PWD}/crtm_v3.0.0" directory.


Cleaning Up
Expand Down Expand Up @@ -311,13 +314,13 @@ make install

**Additional options for `configure`**

`configure` sets an install path environment variable, among other things. This, by default, will set the `lib/` and `include/` directory paths in the `/usr/local/crtm_v2.4.1/` (or whatever string in in `src/CRTM_Version.inc`).
`configure` sets an install path environment variable, among other things. This, by default, will set the `lib/` and `include/` directory paths in the `/usr/local/crtm_v3.0.0/` (or whatever string in in `src/CRTM_Version.inc`).

The `--prefix` switch sets the installation directory, make sure you have write access to that directory.

You can override this by setting a different install directory as follows:
` ./configure --prefix=<install directory>`
For example, `./configure --prefix=${PWD}` will create the library in the directory in which you're currently in (e.g., crtm/src/Build/crtm_v2.4.1/).
For example, `./configure --prefix=${PWD}` will create the library in the directory in which you're currently in (e.g., crtm/src/Build/crtm_v3.0.0y/).

By default, the CRTM is built for big-endian I/O. The --disable-big-endian switch builds the library and test programs for little-endian I/O:

Expand Down
15 changes: 8 additions & 7 deletions README_JEDI.md
Original file line number Diff line number Diff line change
@@ -1,21 +1,21 @@
README_JEDI.md

CRTM REL-2.4.1-alpha
CRTM REL-3.0.0
Released April 1, 2021



The README.md file contains a lot of general information about this repository and the legacy build system based on autotools.

CRTM REL-2.4.1-alpha JEDI environment build instructions
CRTM REL-3.0.0 JEDI environment build instructions
=========================================================

Preamble
--------

CRTM v2.4.1-alpha release (`REL-2.4.1-alpha`)
CRTM v3.0.0-alpha release (`REL-3.0.0`)

This is a fully functional release of CRTM v2.4.1-alpha.
This is a fully functional release of CRTM v3.0.0-alpha.

Basic requirements:
(1) A Fortran 2003 compatible compiler.
Expand Down Expand Up @@ -50,7 +50,7 @@ Contents

Configuration, building, and testing the library
================================================
JCSDA CRTM v2.4.x Build Instructions
JCSDA CRTM v3.0.0 Build Instructions

The CRTM **development** repository directory structure looks like:

Expand All @@ -61,7 +61,7 @@ The CRTM **development** repository directory structure looks like:
├── NOTES
├── README.md
├── Set_CRTM_Environment.sh
├── Uncompress_Binary_Files.sh (uncompresses files in the fix/ directory "manually")
├── Get_CRTM_Binary_Files.sh (downloads the "fix" directory binary data from ftp, this is useful if you're doing out-of-jedi tests or if you want to override the default binary datasets. )
├── CMakeLists.txt (top-level configuration file for ecbuild)
├── <b>configuration/</b>
├── <b>documentation/</b>
Expand Down Expand Up @@ -109,7 +109,8 @@ In the above list, the directories highlighted in bold (bold in markdown), are t

JEDI Configuration
------------------
As of v2.4.1-alpha, the "`fix/`" directory is provided in the CRTM by git LFS. It needs to be uncompressed by running the Uncompress_Binary_Files.sh
As of v3.0.0, binary data is obtained during the ecbuild step, it downloads a tarball from UCAR's GDEX service and unpacks it. see `test/CMakeLists.txt`.


**Configuration**
git clone https://github.com/JCSDA/crtm (you've probably done this already)
Expand Down
5 changes: 0 additions & 5 deletions Uncompress_Binary_Files.sh

This file was deleted.

Loading

0 comments on commit b64fa71

Please sign in to comment.