Skip to content
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

Update README.md #70

Merged
merged 4 commits into from
Jul 22, 2024
Merged

Update README.md #70

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
11b1914
Update README.md
daralynnrhode Jul 18, 2024
f7ab490
fix
daralynnrhode Jul 19, 2024
e8f1167
adding link
daralynnrhode Jul 19, 2024
b4526bb
Apply suggestions from code review
daralynnrhode Jul 19, 2024
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
30 changes: 22 additions & 8 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,8 @@

This lightweight Python package allows users to download, query, and upload data from the IMAP Science Data Center (SDC).

For more information see the [detailed instructions](https://imap-processing.readthedocs.io/en/latest/data-access-api/index.html).

## Command Line Utility

### To install
Expand All @@ -14,19 +16,28 @@ pip install imap-data-access
imap-data-access -h
```

### Base Command Arguments
```bash
$ imap-data-access query # or
$ imap-data-access download # or
$ imap-data-access upload
```
Add the '-h' help flag with any base command for more information
Comment on lines +19 to +25
Copy link
Contributor

@bourque bourque Jul 19, 2024 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great idea to include the bear-bones usage here for quick reference. I think between this and the link to the more detailed instructions, it is a good balance.


### Query / Search for data

Find all files from the SWE instrument

```bash
$ imap-data-access query --instrument swe
Found [2] matching files
---------------------------------------------------------------------------------------------------------------|
Instrument|Data Level|Descriptor|Start Date|Repointing|Version|Filename |
---------------------------------------------------------------------------------------------------------------|
swe |l0 |sci |20240105 | |v001 |imap_swe_l0_sci_20240105_v001.pkts |
swe |l0 |sci |20240105 | |v001 |imap_swe_l0_sci_20240105_v001.pkts |
---------------------------------------------------------------------------------------------------------------|
Found [3] matching files
|-----------------------------------------------------------------------------------------------------------------------------------|
| Instrument | Data Level | Descriptor | Start Date | Repointing | Version | Filename |
|-----------------------------------------------------------------------------------------------------------------------------------|
| swe | l0 | raw | 20240510 | | v022 | imap_swe_l0_raw_20240510_v022.pkts |
| swe | l1a | sci | 20240510 | | v022 | imap_swe_l1a_sci_20240510_v022.cdf |
| swe | l1b | sci | 20240510 | | v022 | imap_swe_l1b_sci_20240510_v022.cdf |
|-----------------------------------------------------------------------------------------------------------------------------------|
```

Find all files during the year 2024 and return the response as raw json
Expand All @@ -40,6 +51,9 @@ $ imap-data-access query --start-date 20240101 --end-date 20241231 --output-form

Download a level 0 SWE file on 2024/01/05

> [!NOTE]
> Make sure the directory configuration is correct, see the [Data Directory section](https://github.com/IMAP-Science-Operations-Center/imap-data-access#data-directory) for more information.

```bash
$ imap-data-access download imap/swe/l0/2024/01/imap_swe_l0_sci_20240105_v001.pkts
Successfully downloaded the file to: <IMAP_DATA_DIR>/imap/swe/l0/2024/01/imap_swe_l0_sci_20240105_v001.pkts
Expand Down Expand Up @@ -201,4 +215,4 @@ Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/d

<!-- ALL-CONTRIBUTORS-LIST:END -->

This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!
This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!
Loading