diff --git a/docs/_data/sidebars/suite_sidebar.yml b/docs/_data/sidebars/suite_sidebar.yml index e73ce7543..84ed79be1 100644 --- a/docs/_data/sidebars/suite_sidebar.yml +++ b/docs/_data/sidebars/suite_sidebar.yml @@ -113,12 +113,12 @@ entries: output: web folderitems: - - title: Overview - url: /suite-trading-system-overview.html + - title: Defining a Trading System + url: /suite-defining-a-trading-system.html output: web - - title: Strategies - url: /suite-strategies.html + - title: Defining a Strategy + url: /suite-defining-a-trading-strategy.html output: web - title: Trading Sessions diff --git a/docs/_includes/network/backtesting-session.md b/docs/_includes/network/backtesting-session.md new file mode 100644 index 000000000..ff8969751 --- /dev/null +++ b/docs/_includes/network/backtesting-session.md @@ -0,0 +1,99 @@ + + +{% assign title = "Backtesting Session" %} +{% assign definition = site.data.network.backtesting_session %} +{% assign preposition = "a" %} + + + +{% if include.heading != "" %} +{{include.heading}} {{title}} +{% endif %} + +{% if include.icon != "no" %} + +{% if include.table == "y" %} +
+{% endif %} + + + +{% if include.table == "y" %} + +{% endif %} + +{% endif %} + +{% if include.definition != "regular" %} + +{{ definition }} + +{% else %} + +{{ definition }} + +{% endif %} + +{% if include.table == "y" and include.icon != "no" %} +
+{% endif %} + +{% if include.content != "n" %} + + + +A backtesting session node must reference a trading system to gain access to the trading logic to be applied during the session. Other considerations framing the session come from the set of parameters attached to it. + + + +{% endif %} + +{% if include.adding != "" %} + +{{include.adding}} Adding {{preposition}} {{title}} + + + +To add a backtesting session, select *Add Backtesting Session* on the trading process instance node menu. When a session is added, it is created with the full set of parameters. + +{% include note.html content="After adding a session node, make sure you establish a reference to the trading system you want it to work with." %} + + + +{% endif %} + +{% if include.configuring != "" %} + +{{include.configuring}} Configuring the {{title}} + + + +Select *Configure Session* on the menu to access the configuration. + +```json +{ +"folderName": "Session-Name" +} +``` + +* ```folderName``` allows you to set a significant name to the folder in which the data products—and logs—generated by the session are stored. If left blank, the system names the folders with the session id. This may be handy when you intend to consult the raw data generated by the session, as, otherwise, the folder would be hard to identify. + + + +{% endif %} + +{% if include.starting != "" %} + +{{include.starting}} Starting {{preposition}} {{title}} + + + +Before you start a backtesting session, the corresponding task needs to be running, as it is the task that puts the trading bot instance to run. Once the trading bot instance is running, select *Run* on the menu to start the session. + +After a few seconds, a literal indication of the progress of the calculations appears below the session node, displaying the date that is currently being processed. Once the calculation is finished, the session stops and the date below the session node dissapears. + +To stop a backtesting session, select *Stop* on the menu. + + + +{% endif %} \ No newline at end of file diff --git a/docs/_includes/network/forward-testing-session.md b/docs/_includes/network/forward-testing-session.md new file mode 100644 index 000000000..f56d6c28e --- /dev/null +++ b/docs/_includes/network/forward-testing-session.md @@ -0,0 +1,108 @@ + + +{% assign title = "Forward Testing Session" %} +{% assign definition = site.data.network.forward_testing_session %} +{% assign preposition = "a" %} + + + +{% if include.heading != "" %} +{{include.heading}} {{title}} +{% endif %} + +{% if include.icon != "no" %} + +{% if include.table == "y" %} +
+{% endif %} + + + +{% if include.table == "y" %} + +{% endif %} + +{% endif %} + +{% if include.definition != "regular" %} + +{{ definition }} + +{% else %} + +{{ definition }} + +{% endif %} + +{% if include.table == "y" and include.icon != "no" %} +
+{% endif %} + +{% if include.content != "n" %} + + + +A forward testing session node must reference a trading system to gain access to the trading logic to be applied during the session. Other considerations framing the session come from the set of parameters attached to it. + + + +{% endif %} + +{% if include.adding != "" %} + +{{include.adding}} Adding {{preposition}} {{title}} + + + +To add a forward testing session, select *Add Forward Testing Session* on the trading process instance node menu. When a session is added, it is created with the full set of parameters. + +{% include note.html content="After adding a session node, make sure you establish a reference to the trading system you want it to work with." %} + + + +{% endif %} + +{% if include.configuring != "" %} + +{{include.configuring}} Configuring the {{title}} + + + +Select *Configure Session* on the menu to access the configuration. + +```json +{ +"folderName": "Session-Name", +"balancePercentage": 1 +} +``` + +* ```folderName``` allows you to set a significant name to the folder in which the data products—and logs—generated by the session are stored. If left blank, the system names the folders with the session id. This may be handy when you intend to consult the raw data generated by the session, as, otherwise, the folder would be hard to identify. + +* ```balancePercentage``` is a number defining the percentage of the initialBalance specified in the base aset configuration that will be used for trading. For instance, ```"balancePercentage": 1``` means that 1% of your balance will be made available. Just like the ```initialBalance``` is scaled down, the ```minimumBalance``` and ```maximumBalance``` are also scaled down accordingly (see base asset). + +Let's draw a quick example: + +Your base asset is USDT and your initialBalance is USDT 10,000. + +If you set up your forward-testing session with "balancePercentage": "1", then USDT 10,000 * 1% = USDT 100. This is the balance that will be available to your forward-testing session. + +{% include important.html content="You need to take this into account at the time of defining your positionSize formula. If the formula is a constant, you may easily run out of balance, as only a fraction of the balance will be available for the strategy to use. It may be a good idea to set up your positionSize as a function of your available balance instead." %} + + + +{% endif %} + +{% if include.starting != "" %} + +{{include.starting}} Starting {{preposition}} {{title}} + + + +Before you start a forward testing session, the corresponding task needs to be running, as it is the task that puts the trading bot instance to run. Once the trading bot instance is running, select *Run* on the menu to start the session. + +To stop a backtesting session, select *Stop* on the menu. + + + +{% endif %} \ No newline at end of file diff --git a/docs/_includes/network/live-trading-session.md b/docs/_includes/network/live-trading-session.md new file mode 100644 index 000000000..7e2a558de --- /dev/null +++ b/docs/_includes/network/live-trading-session.md @@ -0,0 +1,97 @@ + + +{% assign title = "Live Trading Session" %} +{% assign definition = site.data.network.live_trading_session %} +{% assign preposition = "a" %} + + + +{% if include.heading != "" %} +{{include.heading}} {{title}} +{% endif %} + +{% if include.icon != "no" %} + +{% if include.table == "y" %} +
+{% endif %} + + + +{% if include.table == "y" %} + +{% endif %} + +{% endif %} + +{% if include.definition != "regular" %} + +{{ definition }} + +{% else %} + +{{ definition }} + +{% endif %} + +{% if include.table == "y" and include.icon != "no" %} +
+{% endif %} + +{% if include.content != "n" %} + + + +A live trading session node must reference a trading system to gain access to the trading logic to be applied during the session. Other considerations framing the session come from the set of parameters attached to it. + + + +{% endif %} + +{% if include.adding != "" %} + +{{include.adding}} Adding {{preposition}} {{title}} + + + +To add a live trading session, select *Add Live Trading Session* on the trading process instance node menu. When a session is added, it is created with the full set of parameters. + +{% include note.html content="After adding a session node, make sure you establish a reference to the trading system you want it to work with." %} + + + +{% endif %} + +{% if include.configuring != "" %} + +{{include.configuring}} Configuring the {{title}} + + + +Select *Configure Session* on the menu to access the configuration. + +```json +{ +"folderName": "Session-Name" +} +``` + +* ```folderName``` allows you to set a significant name to the folder in which the data products—and logs—generated by the session are stored. If left blank, the system names the folders with the session id. This may be handy when you intend to consult the raw data generated by the session, as, otherwise, the folder would be hard to identify. + + + +{% endif %} + +{% if include.starting != "" %} + +{{include.starting}} Starting {{preposition}} {{title}} + + + +Before you start a live trading session, the corresponding task needs to be running, as it is the task that puts the trading bot instance to run. Once the trading bot instance is running, select *Run* on the menu to start the session. + +To stop a backtesting session, select *Stop* on the menu. + + + +{% endif %} \ No newline at end of file diff --git a/docs/_includes/network/paper-trading-session.md b/docs/_includes/network/paper-trading-session.md new file mode 100644 index 000000000..14dafd603 --- /dev/null +++ b/docs/_includes/network/paper-trading-session.md @@ -0,0 +1,97 @@ + + +{% assign title = "Paper Trading Session" %} +{% assign definition = site.data.network.paper_trading_session %} +{% assign preposition = "a" %} + + + +{% if include.heading != "" %} +{{include.heading}} {{title}} +{% endif %} + +{% if include.icon != "no" %} + +{% if include.table == "y" %} +
+{% endif %} + + + +{% if include.table == "y" %} + +{% endif %} + +{% endif %} + +{% if include.definition != "regular" %} + +{{ definition }} + +{% else %} + +{{ definition }} + +{% endif %} + +{% if include.table == "y" and include.icon != "no" %} +
+{% endif %} + +{% if include.content != "n" %} + + + +A paper trading session node must reference a trading system to gain access to the trading logic to be applied during the session. Other considerations framing the session come from the set of parameters attached to it. + + + +{% endif %} + +{% if include.adding != "" %} + +{{include.adding}} Adding {{preposition}} {{title}} + + + +To add a paper trading session, select *Add Paper Trading Session* on the trading process instance node menu. When a session is added, it is created with the full set of parameters. + +{% include note.html content="After adding a session node, make sure you establish a reference to the trading system you want it to work with." %} + + + +{% endif %} + +{% if include.configuring != "" %} + +{{include.configuring}} Configuring the {{title}} + + + +Select *Configure Session* on the menu to access the configuration. + +```json +{ +"folderName": "Session-Name" +} +``` + +* ```folderName``` allows you to set a significant name to the folder in which the data products—and logs—generated by the session are stored. If left blank, the system names the folders with the session id. This may be handy when you intend to consult the raw data generated by the session, as, otherwise, the folder would be hard to identify. + + + +{% endif %} + +{% if include.starting != "" %} + +{{include.starting}} Starting {{preposition}} {{title}} + + + +Before you start a paper trading session, the corresponding task needs to be running, as it is the task that puts the trading bot instance to run. Once the trading bot instance is running, select *Run* on the menu to start the session. + +To stop a backtesting session, select *Stop* on the menu. + + + +{% endif %} \ No newline at end of file diff --git a/docs/_includes/network/template-sessions.md b/docs/_includes/network/template-sessions.md new file mode 100644 index 000000000..9720f9550 --- /dev/null +++ b/docs/_includes/network/template-sessions.md @@ -0,0 +1,85 @@ + + +{% assign title = "XXXXXXXXXXXXXXXX" %} +{% assign definition = site.data.network.XXXXXXXXXXXXXXXX %} +{% assign preposition = "XXXXXXXXXXXXXXXX" %} + + + +{% if include.heading != "" %} +{{include.heading}} {{title}} +{% endif %} + +{% if include.icon != "no" %} + +{% if include.table == "y" %} +
+{% endif %} + + + +{% if include.table == "y" %} + +{% endif %} + +{% endif %} + +{% if include.definition != "regular" %} + +{{ definition }} + +{% else %} + +{{ definition }} + +{% endif %} + +{% if include.table == "y" and include.icon != "no" %} +
+{% endif %} + +{% if include.content != "n" %} + + + +XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX + + + +{% endif %} + +{% if include.adding != "" %} + +{{include.adding}} Adding {{preposition}} {{title}} + + + +XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX + + + +{% endif %} + +{% if include.configuring != "" %} + +{{include.configuring}} Configuring the {{title}} + + + +XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX + + + +{% endif %} + +{% if include.starting != "" %} + +{{include.starting}} Starting {{preposition}} {{title}} + + + +XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX + + + +{% endif %} \ No newline at end of file diff --git a/docs/_includes/network/template.md b/docs/_includes/network/template.md new file mode 100644 index 000000000..1fb5fc6ef --- /dev/null +++ b/docs/_includes/network/template.md @@ -0,0 +1,59 @@ + + +{% assign title = "XXXXXXXXXXXXXXXX" %} +{% assign definition = site.data.network.XXXXXXXXXXXXXXXX %} +{% assign preposition = "XXXXXXXXXXXXXXXX" %} + + + +{% if include.heading != "" %} +{{include.heading}} {{title}} +{% endif %} + +{% if include.icon != "no" %} + +{% endif %} + +**{{ definition }}** + + + +XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX + + + +{% if include.adding != "" %} + +{{include.adding}} Adding {{preposition}} {{title}} + + + +XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX + + + +{% endif %} + +{% if include.configuring != "" %} + +{{include.configuring}} Configuring the {{title}} + + + +XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX + + + +{% endif %} + +{% if include.startinging != "" %} + +{{include.starting}} Starting {{preposition}} {{title}} + + + +XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX + + + +{% endif %} \ No newline at end of file diff --git a/docs/_includes/trading_system/base-asset.md b/docs/_includes/trading_system/base-asset.md index e28bcebb9..3a886ca33 100644 --- a/docs/_includes/trading_system/base-asset.md +++ b/docs/_includes/trading_system/base-asset.md @@ -10,11 +10,35 @@ {{include.heading}} {{title}} {% endif %} -{% if include.icon != "no" %} - +{% if include.icon != "no" %} + +{% if include.table == "y" %} +
{% endif %} -**{{ definition }}** + + +{% if include.table == "y" %} + +{% endif %} + +{% endif %} + +{% if include.definition != "regular" %} + +{{ definition }} + +{% else %} + +{{ definition }} + +{% endif %} + +{% if include.table == "y" and include.icon != "no" %} +
+{% endif %} + +{% if include.content != "n" %} @@ -22,6 +46,8 @@ The basse asset must reference an asset in a specific market of a specific excha +{% endif %} + {% if include.adding != "" %} {{include.adding}} Adding {{preposition}} {{title}} @@ -61,4 +87,16 @@ Select *Configure Base Asset* on the menu to access the configuration. +{% endif %} + +{% if include.starting != "" %} + +{{include.starting}} Starting {{preposition}} {{title}} + + + +XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX + + + {% endif %} \ No newline at end of file diff --git a/docs/_includes/trading_system/close-stage.md b/docs/_includes/trading_system/close-stage.md index 90f6050fb..b8568f4ed 100644 --- a/docs/_includes/trading_system/close-stage.md +++ b/docs/_includes/trading_system/close-stage.md @@ -10,11 +10,35 @@ {{include.heading}} {{title}} {% endif %} -{% if include.icon != "no" %} - +{% if include.icon != "no" %} + +{% if include.table == "y" %} +
{% endif %} -**{{ definition }}** + + +{% if include.table == "y" %} + +{% endif %} + +{% endif %} + +{% if include.definition != "regular" %} + +{{ definition }} + +{% else %} + +{{ definition }} + +{% endif %} + +{% if include.table == "y" and include.icon != "no" %} +
+{% endif %} + +{% if include.content != "n" %} @@ -24,6 +48,8 @@ Also pending development is the keeping of a formal trading log. The current fun +{% endif %} + {% if include.adding != "" %} {{include.adding}} Adding {{preposition}} {{title}} @@ -48,4 +74,16 @@ XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX +{% endif %} + +{% if include.starting != "" %} + +{{include.starting}} Starting {{preposition}} {{title}} + + + +XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX + + + {% endif %} \ No newline at end of file diff --git a/docs/_includes/trading_system/condition.md b/docs/_includes/trading_system/condition.md index d6461e7b0..923fbc569 100644 --- a/docs/_includes/trading_system/condition.md +++ b/docs/_includes/trading_system/condition.md @@ -10,11 +10,35 @@ {{include.heading}} {{title}} {% endif %} -{% if include.icon != "no" %} - +{% if include.icon != "no" %} + +{% if include.table == "y" %} +
{% endif %} -**{{ definition }}** + + +{% if include.table == "y" %} + +{% endif %} + +{% endif %} + +{% if include.definition != "regular" %} + +{{ definition }} + +{% else %} + +{{ definition }} + +{% endif %} + +{% if include.table == "y" and include.icon != "no" %} +
+{% endif %} + +{% if include.content != "n" %} @@ -34,6 +58,8 @@ In the example above, conditions A and B are comparison statements that may eval +{% endif %} + {% if include.adding != "" %} {{include.adding}} Adding {{preposition}} {{title}} @@ -56,4 +82,16 @@ XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX +{% endif %} + +{% if include.starting != "" %} + +{{include.starting}} Starting {{preposition}} {{title}} + + + +XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX + + + {% endif %} \ No newline at end of file diff --git a/docs/_includes/trading_system/fee-structure.md b/docs/_includes/trading_system/fee-structure.md index 63723248c..9c7aada7b 100644 --- a/docs/_includes/trading_system/fee-structure.md +++ b/docs/_includes/trading_system/fee-structure.md @@ -10,10 +10,36 @@ {{include.heading}} {{title}} {% endif %} -{% if include.icon != "no" %} - +{% if include.icon != "no" %} + +{% if include.table == "y" %} +
{% endif %} + + +{% if include.table == "y" %} + +{% endif %} + +{% endif %} + +{% if include.definition != "regular" %} + +{{ definition }} + +{% else %} + +{{ definition }} + +{% endif %} + +{% if include.table == "y" and include.icon != "no" %} +
+{% endif %} + +{% if include.content != "n" %} + **{{ definition }}** @@ -32,6 +58,8 @@ In the context of forward testing and live trading sessions, the fee structure a +{% endif %} + {% if include.adding != "" %} {{include.adding}} Adding {{preposition}} {{title}} @@ -71,4 +99,16 @@ Select *Configure Fee Structure* on the menu to access the configuration. +{% endif %} + +{% if include.starting != "" %} + +{{include.starting}} Starting {{preposition}} {{title}} + + + +XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX + + + {% endif %} \ No newline at end of file diff --git a/docs/_includes/trading_system/formula.md b/docs/_includes/trading_system/formula.md index 95b03a131..21cdb034f 100644 --- a/docs/_includes/trading_system/formula.md +++ b/docs/_includes/trading_system/formula.md @@ -10,11 +10,35 @@ {{include.heading}} {{title}} {% endif %} -{% if include.icon != "no" %} - +{% if include.icon != "no" %} + +{% if include.table == "y" %} +
{% endif %} -**{{ definition }}** + + +{% if include.table == "y" %} + +{% endif %} + +{% endif %} + +{% if include.definition != "regular" %} + +{{ definition }} + +{% else %} + +{{ definition }} + +{% endif %} + +{% if include.table == "y" and include.icon != "no" %} +
+{% endif %} + +{% if include.content != "n" %} @@ -30,6 +54,8 @@ Formulas may use [internal variables](suite-internal-variables.html) made availa +{% endif %} + {% if include.adding != "" %} {{include.adding}} Adding {{preposition}} {{title}} @@ -52,4 +78,16 @@ XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX +{% endif %} + +{% if include.starting != "" %} + +{{include.starting}} Starting {{preposition}} {{title}} + + + +XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX + + + {% endif %} \ No newline at end of file diff --git a/docs/_includes/trading_system/initial-stop.md b/docs/_includes/trading_system/initial-stop.md index 6d11aaa16..cd7321679 100644 --- a/docs/_includes/trading_system/initial-stop.md +++ b/docs/_includes/trading_system/initial-stop.md @@ -10,11 +10,35 @@ {{include.heading}} {{title}} {% endif %} -{% if include.icon != "no" %} - +{% if include.icon != "no" %} + +{% if include.table == "y" %} +
{% endif %} -**{{ definition }}** + + +{% if include.table == "y" %} + +{% endif %} + +{% endif %} + +{% if include.definition != "regular" %} + +{{ definition }} + +{% else %} + +{{ definition }} + +{% endif %} + +{% if include.table == "y" and include.icon != "no" %} +
+{% endif %} + +{% if include.content != "n" %} @@ -28,6 +52,8 @@ The initial target is set in phase 0, that is, the departing point for the manag +{% endif %} + {% if include.adding != "" %} {{include.adding}} Adding {{preposition}} {{title}} @@ -50,4 +76,16 @@ XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX +{% endif %} + +{% if include.starting != "" %} + +{{include.starting}} Starting {{preposition}} {{title}} + + + +XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX + + + {% endif %} \ No newline at end of file diff --git a/docs/_includes/trading_system/initial-take-profit.md b/docs/_includes/trading_system/initial-take-profit.md index 58468a5f9..6b4bf0c12 100644 --- a/docs/_includes/trading_system/initial-take-profit.md +++ b/docs/_includes/trading_system/initial-take-profit.md @@ -10,11 +10,35 @@ {{include.heading}} {{title}} {% endif %} -{% if include.icon != "no" %} - +{% if include.icon != "no" %} + +{% if include.table == "y" %} +
{% endif %} -**{{ definition }}** + + +{% if include.table == "y" %} + +{% endif %} + +{% endif %} + +{% if include.definition != "regular" %} + +{{ definition }} + +{% else %} + +{{ definition }} + +{% endif %} + +{% if include.table == "y" and include.icon != "no" %} +
+{% endif %} + +{% if include.content != "n" %} @@ -24,6 +48,8 @@ The initial target is set in phase 0, which may shift to the following phase onc +{% endif %} + {% if include.adding != "" %} {{include.adding}} Adding {{preposition}} {{title}} @@ -46,4 +72,16 @@ XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX +{% endif %} + +{% if include.starting != "" %} + +{{include.starting}} Starting {{preposition}} {{title}} + + + +XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX + + + {% endif %} \ No newline at end of file diff --git a/docs/_includes/trading_system/manage-stage.md b/docs/_includes/trading_system/manage-stage.md index 45d0e829a..5ec813d40 100644 --- a/docs/_includes/trading_system/manage-stage.md +++ b/docs/_includes/trading_system/manage-stage.md @@ -10,11 +10,35 @@ {{include.heading}} {{title}} {% endif %} -{% if include.icon != "no" %} - +{% if include.icon != "no" %} + +{% if include.table == "y" %} +
{% endif %} -**{{ definition }}** + + +{% if include.table == "y" %} + +{% endif %} + +{% endif %} + +{% if include.definition != "regular" %} + +{{ definition }} + +{% else %} + +{{ definition }} + +{% endif %} + +{% if include.table == "y" and include.icon != "no" %} +
+{% endif %} + +{% if include.content != "n" %} @@ -34,6 +58,8 @@ All of these considerations should feed the dynamic analysis performed as the tr +{% endif %} + {% if include.adding != "" %} {{include.adding}} Adding {{preposition}} {{title}} diff --git a/docs/_includes/trading_system/open-stage.md b/docs/_includes/trading_system/open-stage.md index 82178b819..6b69e4981 100644 --- a/docs/_includes/trading_system/open-stage.md +++ b/docs/_includes/trading_system/open-stage.md @@ -10,11 +10,35 @@ {{include.heading}} {{title}} {% endif %} -{% if include.icon != "no" %} - +{% if include.icon != "no" %} + +{% if include.table == "y" %} +
{% endif %} -**{{ definition }}** + + +{% if include.table == "y" %} + +{% endif %} + +{% endif %} + +{% if include.definition != "regular" %} + +{{ definition }} + +{% else %} + +{{ definition }} + +{% endif %} + +{% if include.table == "y" and include.icon != "no" %} +
+{% endif %} + +{% if include.content != "n" %} @@ -26,6 +50,8 @@ Ideally, the open stage would also handle the parameters that define the executi +{% endif %} + {% if include.adding != "" %} {{include.adding}} Adding {{preposition}} {{title}} diff --git a/docs/_includes/trading_system/parameters.md b/docs/_includes/trading_system/parameters.md index 62a56dfbb..75eb3e9a8 100644 --- a/docs/_includes/trading_system/parameters.md +++ b/docs/_includes/trading_system/parameters.md @@ -10,11 +10,35 @@ {{include.heading}} {{title}} {% endif %} -{% if include.icon != "no" %} - +{% if include.icon != "no" %} + +{% if include.table == "y" %} +
{% endif %} -**{{ definition }}** + + +{% if include.table == "y" %} + +{% endif %} + +{% endif %} + +{% if include.definition != "regular" %} + +{{ definition }} + +{% else %} + +{{ definition }} + +{% endif %} + +{% if include.table == "y" and include.icon != "no" %} +
+{% endif %} + +{% if include.content != "n" %} @@ -22,6 +46,8 @@ Each testing session has its own set of parameters. This allows you to configure +{% endif %} + {% if include.adding != "" %} {{include.adding}} Adding {{preposition}} {{title}} diff --git a/docs/_includes/trading_system/position-rate.md b/docs/_includes/trading_system/position-rate.md index afe701a6d..06c89ba07 100644 --- a/docs/_includes/trading_system/position-rate.md +++ b/docs/_includes/trading_system/position-rate.md @@ -10,11 +10,35 @@ {{include.heading}} {{title}} {% endif %} -{% if include.icon != "no" %} - +{% if include.icon != "no" %} + +{% if include.table == "y" %} +
{% endif %} -**{{ definition }}** + + +{% if include.table == "y" %} + +{% endif %} + +{% endif %} + +{% if include.definition != "regular" %} + +{{ definition }} + +{% else %} + +{{ definition }} + +{% endif %} + +{% if include.table == "y" and include.icon != "no" %} +
+{% endif %} + +{% if include.content != "n" %} @@ -22,6 +46,8 @@ However, for the time being, the formula is overridden by the system as executio +{% endif %} + {% if include.adding != "" %} {{include.adding}} Adding {{preposition}} {{title}} diff --git a/docs/_includes/trading_system/position-size.md b/docs/_includes/trading_system/position-size.md index 8abd8918c..f466f3aa1 100644 --- a/docs/_includes/trading_system/position-size.md +++ b/docs/_includes/trading_system/position-size.md @@ -10,11 +10,35 @@ {{include.heading}} {{title}} {% endif %} -{% if include.icon != "no" %} - +{% if include.icon != "no" %} + +{% if include.table == "y" %} +
{% endif %} -**{{ definition }}** + + +{% if include.table == "y" %} + +{% endif %} + +{% endif %} + +{% if include.definition != "regular" %} + +{{ definition }} + +{% else %} + +{{ definition }} + +{% endif %} + +{% if include.table == "y" and include.icon != "no" %} +
+{% endif %} + +{% if include.content != "n" %} @@ -22,6 +46,8 @@ +{% endif %} + {% if include.adding != "" %} {{include.adding}} Adding {{preposition}} {{title}} diff --git a/docs/_includes/trading_system/quoted-asset.md b/docs/_includes/trading_system/quoted-asset.md index 342867403..4657da30a 100644 --- a/docs/_includes/trading_system/quoted-asset.md +++ b/docs/_includes/trading_system/quoted-asset.md @@ -10,11 +10,35 @@ {{include.heading}} {{title}} {% endif %} -{% if include.icon != "no" %} - +{% if include.icon != "no" %} + +{% if include.table == "y" %} +
{% endif %} -**{{ definition }}** + + +{% if include.table == "y" %} + +{% endif %} + +{% endif %} + +{% if include.definition != "regular" %} + +{{ definition }} + +{% else %} + +{{ definition }} + +{% endif %} + +{% if include.table == "y" and include.icon != "no" %} +
+{% endif %} + +{% if include.content != "n" %} @@ -22,6 +46,8 @@ The quoted asset must reference the second asset in the same market of the same +{% endif %} + {% if include.adding != "" %} {{include.adding}} Adding {{preposition}} {{title}} diff --git a/docs/_includes/trading_system/situation.md b/docs/_includes/trading_system/situation.md index 1fb75a57f..8af1dbedc 100644 --- a/docs/_includes/trading_system/situation.md +++ b/docs/_includes/trading_system/situation.md @@ -10,11 +10,35 @@ {{include.heading}} {{title}} {% endif %} -{% if include.icon != "no" %} - +{% if include.icon != "no" %} + +{% if include.table == "y" %} +
{% endif %} -**{{ definition }}** + + +{% if include.table == "y" %} + +{% endif %} + +{% endif %} + +{% if include.definition != "regular" %} + +{{ definition }} + +{% else %} + +{{ definition }} + +{% endif %} + +{% if include.table == "y" and include.icon != "no" %} +
+{% endif %} + +{% if include.content != "n" %} @@ -26,6 +50,8 @@ An event may have more than one situation attached to it. In such a case, when a +{% endif %} + {% if include.adding != "" %} {{include.adding}} Adding {{preposition}} {{title}} diff --git a/docs/_includes/trading_system/slippage.md b/docs/_includes/trading_system/slippage.md index fcc674beb..465e51abb 100644 --- a/docs/_includes/trading_system/slippage.md +++ b/docs/_includes/trading_system/slippage.md @@ -10,11 +10,35 @@ {{include.heading}} {{title}} {% endif %} -{% if include.icon != "no" %} - +{% if include.icon != "no" %} + +{% if include.table == "y" %} +
{% endif %} -**{{ definition }}** + + +{% if include.table == "y" %} + +{% endif %} + +{% endif %} + +{% if include.definition != "regular" %} + +{{ definition }} + +{% else %} + +{{ definition }} + +{% endif %} + +{% if include.table == "y" and include.icon != "no" %} +
+{% endif %} + +{% if include.content != "n" %} @@ -24,6 +48,8 @@ Slippage is factored both in the session reports and in the graphic representati +{% endif %} + {% if include.adding != "" %} {{include.adding}} Adding {{preposition}} {{title}} diff --git a/docs/_includes/trading_system/strategy.md b/docs/_includes/trading_system/strategy.md index c9ab71846..3ed7dbf7c 100644 --- a/docs/_includes/trading_system/strategy.md +++ b/docs/_includes/trading_system/strategy.md @@ -10,17 +10,41 @@ {{include.heading}} {{title}} {% endif %} -{% if include.icon != "no" %} - +{% if include.icon != "no" %} + +{% if include.table == "y" %} +
{% endif %} -**{{ definition }}** + + +{% if include.table == "y" %} + +{% endif %} + +{% endif %} + +{% if include.definition != "regular" %} + +{{ definition }} + +{% else %} + +{{ definition }} + +{% endif %} + +{% if include.table == "y" and include.icon != "no" %} +
+{% endif %} + +{% if include.content != "n" %} -The definition of a strategy may be analyzed in three sections. +The definition of a strategy may be analyzed in three sections: -**"A strategy is a set of actions occurring in stages"** +{% include callout.html type="primary" content="A strategy is a set of actions occurring in stages" %} Strategies are defined in the following steps: @@ -31,16 +55,18 @@ Strategies are defined in the following steps: These stages are played in a sequence: once a strategy is *triggered* it looks to *open* a position; once a position is open, it is time to *manage* it as the trade develops; and once a stop or take profit target is hit, it is time to *close* the position. -**"designed to achieve a specific goal within a broader plan"** +{% include callout.html type="primary" content="designed to achieve a specific goal within a broader plan" %} Your investment plan or trading carrer may have any number of goals (*e.g.: accumulating bitcoin, diversifying on a basket of coins, annual profit targets, etc.*). If you attempt to achieve two different goals with a single strategy, you may run into problems. It may be doable, but the strategy would certainly be more complex. In any case, the logical thing to do is to analyze each goal separately so that you can design at least one clear, straightforward strategy for each goal. -**"via executing trades"** +{% include callout.html type="primary" content="via executing trades" %} The definition of strategy points to the concept of *a trade*. A trade is a process that exchanges the base asset for the quoted asset and that—after some time, as the trade develops and targets are hit—exchanges back the quoted asset for the base asset. The first and foremost rule of a trade is to preserve capital and its main goal is to increase it. +{% endif %} + {% if include.adding != "" %} {{include.adding}} Adding {{preposition}} {{title}} diff --git a/docs/_includes/trading_system/take-position-event.md b/docs/_includes/trading_system/take-position-event.md index 117cf3f6e..f070d2dd1 100644 --- a/docs/_includes/trading_system/take-position-event.md +++ b/docs/_includes/trading_system/take-position-event.md @@ -10,11 +10,35 @@ {{include.heading}} {{title}} {% endif %} -{% if include.icon != "no" %} - +{% if include.icon != "no" %} + +{% if include.table == "y" %} +
{% endif %} -**{{ definition }}** + + +{% if include.table == "y" %} + +{% endif %} + +{% endif %} + +{% if include.definition != "regular" %} + +{{ definition }} + +{% else %} + +{{ definition }} + +{% endif %} + +{% if include.table == "y" and include.icon != "no" %} +
+{% endif %} + +{% if include.content != "n" %} @@ -26,6 +50,8 @@ Once the take position event is triggered, the decision to take a position has b +{% endif %} + {% if include.adding != "" %} {{include.adding}} Adding {{preposition}} {{title}} diff --git a/docs/_includes/trading_system/template-sessions.md b/docs/_includes/trading_system/template-sessions.md new file mode 100644 index 000000000..9d0327426 --- /dev/null +++ b/docs/_includes/trading_system/template-sessions.md @@ -0,0 +1,85 @@ + + +{% assign title = "XXXXXXXXXXXXXXXX" %} +{% assign definition = site.data.network.XXXXXXXXXXXXXXXX %} +{% assign preposition = "XXXXXXXXXXXXXXXX" %} + + + +{% if include.heading != "" %} +{{include.heading}} {{title}} +{% endif %} + +{% if include.icon != "no" %} + +{% if include.table == "y" %} +
+{% endif %} + + + +{% if include.table == "y" %} + +{% endif %} + +{% endif %} + +{% if include.definition != "regular" %} + +{{ definition }} + +{% else %} + +{{ definition }} + +{% endif %} + +{% if include.table == "y" and include.icon != "no" %} +
+{% endif %} + +{% if include.content != "n" %} + + + +XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX + + + +{% endif %} + +{% if include.adding != "" %} + +{{include.adding}} Adding {{preposition}} {{title}} + + + +XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX + + + +{% endif %} + +{% if include.configuring != "" %} + +{{include.configuring}} Configuring the {{title}} + + + +XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX + + + +{% endif %} + +{% if include.starting != "" %} + +{{include.starting}} Starting {{preposition}} {{title}} + + + +XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX + + + +{% endif %} \ No newline at end of file diff --git a/docs/_includes/trading_system/time-frame.md b/docs/_includes/trading_system/time-frame.md index a88f51457..eb19e84a9 100644 --- a/docs/_includes/trading_system/time-frame.md +++ b/docs/_includes/trading_system/time-frame.md @@ -10,11 +10,35 @@ {{include.heading}} {{title}} {% endif %} -{% if include.icon != "no" %} - +{% if include.icon != "no" %} + +{% if include.table == "y" %} +
{% endif %} -**{{ definition }}** + + +{% if include.table == "y" %} + +{% endif %} + +{% endif %} + +{% if include.definition != "regular" %} + +{{ definition }} + +{% else %} + +{{ definition }} + +{% endif %} + +{% if include.table == "y" and include.icon != "no" %} +
+{% endif %} + +{% if include.content != "n" %} @@ -24,6 +48,8 @@ In the context of live sessions, that is, paper trading, forward testing and liv +{% endif %} + {% if include.adding != "" %} {{include.adding}} Adding {{preposition}} {{title}} diff --git a/docs/_includes/trading_system/time-range.md b/docs/_includes/trading_system/time-range.md index f5b4f3f6c..83efd935a 100644 --- a/docs/_includes/trading_system/time-range.md +++ b/docs/_includes/trading_system/time-range.md @@ -10,11 +10,35 @@ {{include.heading}} {{title}} {% endif %} -{% if include.icon != "no" %} - +{% if include.icon != "no" %} + +{% if include.table == "y" %} +
{% endif %} -**{{ definition }}** + + +{% if include.table == "y" %} + +{% endif %} + +{% endif %} + +{% if include.definition != "regular" %} + +{{ definition }} + +{% else %} + +{{ definition }} + +{% endif %} + +{% if include.table == "y" and include.icon != "no" %} +
+{% endif %} + +{% if include.content != "n" %} @@ -22,6 +46,8 @@ +{% endif %} + {% if include.adding != "" %} {{include.adding}} Adding {{preposition}} {{title}} diff --git a/docs/_includes/trading_system/trading-system.md b/docs/_includes/trading_system/trading-system.md index ad7f4a5fe..4300a23cf 100644 --- a/docs/_includes/trading_system/trading-system.md +++ b/docs/_includes/trading_system/trading-system.md @@ -10,11 +10,35 @@ {{include.heading}} {{title}} {% endif %} -{% if include.icon != "no" %} - +{% if include.icon != "no" %} + +{% if include.table == "y" %} +
{% endif %} -**{{ definition }}** + + +{% if include.table == "y" %} + +{% endif %} + +{% endif %} + +{% if include.definition != "regular" %} + +{{ definition }} + +{% else %} + +{{ definition }} + +{% endif %} + +{% if include.table == "y" and include.icon != "no" %} +
+{% endif %} + +{% if include.content != "n" %} @@ -26,6 +50,8 @@ The concept of describing strategies in phases is fundamental to the methodical +{% endif %} + {% if include.adding != "" %} {{include.adding}} Adding {{preposition}} {{title}} diff --git a/docs/_includes/trading_system/trigger-off-event.md b/docs/_includes/trading_system/trigger-off-event.md index ad7f60388..8bbc29f5d 100644 --- a/docs/_includes/trading_system/trigger-off-event.md +++ b/docs/_includes/trading_system/trigger-off-event.md @@ -10,11 +10,35 @@ {{include.heading}} {{title}} {% endif %} -{% if include.icon != "no" %} - +{% if include.icon != "no" %} + +{% if include.table == "y" %} +
{% endif %} -**{{ definition }}** + + +{% if include.table == "y" %} + +{% endif %} + +{% endif %} + +{% if include.definition != "regular" %} + +{{ definition }} + +{% else %} + +{{ definition }} + +{% endif %} + +{% if include.table == "y" and include.icon != "no" %} +
+{% endif %} + +{% if include.content != "n" %} @@ -26,6 +50,8 @@ In the first scenario, the strategy remains *on* until the trade is closed. As t +{% endif %} + {% if include.adding != "" %} {{include.adding}} Adding {{preposition}} {{title}} diff --git a/docs/_includes/trading_system/trigger-on-event.md b/docs/_includes/trading_system/trigger-on-event.md index ac2c3904f..afad87b91 100644 --- a/docs/_includes/trading_system/trigger-on-event.md +++ b/docs/_includes/trading_system/trigger-on-event.md @@ -10,20 +10,46 @@ {{include.heading}} {{title}} {% endif %} -{% if include.icon != "no" %} - +{% if include.icon != "no" %} + +{% if include.table == "y" %} +
{% endif %} -**{{ definition }}** + + +{% if include.table == "y" %} + +{% endif %} + +{% endif %} + +{% if include.definition != "regular" %} + +{{ definition }} + +{% else %} + +{{ definition }} + +{% endif %} + +{% if include.table == "y" and include.icon != "no" %} +
+{% endif %} + +{% if include.content != "n" %} In conceptual terms, the trigger-on event is the mechanism you use to define the specific situations in which you would consider trading with the corresponding strategy. Think of the trigger-on event as the definition of the scenario in which the trading idea behind the strategy should be carefully considered. -Once a strategy is triggered-on, the system starts evaluating the take position event. In conceptual terms, it means that the system has been alerted that the trading idea behind the corresponding trading strategy has produced a signal and that it should carefully monitor the market for the opportunity of taking a position. +Once a strategy is triggered-on, the system starts evaluating the take position event. In conceptual terms, it means that the system has been alerted that the trading idea behind the corresponding trading strategy has produced a signal and that it should carefully monitor the market for the opportunity to take a position. +{% endif %} + {% if include.adding != "" %} {{include.adding}} Adding {{preposition}} {{title}} diff --git a/docs/_includes/trading_system/trigger-stage.md b/docs/_includes/trading_system/trigger-stage.md index 6e96e58cc..c705ea442 100644 --- a/docs/_includes/trading_system/trigger-stage.md +++ b/docs/_includes/trading_system/trigger-stage.md @@ -10,11 +10,35 @@ {{include.heading}} {{title}} {% endif %} -{% if include.icon != "no" %} - +{% if include.icon != "no" %} + +{% if include.table == "y" %} +
{% endif %} -**{{ definition }}** + + +{% if include.table == "y" %} + +{% endif %} + +{% endif %} + +{% if include.definition != "regular" %} + +{{ definition }} + +{% else %} + +{{ definition }} + +{% endif %} + +{% if include.table == "y" and include.icon != "no" %} +
+{% endif %} + +{% if include.content != "n" %} @@ -30,6 +54,8 @@ As a corollary, if certain strategies are meant to trade under the same market s +{% endif %} + {% if include.adding != "" %} {{include.adding}} Adding {{preposition}} {{title}} diff --git a/docs/css/customstyles.css b/docs/css/customstyles.css index b2486e048..ec21cf4ec 100644 --- a/docs/css/customstyles.css +++ b/docs/css/customstyles.css @@ -1,9 +1,9 @@ body { - font: 400 16px/1.5 -apple-system, BlinkMacSystemFont, "Segoe UI", Roboto, Helvetica, Arial, sans-serif, "Apple Color Emoji", "Segoe UI Emoji", "Segoe UI Symbol"; + font: 400 17px/1.5 -apple-system, BlinkMacSystemFont, "Segoe UI", Roboto, Helvetica, Arial, sans-serif, "Apple Color Emoji", "Segoe UI Emoji", "Segoe UI Symbol"; color: #111; background-color: #fdfdfd; - text-align: justify; + /* text-align: justify; */ -webkit-text-size-adjust: 100%; -webkit-font-feature-settings: "kern" 1; -moz-font-feature-settings: "kern" 1; @@ -46,7 +46,7 @@ p { color: #777; } .bs-callout-primary { - border-left-color: #428bca; + border-left-color: #ff8c29; } .bs-callout-primary h4 { color: #428bca; @@ -497,6 +497,18 @@ figcaption { color: red; } +table.definitionTable { + min-width: 100%; +} + +table.definitionTable tbody tr td { + background-color: transparent; + padding: 15px; + margin: 0px; + border: 0px; + vertical-align: middle; +} + table.hierarchyTable { min-width: 100%; } diff --git a/docs/pages/suite/suite-defining-a-trading-strategy.md b/docs/pages/suite/suite-defining-a-trading-strategy.md new file mode 100644 index 000000000..e0badcafd --- /dev/null +++ b/docs/pages/suite/suite-defining-a-trading-strategy.md @@ -0,0 +1,30 @@ +--- +title: Defining a Trading Strategy +summary: "Strategies are defined as a sequence of stages." +sidebar: suite_sidebar +permalink: suite-defining-a-trading-strategy.html +--- + +{% include /trading_system/strategy.md heading="" icon="150-" adding="" configuring="" starting="" content="" definition="" table="y" %} + +{% include /trading_system/trigger-stage.md heading="##" icon="150-" adding="" configuring="" starting="" content="" definition="" table="y" %} + +{% include /trading_system/trigger-on-event.md heading="###" icon="" adding="" configuring="" starting="" content="" definition="regular" table="y" %} + +{% include /trading_system/trigger-off-event.md heading="###" icon="" adding="" configuring="" starting="" content="" definition="regular" table="y" %} + +{% include /trading_system/take-position-event.md heading="###" icon="" adding="" configuring="" starting="" content="" definition="regular" table="y" %} + +{% include /trading_system/open-stage.md heading="##" icon="150-" adding="" configuring="" starting="" content="" definition="" table="y" %} + +{% include /trading_system/initial-stop.md heading="###" icon="" adding="" configuring="" starting="" content="" definition="regular" table="y" %} + +{% include /trading_system/initial-take-profit.md heading="###" icon="" adding="" configuring="" starting="" content="" definition="regular" table="y" %} + +{% include /trading_system/position-size.md heading="###" icon="" adding="" configuring="" starting="" content="" definition="regular" table="y" %} + +{% include /trading_system/position-rate.md heading="###" icon="" adding="" configuring="" starting="" content="" definition="regular" table="y" %} + +{% include /trading_system/manage-stage.md heading="##" icon="150-" adding="" configuring="" starting="" content="" definition="" table="y" %} + +{% include /trading_system/close-stage.md heading="##" icon="150-" adding="" configuring="" starting="" content="" definition="" table="y" %} \ No newline at end of file diff --git a/docs/pages/suite/suite-trading-system-overview.md b/docs/pages/suite/suite-defining-a-trading-system.md similarity index 70% rename from docs/pages/suite/suite-trading-system-overview.md rename to docs/pages/suite/suite-defining-a-trading-system.md index 8ac81021a..5609c7bf5 100644 --- a/docs/pages/suite/suite-trading-system-overview.md +++ b/docs/pages/suite/suite-defining-a-trading-system.md @@ -1,10 +1,10 @@ --- -title: Trading System +title: Defining a Trading System summary: "A trading system is a device that allows building strategies in a standardized manner." sidebar: suite_sidebar -permalink: suite-trading-system-overview.html +permalink: suite-defining-a-trading-system.html --- -{% include /trading_system/trading-system.md heading="" icon="150-" adding="" configuring="" %} +{% include /trading_system/trading-system.md heading="" icon="150-" adding="" configuring="" starting="" content="" definition="" table="y" %} {% include note.html content="Check the Hierarchies Directory for a thorough description of the whole trading system hierarchy." %} \ No newline at end of file diff --git a/docs/pages/suite/suite-network-hierarchy.md b/docs/pages/suite/suite-network-hierarchy.md index 4dbdb31f2..105a20092 100644 --- a/docs/pages/suite/suite-network-hierarchy.md +++ b/docs/pages/suite/suite-network-hierarchy.md @@ -311,160 +311,13 @@ You do not start or stop a trading process instance directly. Instead, you start -## Backtesting Session +{% include /network/backtesting-session.md heading="##" icon="150-" adding="###" configuring="###" starting="###" definition="" table="y" %} - +{% include /network/paper-trading-session.md heading="##" icon="150-" adding="###" configuring="###" starting="###" definition="" table="y" %} -**{{site.data.network.backtesting_session}}** +{% include /network/forward-testing-session.md heading="##" icon="150-" adding="###" configuring="###" starting="###" definition="" table="y" %} -A backtesting session node must reference a trading system to gain access to the trading logic to be applied during the session. Other considerations framing the session come from the set of parameters attached to it. - -### Adding a Backtesting Session - -To add a backtesting session, select *Add Backtesting Session* on the trading process instance node menu. When a session is added, it is created with the full set of parameters. - -{% include note.html content="After adding a session node, make sure you establish a reference to the trading system you want it to work with." %} - -### Configuring a Backtesting Session - -Select *Configure Session* on the menu to access the configuration. - -```json -{ -"folderName": "Session-Name" -} -``` - -* ```folderName``` allows you to set a significant name to the folder in which the data products—and logs—generated by the session are stored. If left blank, the system names the folders with the session id. This may be handy when you intend to consult the raw data generated by the session, as, otherwise, the folder would be hard to identify. - -### Starting / Stopping a Backtesting Session - -Before you start a backtesting session, the corresponding task needs to be running, as it is the task that puts the trading bot instance to run. Once the trading bot instance is running, select *Run* on the menu to start the session. - -After a few seconds, a literal indication of the progress of the calculations appears below the session node, displaying the date that is currently being processed. Once the calculation is finished, the session stops and the date below the session node dissapears. - -[IMAGE] - -To stop a backtesting session, select *Stop* on the menu. - - - - - -## Paper Trading Session - - - -**{{site.data.network.paper_trading_session}}** - -A paper trading session node must reference a trading system to gain access to the trading logic to be applied during the session. Other considerations framing the session come from the set of parameters attached to it. - -### Adding a Paper Trading Session - -To add a paper trading session, select *Add Paper Trading Session* on the trading process instance node menu. When a session is added, it is created with the full set of parameters. - -{% include note.html content="After adding a session node, make sure you establish a reference to the trading system you want it to work with." %} - -### Configuring a Paper Trading Session - -Select *Configure Session* on the menu to access the configuration. - -```json -{ -"folderName": "Session-Name" -} -``` - -* ```folderName``` allows you to set a significant name to the folder in which the data products—and logs—generated by the session are stored. If left blank, the system names the folders with the session id. This may be handy when you intend to consult the raw data generated by the session, as, otherwise, the folder would be hard to identify. - -### Starting / Stopping a Paper Trading Session - -Before you start a paper trading session, the corresponding task needs to be running, as it is the task that puts the trading bot instance to run. Once the trading bot instance is running, select *Run* on the menu to start the session. - -To stop a backtesting session, select *Stop* on the menu. - - - - - -## Forward Testing Session - - - -**{{site.data.network.forward_testing_session}}** - -A forward testing session node must reference a trading system to gain access to the trading logic to be applied during the session. Other considerations framing the session come from the set of parameters attached to it. - -### Adding a Forward Testing Session - -To add a forward testing session, select *Add Forward Testing Session* on the trading process instance node menu. When a session is added, it is created with the full set of parameters. - -{% include note.html content="After adding a session node, make sure you establish a reference to the trading system you want it to work with." %} - -### Configuring a Forward Testing Session - -Select *Configure Session* on the menu to access the configuration. - -```json -{ -"folderName": "Session-Name", -"balancePercentage": 1 -} -``` - -* ```folderName``` allows you to set a significant name to the folder in which the data products—and logs—generated by the session are stored. If left blank, the system names the folders with the session id. This may be handy when you intend to consult the raw data generated by the session, as, otherwise, the folder would be hard to identify. - -* ```balancePercentage``` is a number defining the percentage of the initialBalance specified in the base aset configuration that will be used for trading. For instance, ```"balancePercentage": 1``` means that 1% of your balance will be made available. Just like the ```initialBalance``` is scaled down, the ```minimumBalance``` and ```maximumBalance``` are also scaled down accordingly (see base asset). - -Let's draw a quick example: - -Your base asset is USDT and your initialBalance is USDT 10,000. - -If you set up your forward-testing session with "balancePercentage": "1", then USDT 10,000 * 1% = USDT 100. This is the balance that will be available to your forward-testing session. - -{% include important.html content="You need to take this into account at the time of defining your positionSize formula. If the formula is a constant, you may easily run out of balance, as only a fraction of the balance will be available for the strategy to use. It may be a good idea to set up your positionSize as a function of your available balance instead." %} - -### Starting / Stopping a Forward Testing Session - -Before you start a forward testing session, the corresponding task needs to be running, as it is the task that puts the trading bot instance to run. Once the trading bot instance is running, select *Run* on the menu to start the session. - -To stop a backtesting session, select *Stop* on the menu. - - - - - -## Live Trading Session - - - -**{{site.data.network.live_trading_session}}** - -A live trading session node must reference a trading system to gain access to the trading logic to be applied during the session. Other considerations framing the session come from the set of parameters attached to it. - -### Adding a Live Trading Session - -To add a live trading session, select *Add Live Trading Session* on the trading process instance node menu. When a session is added, it is created with the full set of parameters. - -{% include note.html content="After adding a session node, make sure you establish a reference to the trading system you want it to work with." %} - -### Configuring a Live Trading Session - -Select *Configure Session* on the menu to access the configuration. - -```json -{ -"folderName": "Session-Name" -} -``` - -* ```folderName``` allows you to set a significant name to the folder in which the data products—and logs—generated by the session are stored. If left blank, the system names the folders with the session id. This may be handy when you intend to consult the raw data generated by the session, as, otherwise, the folder would be hard to identify. - -### Starting / Stopping a Live Trading Session - -Before you start a live trading session, the corresponding task needs to be running, as it is the task that puts the trading bot instance to run. Once the trading bot instance is running, select *Run* on the menu to start the session. - -To stop a backtesting session, select *Stop* on the menu. +{% include /network/live-trading-session.md heading="##" icon="150-" adding="###" configuring="###" starting="###" definition="" table="y" %} diff --git a/docs/pages/suite/suite-strategies.md b/docs/pages/suite/suite-strategies.md deleted file mode 100644 index 354c1e5eb..000000000 --- a/docs/pages/suite/suite-strategies.md +++ /dev/null @@ -1,30 +0,0 @@ ---- -title: Strategies -summary: "Strategies are defined as a sequence of stages." -sidebar: suite_sidebar -permalink: suite-strategies.html ---- - -{% include /trading_system/strategy.md heading="" icon="150-" adding="" configuring="" %} - -{% include /trading_system/trigger-stage.md heading="##" icon="150-" adding="" configuring="" %} - -{% include /trading_system/trigger-on-event.md heading="###" icon="no" adding="" configuring="" %} - -{% include /trading_system/trigger-off-event.md heading="###" icon="no" adding="" configuring="" %} - -{% include /trading_system/take-position-event.md heading="###" icon="no" adding="" configuring="" %} - -{% include /trading_system/open-stage.md heading="##" icon="150-" adding="" configuring="" %} - -{% include /trading_system/initial-stop.md heading="###" icon="no" adding="" configuring="" %} - -{% include /trading_system/initial-take-profit.md heading="###" icon="no" adding="" configuring="" %} - -{% include /trading_system/position-size.md heading="###" icon="no" adding="" configuring="" %} - -{% include /trading_system/position-rate.md heading="###" icon="no" adding="" configuring="" %} - -{% include /trading_system/manage-stage.md heading="##" icon="150-" adding="" configuring="" %} - -{% include /trading_system/close-stage.md heading="##" icon="150-" adding="" configuring="" %} \ No newline at end of file diff --git a/docs/pages/suite/suite-trading-sessions.md b/docs/pages/suite/suite-trading-sessions.md index cd092bcfa..11d08bd34 100644 --- a/docs/pages/suite/suite-trading-sessions.md +++ b/docs/pages/suite/suite-trading-sessions.md @@ -5,3 +5,10 @@ sidebar: suite_sidebar permalink: suite-trading-sessions.html --- +{% include /network/backtesting-session.md heading="##" icon="150-" adding="" configuring="" starting="" content="n" definition="regular" table="y" %} + +{% include /network/paper-trading-session.md heading="##" icon="150-" adding="" configuring="" starting="" content="n" definition="regular" table="y" %} + +{% include /network/forward-testing-session.md heading="##" icon="150-" adding="" configuring="" starting="" content="n" definition="regular" table="y" %} + +{% include /network/live-trading-session.md heading="##" icon="150-" adding="" configuring="" starting="" content="n" definition="regular" table="y" %} \ No newline at end of file