Skip to content

Commit 1709e78

Browse files
committed
Update docker workflow and README
1 parent 94a6c52 commit 1709e78

File tree

2 files changed

+51
-1
lines changed

2 files changed

+51
-1
lines changed

.github/workflows/build.yml

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -61,6 +61,10 @@ jobs:
6161
with:
6262
persist-credentials: false
6363

64+
- name: Set up QEMU
65+
# https://github.com/docker/setup-qemu-action
66+
uses: docker/setup-qemu-action@29109295f81e9208d7d86ff1c6c12d2833863392 # v3.6.0
67+
6468
- name: Set up Docker Buildx
6569
# https://github.com/docker/setup-buildx-action
6670
uses: docker/setup-buildx-action@e468171a9de216ec08956ac3ada2f0791b6bd435 # v3.11.1
@@ -86,7 +90,8 @@ jobs:
8690
with:
8791
context: .
8892
file: Dockerfile
89-
platforms: linux/amd64
93+
# Multi-platform on push, single platform on PR (--load only supports one platform)
94+
platforms: ${{ github.event_name == 'push' && 'linux/amd64,linux/arm64' || 'linux/amd64' }}
9095
push: ${{ github.event_name == 'push' }}
9196
tags: ghcr.io/${{ github.repository }}:${{ steps.branch-name.outputs.current_branch }}
9297
cache-from: type=gha

README.md

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
# nautilus_data
2+
3+
Example market data for use with NautilusTrader.
4+
5+
## Installation
6+
7+
```bash
8+
uv pip install nautilus_data
9+
```
10+
11+
## Requirements
12+
13+
- Python 3.13+
14+
- NautilusTrader 1.220.0+
15+
16+
## Usage
17+
18+
This package provides sample market data that can be used for backtesting and development with the NautilusTrader platform.
19+
20+
## Data
21+
22+
The package includes historical foreign exchange (FX) tick data:
23+
24+
- **EUR/USD** - January 2020 tick-level bid/ask quotes
25+
- Format: CSV compressed with gzip.
26+
- Source: Publicly available FX market data.
27+
28+
### Loading data into a catalog
29+
30+
```python
31+
from nautilus_data.hist_data_to_catalog import load_data
32+
33+
# Load historical data into your NautilusTrader catalog
34+
load_data()
35+
```
36+
37+
## Structure
38+
39+
- `catalog/` - Pre-processed data catalog files (once `hist_data_to_catalog.py` is run).
40+
- `raw_data/` - Raw historical data files.
41+
- `bench_data/` - Benchmark data for performance testing.
42+
43+
## More Information
44+
45+
For more information about NautilusTrader, visit [nautechsystems.io](https://nautechsystems.io).

0 commit comments

Comments
 (0)