Skip to content

Commit

Permalink
Update how to use section.
Browse files Browse the repository at this point in the history
  • Loading branch information
YooSunYoung committed Nov 4, 2024
1 parent b5a820b commit 16006e6
Showing 1 changed file with 22 additions and 5 deletions.
27 changes: 22 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ You can start the ingestor daemon with certain configurations.
It will continuously process `wrdn` messages and ingest the nexus files.

```bash
scicat_ingestor --verbose -c PATH_TO_CONFIGURATION_FILE.yaml
scicat_ingestor --logging.verbose -c PATH_TO_CONFIGURATION_FILE.yaml
```

See [configuration](#configuration) for how to use configuration files.
Expand All @@ -34,13 +34,30 @@ You need to know the path to the nexus file you want to ingest
and also the path to the ``done_writing_message_file`` as a json file.

```bash
background_ingestor \\
--verbose \\
-c PATH_TO_CONFIGURATION_FILE.yaml \\
--nexus-file PATH_TO_THE_NEXUS_FILE.nxs \\
background_ingestor \
--logging.verbose \
-c PATH_TO_CONFIGURATION_FILE.yaml \
--nexus-file PATH_TO_THE_NEXUS_FILE.nxs \
--done-writing-message-file PATH_TO_THE_MESSAGE_FILE.json
```

### Dry run

You can add ``--ingestion.dry-run`` flag for dry-run testings.

```bash
scicat_ingestor --logging.verbose -c PATH_TO_CONFIGURATION_FILE.yaml --ingestion.dry-run
```

```bash
background_ingestor \
--logging.verbose \
-c PATH_TO_CONFIGURATION_FILE.yaml \
--nexus-file PATH_TO_THE_NEXUS_FILE.nxs \
--done-writing-message-file PATH_TO_THE_MESSAGE_FILE.json \
--ingestion.dry-run
```

## Configuration

You can use a json file to configure options.
Expand Down

0 comments on commit 16006e6

Please sign in to comment.