Skip to content

Commit e066e0a

Browse files
authored
#8 Merge pull request from deshima-dev/astropenguin/issue7
Update README
2 parents b16cd5e + 1a5b79c commit e066e0a

File tree

2 files changed

+13
-5
lines changed

2 files changed

+13
-5
lines changed

README.md

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -7,11 +7,15 @@
77

88
DESHIMA raw data and downloader package
99

10-
# Usage
10+
## Use of the data
11+
12+
Please contact [@astropenguin](https://github.com/astropenguin) before using the data.
13+
14+
## Download the data
1115

1216
```
1317
$ pip install deshima-rawdata
14-
$ deshima-rawdata download <obsid>
18+
$ deshima-rawdata download <observation ID>
1519
```
1620

1721
See the command help for more information.
@@ -20,9 +24,9 @@ See the command help for more information.
2024
$ deshima-rawdata download --help
2125
```
2226

23-
# List of raw data
27+
## List of the data
2428

25-
| Observation ID | File name | Source | Observation type |
29+
| Observation ID | File name | Source name | Observation type |
2630
| --- | --- | --- | --- |
2731
| 20231108052231 | 20231108052231.tar.gz | Jupiter | raster |
2832
| 20231109015146 | 20231109015146.tar.gz | Jupiter | zscan |

deshima_rawdata/__init__.py

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,10 @@
1-
__all__ = ["cli"]
1+
__all__ = ["cli", "download"]
22
__version__ = "2023.11.0"
33

44

55
# submodules
66
from . import cli
7+
8+
9+
# aliases
10+
from .cli import *

0 commit comments

Comments
 (0)