michael_ul
/
odm
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity
Browse Source

Generate usage information from doc.txt

master
Michael Uleysky 4 weeks ago
parent
8832ff7232
commit
6c977864a9
4 changed files with 103 additions and 50 deletions
Whitespace
Show all changes Ignore whitespace when comparing lines Ignore changes in amount of whitespace Ignore changes in whitespace at EOL
Split View
Diff Options
Show Stats Download Patch File Download Diff File
  1. 85
      doc.txt
  2. 3
      genusageh
  3. 11
      src/CMakeLists.txt
  4. 54
      src/odm.cpp

85
doc.txt
Unescape View File

@ -0,0 +1,85 @@
color, nocolor - включить/выключить цветной вывод в консоль.
Действия
info - показывает информацию об источнике данных. Собственных параметров нет. Обычно нужен параметр dataset для указания источника данных.
tsc - получает физические величины на некоторой плоскости из источника данных. Параметры:
var или vars - список разделённых запятыми физических величин. Возможные значения: U, U2, u, v, ugeo, vgeo, temp, ptemp, pdens, sal, chl, mld, ssh, w, NO3, PO4, Si, O2, prprod, Cchl. Доступность тех или иных величин зависит от источника данных. Если источник имеет список переменных по умолчанию, то этот параметр может быть опущен.
time или пара timeb, timee. Параметр time может быть как одним моментом времени, так и регулярным выражением. Также time, timeb и timee могут быть одним из слов BEGIN, BEG, FIRST (соответствуют минимальному времени, для которого доступны данные) или END, LAST (соответствуют максимальному времени, для которого доступны данные). Если time меньше, чем BEGIN, будет использоваться минимальное время, если time больше END - максимальное. Если time регулярное выражение, то из набора данных выбираются моменты времени соответствующие этому выражению, и по ним проводится усреднение. Пара timeb и timee работает по аналогичному принципу, только выбираются моменты времени между timeb и timee включительно.
lonb, lone, latb, late - регион, для которого берутся данные. Для некоторых источников данных обязателен, для других игнорируется, смотри описания источников.
out - выходной файл.
format - формат выходного файла. Может быть bin или nc (netcdf). Если этот параметр отсутствует, формат определяется по расширению выходного файла (.bin или .nc). Игнорируется для источника COPERNICUS.
compress - число от 0 до 9, степень сжатия netcdf файла. По умолчанию - 3.
gradient - если параметр присутствует, считать градиенты полей, а не сами поля. Игнорируется для источника COPERNICUS.
average - усреднить все поля по времени. Пока не реализовано для источника COPERNICUS.
obfuscate - если параметр присутствует, не записывать в выходные файлы метаинформацию.
debug - если параметр присутствует, записать в выходной файл дополнительную информацию. Игнорируется при наличии obfuscate.
uv - получает скорость, производные от неё величины, вычисляет стационарные точки.
time, timeb, timee - смотри описание tsc.
lonb, lone, latb, late - смотри описание tsc.
geostrophic. Может быть быть пустым или любым из значений ssh, surf, surface, nongeo. Определяет, какую скорость из имеющихся в наборе данных использовать. Для значения ssh или пустого используются геострофические скорости, рассчитанные по полю высоты уровня моря. Для значений surf или surface используются гестрофические поверхностные скорости из данных. Для значения nongeo используются обычные скорости.
out - выходной файл со скоростями, дивергенцией, ротором, параметром Окуба-Вейсса, квадратом скорости и её дисперсии (вихревая кинетическая энергия). Если этот параметр отсутствует, соответствующий файл не будет записан.
outformat - формат выходного файла (out). Может быть bin или nc (netcdf). Если этот параметр отсутствует, формат определяется по расширению выходного файла (.bin или .nc).
velout - выходной файл компонентов скорости с прореженной сеткой. При отсутствии этот файл не пишется.
veloutformat - то же самое, что и outformat, только для velout файла.
shiftx, shifty - сдвиг начальной точки прореженной сетки относительно исходной. По умолчанию оба параметра равны нулю.
skipx, skipy - шаг по исходной сетке. Если равен 1, то выводится каждая точка исходной сетки, если 2, то каждая вторая и т. д. По умолчанию оба параметра равны 1.
stpout - выходной файл с особыми точками. При отсутствии этот файл не пишется.
stpoutformat - формат файла с особыми точками. Смотри outformat.
compress - число от 0 до 9, степень сжатия netcdf файлов. По умолчанию - 3.
obfuscate - если параметр присутствует, не записывать в выходные файлы метаинформацию.
int - интерполирует данные для точек траекторий
var или vars - список разделённых запятыми физических величин. См. описание этого параметра для action tsc.
out - выходной файл.
input - входной файл с траекториями.
genintfile - делает файл со скоростями для расчёта лагранжевых траекторий.
time, timeb, timee - смотри описание tsc.
lonb, lone, latb, late - смотри описание tsc.
geostrophic. Смотри описание этого параметра для action=uv.
out - выходной файл.
grad - Работает только с источником TSCDATA. Берётся выходной файл от action=tsc и для всех переменных в нём рассчитывает градиенты по методу Белкина.
out - выходной файл.
compress - число от 0 до 9, степень сжатия netcdf файлов. По умолчанию - 3.
$var_min, $var_max, $var_log, где $var - имя переменной. Управляют первым этапом, нормализацией значений переменных. Значения переменных приводятся к интервалу 0-65534, значения меньше $var_min становятся нулём, больше $var_max - 65534. Если $var_min и/или $var_max не указаны, они выставляются в минимальное/максимальное значение для данной переменной. Если задана $var_log (с любым значением или вообще без него), то перед нормализацией берётся логарифм от значения переменной, в этом случае $var_min и $var_max должны быть больше нуля.
mirror - зеркалирование данных в локальное хранилище. Своих параметров нет, они определяются источником.
Источники
AVISO - спутниковые данные для уровня моря и геострофических скоростей. Для этого источника доступно выделение отдельного региона.
dataset - DT, NRT, EckmanDT или EckmanNRT. По умолчанию DT.
layer или depth. Для EckmanDT и EckmanNRT доступны два слоя. Подробнее смотри описание этих параметров для источника NEMO.
AVISOLOCAL - спутниковые данные для уровня моря и геострофических скоростей, локальное зеркало. Для этого источника доступно выделение отдельного региона. Других параметров нет.
BINFILE - файл со скоростями для расчёта лагранжевых траекторий. Регион не нужен, всегда используется вся область файла.
dataset - путь или идентификатор файла.
MODISBINLOCAL - локальное зеркало данных по температуре поверхности моря и концентрации хлорофилла спутников Aqua- и Terra-MODIS. Нужно указывать регион.
dataset - одно или несколько ключевых слов, разделённых запятыми, из списка A_CHL, T_CHL, CHL (A_CHL, T_CHL), A_SST, T_SST, A_SST4, T_SST4, A_NSST, T_NSST, A_DSST (A_SST, A_SST4), T_DSST (T_SST, T_SST4), A_ALL (A_DSST, A_NSST), T_ALL (T_DSST, T_NSST), SST (A_SST, T_SST), SST4 (A_SST4, T_SST4), DSST (A_DSST, T_DSST), NSST (A_NSST, T_NSST), ALL (A_ALL, T_ALL). Ключевые слова, соответствующие температуре и хлорофиллу, не должны смешиваться и должны соответствовать запрашиваемой переменной (chl или temp). По умолчанию CHL или ALL, в зависимости от параметра var.
HYCOM - данные реанализа по модели HYCOM. Нужно указывать регион.
dataset - Forecast или Hindcast. По умолчанию Forecast.
layer или depth - выбор слоя или глубины. Подробнее смотри описание этих параметров для источника NEMO.
NEMO - данные реанализа по модели NEMO. Нужно указывать регион.
dataset - DT, NRT, NRT6 (глобальные), BALTICDT, BALTICNRT, BALTICNRT1, BLKSEADT, BLKSEANRT, MEDSEADT, MEDSEANRT, BISCDT, BISCNRT, ENWSDT, ENWSNRT (региональные). По умолчанию DT.
layer или depth - выбор номера слоя или глубины в метрах. Если указаны оба параметра, приоритет имеет depth. Если указан depth, выбирается слой, ближайший к заданной глубине. Нумерация слоёв начинается с нуля и идёт сверху вниз. Если не указаны оба параметра, используется нулевой слой (поверхность). Эти параметры игнорируются для некоторых переменных, например, ssh или mld.
NEMOBIO - модель распространения биогенов по данным реанализа NEMO. Нужно указывать регион.
dataset - DT или NRT. По умолчанию DT.
layer или depth - выбор слоя или глубины. Подробнее смотри описание этих параметров для источника NEMO.
VYLET - данные лагранжева моделирования с помощью vylet. Регион берётся из файла с данными.
dataset - имя файла с данными.
TSCDATA - данные от tsc. Используется действием grad.
dataset - имя выходного файла от tsc в netcdf формате.
GRIDFILE - данные для скорости в виде двух файлов в Surfer 6 grd формате. Время не используется и всегда равно началу эпохи.
u - файл с u-компонентой
v - файл с v-компонентой
unit - единица измерения. По умолчанию - cm/s
COPERNICUS - источник для зеркалирования данных с серверов copernicus.
product - название продукта
dataset - названия наборов данных в конкретном продукте, через запятую. Если отсутствует, будут зеркалироваться все наборы данных продукта.
filter - регулярное выражение, определяющее имена файлов для зеркалирования. По умолчанию - ".*". Только для действия mirror.
Следующие параметры влияют на выбор подмножества данных и работают для действий tsc и info.
lonb, lone, latb, late - регион, для которого берутся данные. В случае отсутствия используются минимумы/максимумы из данных.
layer, layers, depth, depths - выбор горизонта/горизонтов. Если отсутствуют все эти параметры, используется слой с нулевым номером (приповерхностный). Если присутствуют два или более параметра, то использует параметр с большим приоритетом. layer > depth > layers > depths.
layer - номер горизонта, ноль соответствует поверхности,
layers - номер горизонта или диапазон горизонтов через двоеточие или слово ALL (all) для выбора всех горизонтов,
depth - глубина, выбирается горизонт, ближайший к этой глубине,
depths - глубина или диапазон глубин, разделённых двоеточием, горизонты выбираются так же, как и для параметра depth.
time, timeb, timee, timefilt - параметры, управляющие выбором моментов времени. Использовать можно либо time, либо тройку timeb, timee, timefilt.
time - фиксированое время, регулярное выражение или одно из значений BEGIN, BEG, FIRST (соответствуют минимальному времени, для которого доступны данные) или END, LAST (соответствуют максимальному времени, для которого доступны данные). В случае фиксированого времени, выбирается ближайшее доступное время. Если time регулярное выражение, то это синоним timefilt.
timeb, timee, timefilt - выбираются времена в интервале timeb : timee, удовлетворяющие регулярному выражению timefilt. Если timefilt отсутствует, используются все времена в интервале. По умолчанию timeb=BEG, timee=END.
var, vars - синонимы, var имеет больший приоритет. Список переменных, разделённых запятыми. Базовый список можно посмотреть в выводе действия info.

3
genusageh
Unescape View File

@ -0,0 +1,3 @@
#!/bin/bash
sed -e 's/"/\\"/g;s/$/\\n"/;s/^/"/' "$1" > "$2"

11
src/CMakeLists.txt
Unescape View File

@ -1,6 +1,7 @@
set(EXENAME odm)
set(ACTIONLISTINC ${CMAKE_CURRENT_BINARY_DIR}/../include/actionlist.h) # Include actions files and define the actions classes list
set(DATALISTINC ${CMAKE_CURRENT_BINARY_DIR}/../include/datalist.h) # Include data sources files and define the data sources classes list
set(USAGEH ${CMAKE_CURRENT_BINARY_DIR}/../include/usage.h)
find_package(PkgConfig REQUIRED)
find_library(netcdf netcdf REQUIRED)
@ -21,10 +22,18 @@ file(GLOB srcs CONFIGURE_DEPENDS *.cpp)
add_executable(${EXENAME} ${srcs} ${ACTIONLISTINC} ${SOURCELISTINC})
target_include_directories(${EXENAME} PRIVATE ../michlib/michlib ${CMAKE_CURRENT_BINARY_DIR}/../include)
target_link_libraries(${EXENAME} ${linker_options} ${netcdf} ${udunits} OpenMP::OpenMP_CXX CURL::libcurl ${JSONCPP_LINK_LIBRARIES} ${BLOSC_LINK_LIBRARIES} ${LIBPQ_LINK_LIBRARIES} LibXml2::LibXml2 SQLite::SQLite3 teos)
target_link_libraries(${EXENAME} PRIVATE ${linker_options} ${netcdf} ${udunits} OpenMP::OpenMP_CXX CURL::libcurl ${JSONCPP_LINK_LIBRARIES} ${BLOSC_LINK_LIBRARIES} ${LIBPQ_LINK_LIBRARIES} LibXml2::LibXml2 SQLite::SQLite3 teos)
set_target_properties(${EXENAME} PROPERTIES POSITION_INDEPENDENT_CODE ON)
install(TARGETS ${EXENAME})
add_custom_command(OUTPUT ${USAGEH}
COMMAND ${CMAKE_CURRENT_SOURCE_DIR}/../genusageh ${CMAKE_CURRENT_SOURCE_DIR}/../doc.txt ${USAGEH}
DEPENDS ${CMAKE_CURRENT_SOURCE_DIR}/../doc.txt ${CMAKE_CURRENT_SOURCE_DIR}/../genusageh
VERBATIM
)
add_custom_target(usageh DEPENDS ${USAGEH})
add_dependencies(${EXENAME} usageh)
# Begin generation of actions list
get_target_property(INCS ${EXENAME} INCLUDE_DIRECTORIES)
list(TRANSFORM INCS PREPEND "-I")

54
src/odm.cpp
Unescape View File

@ -1,57 +1,13 @@
#include "odm.h"
const char usage[] =
#include "usage.h"
;
inline void Usage(const MString& arg0)
{
message(arg0 + " (<key>=<value>...)");
message("Keys are:");
message(" action. What the program should do. May be: info, tsc, uv, genintfile. Default: info.");
message(" Keys for action=info. Print some information about dataset.");
message(" source. Required. May be: NEMO, NEMOBIO, HYCOM, AVISO, AVISOLOCAL, BINFILE");
message(" Keys for source=NEMO");
message(" dataset. Can be DT, NRT or NRT6. Default: DT");
message(" Keys for source=NEMOBIO");
message(" dataset. Can be DT or NRT. Default: DT");
message(" Keys for source=HYCOM");
message(" dataset. Can be Forecast, Hindcast or Reanalysis. Default: Forecast");
message(" Keys for source=AVISO");
message(" dataset. Can be DT, NRT, EckmanDT or EckmanNRT. Default: DT");
message(" Keys for action=tsc. Get temperature, salinity, chlorofill from dataset.");
message(" source. Required. May be: NEMO, NEMOBIO, HYCOM, AVISO, AVISOLOCAL, BINFILE");
message(" var. Required. May be: U, U2, u, v, temp, ptemp, pdens, sal, chl, mld, ssh, w, NO3, PO4, Si, prprod, Cchl.");
message(" time. Time moment or regular expression. If present, timeb and timee must be absent");
message(" timeb, timee. Time interval. If present, time must be absent");
message(" lonb, lone, latb, late. Required. Region of interest");
message(" out. Output file. Default: out.bin");
message(" Keys for source=NEMO");
message(" dataset. Can be DT, NRT or NRT6. Default: DT");
message(" layer and/or depth. Layer or depth of NEMO dataset. If depth is specified, layer is ignored. Both ignored, if var=mld or var=ssh. Default: layer=0");
message(" Keys for source=NEMOBIO");
message(" dataset. Can be DT or NRT. Default: DT");
message(" layer and/or depth. Layer or depth of NEMOBIO dataset. If depth is specified, layer is ignored. Default: layer=0");
message(" Keys for source=HYCOM");
message(" dataset. Can be Forecast, Hindcast or Reanalysis. Default: Forecast");
message(" layer and/or depth. Layer or depth of HYCOM dataset. If depth is specified, layer is ignored. Both ignored, if var=mld or var=ssh. Default: layer=0");
message(" Keys for source=AVISO");
message(" dataset. Can be DT, NRT, EckmanDT or EckmanNRT. Default: DT");
message(" layer and/or depth. Layer or depth of AVISO dataset. If depth is specified, layer is ignored. Both ignored for datasets DT and NRT. Default: layer=0");
message(" Keys for source=BINFILE");
message(" dataset. Path or DataID of interpolation file");
message(" Keys for action=uv. Get velocity field and its derivatives.");
message(" source. Required. May be: NEMO, HYCOM, AVISO, AVISOLOCAL, BINFILE");
message(" time. Time moment or regular expression. If present, timeb and timee must be absent");
message(" timeb, timee. Time interval. If present, time must be absent");
message(" out. Output file for components of velocity field, divergency, rotor and Okubo-Weiss parameter. If absent, this data not calculated.");
message(" velout. Output file for sparse velocity field. If present, parameters shiftx, shifty, skipx, skipy controls the sparsing.");
message(" shiftx, shifty. Shift of the sparsed grid. Used only if velout parameter is present. Default: 0");
message(" skipx, skipy. How many poinst skipped in the sparsed grid. Used only if velout parameter is present. Default: 1, output each point");
message(" stpout. Output file for stationary points. If absent, this data not calculated.");
message(" Keys for specific sources see in the section action=tsc.");
message(" Keys for action=genintfile. Create file with velocity field for interpolation.");
message(" source. Required. May be: NEMO, HYCOM, AVISO, AVISOLOCAL");
message(" time. Time moment or regular expression. If present, timeb and timee must be absent");
message(" timeb, timee. Time interval. If present, time must be absent");
message(" out. Output file, required.");
message(" Keys for specific sources see in the section action=tsc.");
message(usage);
}
int main(int argc, char** argv)

Write Preview
Loading…
Cancel
Save