Skip to content

Update README #8

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
astropenguin merged 2 commits into from
Nov 14, 2023
Merged

Update README #8

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ed43a3d
#7 Update README
astropenguin Nov 14, 2023
1a5b79c
#7 Add alias (download = cli.download)
astropenguin Nov 14, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 8 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,11 +7,15 @@

DESHIMA raw data and downloader package

# Usage
## Use of the data

Please contact [@astropenguin](https://github.com/astropenguin) before using the data.

## Download the data

```
$ pip install deshima-rawdata
$ deshima-rawdata download <obsid>
$ deshima-rawdata download <observation ID>
```

See the command help for more information.
Expand All @@ -20,9 +24,9 @@ See the command help for more information.
$ deshima-rawdata download --help
```

# List of raw data
## List of the data

| Observation ID | File name | Source | Observation type |
| Observation ID | File name | Source name | Observation type |
| --- | --- | --- | --- |
| 20231108052231 | 20231108052231.tar.gz | Jupiter | raster |
| 20231109015146 | 20231109015146.tar.gz | Jupiter | zscan |
Expand Down
6 changes: 5 additions & 1 deletion deshima_rawdata/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,10 @@
__all__ = ["cli"]
__all__ = ["cli", "download"]
__version__ = "2023.11.0"


# submodules
from . import cli


# aliases
from .cli import *