From f9e01f7a4c63d75823f4bbf5f936183a429e48c4 Mon Sep 17 00:00:00 2001
From: Maria Tarasevich <mashatarasevich@gmail.com>
Date: Thu, 3 Jun 2021 12:01:13 +0000
Subject: [PATCH] Add README.md

---
 README.md | 14 ++++++++++++++
 1 file changed, 14 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..f8eacb0
--- /dev/null
+++ b/README.md
@@ -0,0 +1,14 @@
+Python tool for extracting data from NetCDF to STD
+
+Перед использованием программы, устанавливаем пакет `netCDF4` командой `pip install netCDF4`. 
+
+Программа `extract\_nc.py` принимает на вход один обязательный аргумент: `-i` имя файла `.nc`, который нужно распаковать.
+
+ Также программа  `extract\_nc.py` принимает  2 опциональных параметра:
+
+  * `-v` название переменной, которую нужно извлечь (например, `-v salt`). Можно указать несколько раз, чтобы извлечь несколько переменных из одного файла (например, `-v salt -v ssh);
+  * `-o` имя файла `.std`, в который хотим её записать (например, `-o salt.std`). Если извлекается несколько переменных, в имени файла можно использовать шаблон `{v}`, вместо которого будет подставлено имя извлечённой переменной. Например, комбинация параметров `-v ssh -v salt -o ocean_{v}_1980.std` извлечёт переменную `ssh` в файл `ocean_ssh_1980.std`, а переменную `salt` &mdash; в файл `ocean_salt_1980.std`. Шаблон `{v}` можно использовать и при извлечении только одной переменной. 
+ 
+Чтобы запустить программу `extract_nc.py`, достаточно выполнить `python extract\_nc.py -i example.nc`. При запуске программы  `extract_nc.py` только с _обязательным_ аргументом `-i` она выведет на экран названия _всех_ содержащихся в `.nc` файле переменных.
+
+Если запустить программу  `extract_nc.py` с аргументами `-i` и `-v` (но без аргумента `-o`), выполнив  `python extract_nc.py -i example.nc -v salt`, то она сохранит выбранную переменную (`salt`) в именованный по умолчанию файл `salt.std`.
-- 
GitLab