Skip to content

Commit

Permalink
Update gh-pages to output generated at c9b815d
Browse files Browse the repository at this point in the history
  • Loading branch information
cjdsellers committed Jun 7, 2024
1 parent f32b54e commit 0b65e72
Show file tree
Hide file tree
Showing 1,939 changed files with 6,027 additions and 5,301 deletions.
Binary file modified nightly/.doctrees/api_reference/accounting.doctree
Binary file not shown.
Binary file modified nightly/.doctrees/api_reference/adapters/betfair.doctree
Binary file not shown.
Binary file modified nightly/.doctrees/api_reference/adapters/binance.doctree
Binary file not shown.
Binary file not shown.
Binary file modified nightly/.doctrees/api_reference/analysis.doctree
Binary file not shown.
Binary file modified nightly/.doctrees/api_reference/backtest.doctree
Binary file not shown.
Binary file modified nightly/.doctrees/api_reference/cache.doctree
Binary file not shown.
Binary file modified nightly/.doctrees/api_reference/common.doctree
Binary file not shown.
Binary file modified nightly/.doctrees/api_reference/config.doctree
Binary file not shown.
Binary file modified nightly/.doctrees/api_reference/core.doctree
Binary file not shown.
Binary file modified nightly/.doctrees/api_reference/data.doctree
Binary file not shown.
Binary file modified nightly/.doctrees/api_reference/execution.doctree
Binary file not shown.
Binary file modified nightly/.doctrees/api_reference/indicators.doctree
Binary file not shown.
Binary file modified nightly/.doctrees/api_reference/live.doctree
Binary file not shown.
Binary file modified nightly/.doctrees/api_reference/model/book.doctree
Binary file not shown.
Binary file modified nightly/.doctrees/api_reference/model/data.doctree
Binary file not shown.
Binary file modified nightly/.doctrees/api_reference/model/events.doctree
Binary file not shown.
Binary file modified nightly/.doctrees/api_reference/model/identifiers.doctree
Binary file not shown.
Binary file modified nightly/.doctrees/api_reference/model/instruments.doctree
Binary file not shown.
Binary file modified nightly/.doctrees/api_reference/model/objects.doctree
Binary file not shown.
Binary file modified nightly/.doctrees/api_reference/model/orders.doctree
Binary file not shown.
Binary file modified nightly/.doctrees/api_reference/model/position.doctree
Binary file not shown.
Binary file modified nightly/.doctrees/api_reference/model/tick_scheme.doctree
Binary file not shown.
Binary file modified nightly/.doctrees/api_reference/persistence.doctree
Binary file not shown.
Binary file modified nightly/.doctrees/api_reference/portfolio.doctree
Binary file not shown.
Binary file modified nightly/.doctrees/api_reference/risk.doctree
Binary file not shown.
Binary file modified nightly/.doctrees/api_reference/serialization.doctree
Binary file not shown.
Binary file modified nightly/.doctrees/api_reference/system.doctree
Binary file not shown.
Binary file modified nightly/.doctrees/api_reference/trading.doctree
Binary file not shown.
Binary file modified nightly/.doctrees/developer_guide/environment_setup.doctree
Binary file not shown.
Binary file modified nightly/.doctrees/environment.pickle
Binary file not shown.
Binary file modified nightly/.doctrees/getting_started/installation.doctree
Binary file not shown.
Binary file modified nightly/.doctrees/integrations/ib.doctree
Binary file not shown.
12 changes: 12 additions & 0 deletions nightly/_sources/developer_guide/environment_setup.md.txt
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,18 @@ The following steps are for UNIX-like systems, and only need to be completed onc

pre-commit install

3. In case of large recompiles for small changes, configure the `PYO3_PYTHON` variable in `nautilus_core/.cargo/config.toml` with the path to the Python interpreter in the poetry managed environment. This is primarily useful for Rust developers working on core and experience frequent recompiles from IDE/rust analyzer based `cargo check`.

```
poetry shell
PYTHON_PATH=$(which python)
echo -e "\n[env]\nPYO3_PYTHON = \"$PYTHON_PATH\"" >> nautilus_core/.cargo/config.toml
```

Since `.cargo/config.toml` is a tracked file, configure git to skip local modifications to it with `git update-index --skip-worktree nautilus_core/.cargo/config.toml`. Git will still pull remote modifications. To push modifications track local modifications using `git update-index --no-skip-worktree nautilus_core/.cargo/config.toml`.

The git hack is needed till [local cargo config](https://github.com/rust-lang/cargo/issues/7723) feature is merged.

## Builds

Following any changes to `.pyx` or `.pxd` files, you can re-compile by running:
Expand Down
23 changes: 20 additions & 3 deletions nightly/_sources/getting_started/installation.md.txt
Original file line number Diff line number Diff line change
Expand Up @@ -46,11 +46,13 @@ as specified in the `pyproject.toml`. However, we highly recommend installing us
1. Install [rustup](https://rustup.rs/) (the Rust toolchain installer):
- Linux and macOS:
```bash
curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
curl https://sh.rustup.rs -sSf | sh
```
- Windows:
- Download and install [`rustup-init.exe`](https://win.rustup.rs/x86_64)
- Install "Desktop development with C++" with [Build Tools for Visual Studio 2019](https://visualstudio.microsoft.com/thank-you-downloading-visual-studio/?sku=BuildTools&rel=16)
- Verify (any system):
from a terminal session run: `rustc --version`

2. Enable `cargo` in the current shell:
- Linux and macOS:
Expand All @@ -60,11 +62,26 @@ as specified in the `pyproject.toml`. However, we highly recommend installing us
- Windows:
- Start a new PowerShell

3. Install poetry (or follow the installation guide on their site):
3. Install [clang](https://clang.llvm.org/) (a C language frontend for LLVM):
- Linux:
```bash
sudo apt-get install clang
```
- Windows:
1. Add Clang to your [Build Tools for Visual Studio 2019](https://visualstudio.microsoft.com/thank-you-downloading-visual-studio/?sku=BuildTools&rel=16):
- Start | Visual Studio Installer | Modify | C++ Clang tools for Windows (12.0.0 - x64…) = checked | Modify
2. Enable `clang` in the current shell:
```powershell
[System.Environment]::SetEnvironmentVariable('path', "C:\Program Files (x86)\Microsoft Visual Studio\2019\BuildTools\VC\Tools\Llvm\x64\bin\;" + $env:Path,"User")
```
- Verify (any system):
from a terminal session run: `clang --version`

4. Install poetry (or follow the installation guide on their site):

curl -sSL https://install.python-poetry.org | python3 -

4. Clone the source with `git`, and install from the projects root directory:
5. Clone the source with `git`, and install from the projects root directory:

git clone https://github.com/nautechsystems/nautilus_trader
cd nautilus_trader
Expand Down
25 changes: 16 additions & 9 deletions nightly/_sources/integrations/ib.md.txt
Original file line number Diff line number Diff line change
Expand Up @@ -31,23 +31,30 @@ Because IB does not provide wheels for `ibapi`, NautilusTrader [repackages]( htt

## Getting Started

Before deploying strategies, ensure that TWS / IB Gateway is running. Launch one of the standalone applications and log in with your credentials, or start the dockerized IB Gateway using `InteractiveBrokersGateway`:
Before implementing your trading strategies, please ensure that either TWS (Trader Workstation) or IB Gateway is currently running. You have the option to log in to one of these standalone applications using your personal credentials or alternatively, via `DockerizedIBGateway`.

```python
from nautilus_trader.adapters.interactive_brokers.gateway import InteractiveBrokersGateway
### Establish Connection to an Existing Gateway or TWS:
Should you choose to connect to a pre-existing Gateway or TWS, it is crucial that you specify the `host` and `port` parameters in both the `InteractiveBrokersDataClientConfig` and `InteractiveBrokersExecClientConfig` to guarantee a successful connection.

### Establish Connection to DockerizedIBGateway:
In this case, it's essential to supply `dockerized_gateway` with an instance of `DockerizedIBGatewayConfig` in both the `InteractiveBrokersDataClientConfig` and `InteractiveBrokersExecClientConfig`. It's important to stress, however, that `host` and `port` parameters aren't necessary in this context.
The following example provides a clear illustration of how to establish a connection to a Dockerized Gateway, which is judiciously managed internally by the Factories.

```python
from nautilus_trader.adapters.interactive_brokers.config import DockerizedIBGatewayConfig
from nautilus_trader.adapters.interactive_brokers.gateway import DockerizedIBGateway

gateway_config = InteractiveBrokersGatewayConfig(
gateway_config = DockerizedIBGatewayConfig(
username="test",
password="test",
trading_mode="paper",
start=True
)

# This may take a short while to start up, especially the first time
gateway = InteractiveBrokersGateway(
gateway = DockerizedIBGateway(
config=gateway_config
)
gateway.start()

# Confirm you are logged in
print(gateway.is_logged_in(gateway.container))
Expand All @@ -56,7 +63,7 @@ print(gateway.is_logged_in(gateway.container))
print(gateway.container.logs())
```

**Note:** To supply credentials to the Interactive Brokers Gateway, either pass the `username` and `password` to the config dictionaries, or set the following environment variables:
**Note:** To supply credentials to the Interactive Brokers Gateway, either pass the `username` and `password` to the `DockerizedIBGatewayConfig`, or set the following environment variables:
- `TWS_USERNAME`
- `TWS_PASSWORD`

Expand Down Expand Up @@ -210,7 +217,7 @@ data_client_config = InteractiveBrokersDataClientConfig(
use_regular_trading_hours=True,
market_data_type=IBMarketDataTypeEnum.DELAYED_FROZEN, # Default is REALTIME if not set
instrument_provider=instrument_provider_config,
gateway=gateway_config,
dockerized_gateway=dockerized_gateway_config,
)
```

Expand All @@ -226,7 +233,7 @@ from nautilus_trader.config import RoutingConfig
exec_client_config = InteractiveBrokersExecClientConfig(
ibg_port=4002,
account_id="DU123456", # Must match the connected IB Gateway/TWS
gateway=gateway_config,
dockerized_gateway=dockerized_gateway_config,
instrument_provider=instrument_provider_config,
routing=RoutingConfig(
default=True,
Expand Down
Loading

0 comments on commit 0b65e72

Please sign in to comment.