Skip to content

Commit f98d387

Browse files
committed
✏️ Update README
1 parent f5578e8 commit f98d387

File tree

1 file changed

+51
-1
lines changed

1 file changed

+51
-1
lines changed

README.md

Lines changed: 51 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,52 @@
1-
# fobs
1+
# :globe_with_meridians: fobs
22
Convert 45m/ASTE obstable to one for FMLO observation
3+
4+
## Installation
5+
6+
```
7+
$ pip install fobs
8+
```
9+
10+
Note that Python 3.6 or higher is required for fobs.
11+
12+
## Command line interface
13+
14+
Command line interface `fobs` is available after installation.
15+
16+
```
17+
$ fobs -h
18+
fobs: convert 45m/ASTE obstable to one for FMLO observation.
19+
20+
Usage:
21+
fobs <obstable> <actions> [<substitution>...] [options]
22+
fobs -h | --help
23+
fobs -v | --version
24+
25+
Arguments:
26+
<obstable> Path of 45/ASTE obstable (*.start)
27+
<actions> Path of YAML file that describes actions.
28+
<substitution>... String(s) of substitution statement like
29+
param=value. This will replace string of
30+
<param> with value in the converted obstable.
31+
32+
Options:
33+
-h --help Show the help and exit.
34+
-v --version Show the version and exit.
35+
-f --force Force to overwrite existing obstable.
36+
-o --out <path> Path of converted obstable. If not spacified (default),
37+
then string of it will be printed to standard output.
38+
-l --log <path> Path of log file. If not spacified (default),
39+
then log strings will be printed to standard output.
40+
```
41+
42+
### Actions
43+
44+
#### Replace
45+
46+
#### Insert
47+
48+
#### Delete
49+
50+
#### Swap
51+
52+
### Substitutions

0 commit comments

Comments
 (0)