Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
TomHodson authored Sep 23, 2024
1 parent 399186a commit a5109d7
Showing 1 changed file with 9 additions and 9 deletions.
18 changes: 9 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,9 +15,9 @@
### πŸ“‘ What is IonBeam?

**IonBeam** is a toolkit for **stream based processing of IoT observations**. It allows observational IoT data to be
1. Ingested from many sources: REST APIs, MQTT brokers, file servers etc.
2. Transformed, cleaned, split, combined and anything else.
3. Output into multiple storage formats.
1. πŸ”— Ingested from many sources: REST APIs, MQTT brokers, file servers etc.
2. πŸ”„ Transformed, cleaned, split, combined and anything else.
3. πŸ’Ύ Output into multiple storage formats and databases.

Ionbeam uses a **message / action architecture**. Chunks of observations are represented by messages. Messages are routed through a series of actions which perform processing stesps before the final data is written out.

Expand All @@ -43,7 +43,7 @@ IonBeam can be used in three ways:

---

## Dev Installation
## πŸ’» Dev Installation

Install from source

Expand All @@ -68,16 +68,16 @@ pre-commit install

Create a `secrets.yaml` file containing the access credentials for the various sources of data, use `example_secrets.yaml` as a template. `secrets.yaml` is in the gitignore to lower the risk that it accidentally gets committed to git.

## Documentation
## πŸ“š Documentation

The documentation will be available at on readthedocs.io once this repo is made public. For now you can build it with sphinx.

## License
## πŸ“œ License

[Apache License 2.0](LICENSE) In applying this license, ECMWF does not waive the privileges and immunities
granted to it by virtue of its status as an intergovernmental organisation nor does it submit to any jurisdiction.

## Testing
## βœ… Testing

To run the default battery of smoke tests, just run pytest:

Expand All @@ -91,7 +91,7 @@ To run against live APIs use:
$ pytest -m network
```

## Running the Jupyter notebooks
## πŸ““ Running the Jupyter notebooks

Setting up a jupyer lab server from scratch using conda or mamba:

Expand All @@ -109,7 +109,7 @@ jupyter lab
```


## Command Line Usage
## πŸ–₯️ Command Line Usage
Currently the main way to interact with the pipeline is through the command line interface.
```bash
% python -m ionbeam --help
Expand Down

0 comments on commit a5109d7

Please sign in to comment.