11# Cloudnet data submission tool
2+
23![ Tests] ( https://github.com/actris-cloudnet/cloudnet-submit/actions/workflows/tests.yml/badge.svg )
34[ ![ PyPI version] ( https://badge.fury.io/py/cloudnet-submit.svg )] ( https://badge.fury.io/py/cloudnet-submit )
45
56## Installation
67
78### Linux/macOS
9+
810If you have ` python ` and ` pip ` installed (` python >= 3.8 ` ),
911run the command:
12+
1013``` sh
1114pip install cloudnet-submit
1215```
1316
1417After that, you can use ` cloudnet-submit ` command to run the program.
1518
1619### Windows
20+
1721If you are using Windows Subsystem for Linux,
1822then the aforementioned Linux installation should work.
1923
@@ -26,11 +30,13 @@ pip install cloudnet-submit
2630```
2731
2832Test if the ` cloudnet-submit ` command works:
33+
2934``` sh
3035cloudnet-submit --version
3136```
3237
3338If not, you can use an alternative way to run the program:
39+
3440``` sh
3541python -m cloudnet_submit --version
3642```
@@ -40,6 +46,7 @@ python -m cloudnet_submit --version
4046### Configuration file
4147
4248Generate a configuration file:
49+
4350``` sh
4451cloudnet-submit --generate-config
4552```
@@ -62,7 +69,6 @@ If your instrument does not have PID yet,
6269please [ fill the form] ( https://docs.google.com/forms/d/e/1FAIpQLSeY4nvAah-K5xPfF-VMhDbmmY9lq7BbtTDKTT9BZMqT7tC7zA/viewform )
6370first.
6471
65-
6672``` toml
6773# cloudnet-config.toml
6874[user_account ]
@@ -115,18 +121,19 @@ for a given measurement date.
115121
116122Use the following format codes:
117123
118- | Directive | Meaning | Example |
119- | ----------- | ------------------------------------ | :--------------------------: |
124+ | Directive | Meaning | Example |
125+ | --------- | ---------------------------------- | :------------------------: |
120126| ` %Y ` | Year with century | 0001, ..., 2023, ..., 9999 |
121- | ` %y ` | Year without century (zero-padded) | 00, ..., 23, ..., 99 |
122- | ` %m ` | Month (zero-padded) | 01, 02, ..., 12 |
123- | ` %d ` | Day (zero-padded) | 01, 02, ..., 31 |
127+ | ` %y ` | Year without century (zero-padded) | 00, ..., 23, ..., 99 |
128+ | ` %m ` | Month (zero-padded) | 01, 02, ..., 12 |
129+ | ` %d ` | Day (zero-padded) | 01, 02, ..., 31 |
124130
125131You can also use wildcard character ` * ` in ` path_fmt ` field.
126132
127133By default, ` cloudnet-submit ` expects the ` cloudnet-config.toml ` file to be
128134in your working directory.
129135You can also use ` --config ` to specify another location for the config file:
136+
130137``` sh
131138cloudnet-submit --config /path/to/your/config.toml
132139```
@@ -148,26 +155,31 @@ of the month, the file will be resubmitted and replaces the previously submitted
148155By default, ` cloudnet-submit ` submits data from the past three days.
149156
150157Use ` --dry-run ` to list files that would be submitted:
158+
151159``` sh
152160cloudnet-submit --dry-run
153161```
154162
155163Submit data to the Cloudnet data portal:
164+
156165``` sh
157166cloudnet-submit
158167```
159168
160169You can also set the number of days to be submitted (including today):
170+
161171``` sh
162172cloudnet-submit --last-ndays 5
163173```
164174
165175You can also specify a date you want to submit:
176+
166177``` sh
167178cloudnet-submit --date 2022-06-21
168179```
169180
170181Or a list of dates:
182+
171183``` sh
172184cloudnet-submit --date 2022-06-21 2022-05-01
173185```
@@ -179,10 +191,12 @@ cloudnet-submit --from-date 2022-05-01 --to-date 2022-06-24
179191```
180192
181193See all the options:
194+
182195``` sh
183196cloudnet-submit --help
184197```
185198
186199## Feedback and contact
200+
187201- Bugs, feature requests, documentation: [ Create an issue] ( https://github.com/actris-cloudnet/cloudnet-submit/issues/new/choose ) on Github
188202- Or just [ send us mail] ( mailto:actris-cloudnet@fmi.fi ) :)
0 commit comments