New documentation
First commit, halfway through a major restructuring of documentation.
This commit is contained in:
Julian Molina committed
1 parent
f2ff0ce58b
commit
c2fb254a04
456 files changed
+44176
-253
No files matched your search
@@ -0,0 +1,15 @@
|
||||
tip: '<div class="alert alert-success" role="alert"><i class="fa fa-check-square-o"></i> <b>Tip: </b>'
|
||||
note: '<div class="alert alert-info" role="alert"><i class="fa fa-info-circle"></i> <b>Note: </b>'
|
||||
important: '<div class="alert alert-warning" role="alert"><i class="fa fa-warning"></i> <b>Important: </b>'
|
||||
warning: '<div class="alert alert-danger" role="alert"><i class="fa fa-exclamation-circle"></i> <b>Warning: </b>'
|
||||
end: '</div>'
|
||||
|
||||
callout_danger: '<div class="bs-callout bs-callout-danger">'
|
||||
callout_default: '<div class="bs-callout bs-callout-default">'
|
||||
callout_primary: '<div class="bs-callout bs-callout-primary">'
|
||||
callout_success: '<div class="bs-callout bs-callout-success">'
|
||||
callout_info: '<div class="bs-callout bs-callout-info">'
|
||||
callout_warning: '<div class="bs-callout bs-callout-warning">'
|
||||
|
||||
hr_faded: '<hr class="faded"/>'
|
||||
hr_shaded: '<hr class="shaded"/>'
|
||||
@@ -0,0 +1,17 @@
|
||||
charting_system: "The Charting System is the hierarchy that governs the configuration of the charts."
|
||||
|
||||
viewport: "A viewport represents the bidimensional space on which the charts are drawn."
|
||||
|
||||
time_machine: "A time machine syncronizes multiple timeline charts over the same timeline. Timeline charts within a time machine may have different rate scales or time frame scales, but their time scale will always match."
|
||||
|
||||
time_scale: "The time scale controls the scale of the horizontal axis, that is, the timeline of the corresponding time machine, and of all of the timeline charts within it."
|
||||
|
||||
rate_scale: "The rate scale controls the scale of the vertical axis, that is, the scale of the quoted asset, either of the time machine, or of the timeline chart, depending on where the node is located."
|
||||
|
||||
time_frame_scale: "The time frame scale controls the time frame setting, that is, the period of time represented by each candle, either of the time machine, or of the timeline chart, depending on where the node is located."
|
||||
|
||||
timeline_chart: "The timeline chart represents a chart within a time machine, which may have independent rate and time frame scales, as well as particular layers."
|
||||
|
||||
layers_manager: "The layer manager determines which layers will be visible on the corresponding timeline chart."
|
||||
|
||||
layer: "A layer represents a reference to a data product in the data storage node of the Network hierarchy. Conceptually, it means that a certain data product, which exists in a certain location on the network, holds the data to be rendered on the charts."
|
||||
@@ -0,0 +1,17 @@
|
||||
charting_system: "The Charting System is the hierarchy that governs the configuration of the charts."
|
||||
|
||||
viewport: "A viewport represents the bidimensional space on which the charts are drawn."
|
||||
|
||||
time_machine: "A time machine syncronizes multiple timeline charts over the same timeline. Timeline charts within a time machine may have different rate scales or time frame scales, but their time scale will always match."
|
||||
|
||||
time_scale: "The time scale controls the scale of the horizontal axis, that is, the timeline of the corresponding time machine, and of all of the timeline charts within it."
|
||||
|
||||
rate_scale: "The rate scale controls the scale of the vertical axis, that is, the scale of the quoted asset, either of the time machine, or of the timeline chart, depending on where the node is located."
|
||||
|
||||
time_frame_scale: "The time frame scale controls the time frame setting, that is, the period of time represented by each candle, either of the time machine, or of the timeline chart, depending on where the node is located."
|
||||
|
||||
timeline_chart: "The timeline chart represents a chart within a time machine, which may have independent rate and time frame scales, as well as particular layers."
|
||||
|
||||
layers_manager: "The layer manager determines which layers will be visible on the corresponding timeline chart."
|
||||
|
||||
layer: "A layer represents a reference to a data product in the data storage node of the Network hierarchy. Conceptually, it means that a certain data product, which exists in a certain location on the network, holds the data to be rendered on the charts."
|
||||
@@ -0,0 +1,25 @@
|
||||
designer: "The designer is the portion of the system the controls all the information available and that enables to user to exert control over the whole system."
|
||||
|
||||
workspace: "The workspace refers to the visual environment that contains all information managed by the system. You may think of the workspace as your desktop."
|
||||
|
||||
node: "A node is a small data structure containing information which may be related to markets information, trading intelligence, the operation of the system or other concepts. They are visually represented by icons on the workspace."
|
||||
|
||||
structure_of_nodes: "Nodes may be linked together forming structures of nodes. In every structure of nodes, there is a parent node with offprings. That is, a structure of nodes is a data structure composed of any node and its offspring."
|
||||
|
||||
parent-offspring_relationships: "Nodes in structures of nodes are chained to each other by so-called parent-offspring relationships, which are visually represented by orange dotted lines, which may turn yellow or blue depending on certain visualization properties that the user may control. When nodes are chained together they form structures of nodes."
|
||||
|
||||
chain: "Nodes in the workspace may be unchained or detached from its parent, carrying all offspring with it. When a node is left unchained, it is no longer taken into account in the logic of the hierarchy, as it no longer belongs to it. When a node is chained back or reattached to the hierarchy, it goes back to being functional."
|
||||
|
||||
hierarchy: "A hierarchy is the representation of an overarching, top-level concept resulting in a long chain of nodes, usually with many ramifications. Currently, the system manages four different types of hierarchies: Trading Systems, Data Mines, Network, and Crypto Ecosystem."
|
||||
|
||||
reference: "A reference is a mechanism by which information in a node is related to, or accessed by, other nodes. The ability of a node to establish a reference with another node enables the first to access the information or features entailed in the second one."
|
||||
|
||||
session: "A session refers to a backtesting, paper trading, forward testing or live trading session. When the term is used without specifying the type of session, then it refers to the overall concept by which a trading bot instance—based on datasets exposed as products by other bots—applies the trading logic defined on a trading system in any of the aforementioned modes."
|
||||
|
||||
sensor_bot: "A sensor bot extracts raw data from external sources (*i.e.: exchanges, Twitter, etc.*)."
|
||||
|
||||
indicator_bot: "An indicator bot processes data to produce more elaborate datasets."
|
||||
|
||||
trading_bot: "Based on datasets exposed as products by other bots (counting sensors, indicators and even other trading bots), a trading bot applies the trading logic defined on a trading system to, on one side, generate a complete trading simulation (outputting datasets that include trades, the action of strategies, validation of conditions, etc.), and on the other side, manage the execution of orders when on a forward testing or live trading session."
|
||||
|
||||
pending:"balanceAssetA, balanceAssetB, overfitting, supported assets, supported exchanges, supported markets"
|
||||
@@ -0,0 +1,25 @@
|
||||
designer: "The designer is the portion of the system the controls all the information available and that enables to user to exert control over the whole system."
|
||||
|
||||
workspace: "The workspace refers to the visual environment that contains all information managed by the system. You may think of the workspace as your desktop."
|
||||
|
||||
node: "A node is a small data structure containing information which may be related to markets information, trading intelligence, the operation of the system or other concepts. They are visually represented by icons on the workspace."
|
||||
|
||||
structure_of_nodes: "Nodes may be linked together forming structures of nodes. In every structure of nodes, there is a parent node with offprings. That is, a structure of nodes is a data structure composed of any node and its offspring."
|
||||
|
||||
parent-offspring_relationships: "Nodes in structures of nodes are chained to each other by so-called parent-offspring relationships, which are visually represented by orange dotted lines, which may turn yellow or blue depending on certain visualization properties that the user may control. When nodes are chained together they form structures of nodes."
|
||||
|
||||
chain: "Nodes in the workspace may be unchained or detached from its parent, carrying all offspring with it. When a node is left unchained, it is no longer taken into account in the logic of the hierarchy, as it no longer belongs to it. When a node is chained back or reattached to the hierarchy, it goes back to being functional."
|
||||
|
||||
hierarchy: "A hierarchy is the representation of an overarching, top-level concept resulting in a long chain of nodes, usually with many ramifications. Currently, the system manages four different types of hierarchies: Trading Systems, Data Mines, Network, and Crypto Ecosystem."
|
||||
|
||||
reference: "A reference is a mechanism by which information in a node is related to, or accessed by, other nodes. The ability of a node to establish a reference with another node enables the first to access the information or features entailed in the second one."
|
||||
|
||||
session: "A session refers to a backtesting, paper trading, forward testing or live trading session. When the term is used without specifying the type of session, then it refers to the overall concept by which a trading bot instance—based on datasets exposed as products by other bots—applies the trading logic defined on a trading system in any of the aforementioned modes."
|
||||
|
||||
sensor_bot: "A sensor bot extracts raw data from external sources (*i.e.: exchanges, Twitter, etc.*)."
|
||||
|
||||
indicator_bot: "An indicator bot processes data to produce more elaborate datasets."
|
||||
|
||||
trading_bot: "Based on datasets exposed as products by other bots (counting sensors, indicators and even other trading bots), a trading bot applies the trading logic defined on a trading system to, on one side, generate a complete trading simulation (outputting datasets that include trades, the action of strategies, validation of conditions, etc.), and on the other side, manage the execution of orders when on a forward testing or live trading session."
|
||||
|
||||
pending: "balanceAssetA, balanceAssetB, overfitting"
|
||||
@@ -0,0 +1,29 @@
|
||||
crypto_ecosystem: "The crypto ecosystem is a hierarchy that contains definitions about third-parties, including exchanges and their markets, as well as accounts of users with those third parties."
|
||||
|
||||
crypto_exchanges: "The crypto exchanges node groups definitions of the different exchanges the user may interact with."
|
||||
|
||||
crypto_exchange: "A crypto exchange node holds the definitions of assets and markets in a specific exchange."
|
||||
|
||||
exchange_assets: "The exchange assets node groups the definitions of assets."
|
||||
|
||||
asset: "An asset node is the definition of an asset listed at the corresponding exchange."
|
||||
|
||||
exchange_markets: "The exchange markets node groups the definitions of markets."
|
||||
|
||||
market: "A market is the definition of a pair of assets (i.e.: BTC-USDT) listed as a market in the corresponding exchange."
|
||||
|
||||
market_base_asset: "The market base asset is a reference to one of the assets listed at the exchange as defined under the exchange assets node. It is the asset in the pair used to provide a quote—a price—for the quoted asset."
|
||||
|
||||
market_quoted_asset: "The market quoted asset is a reference to one of the assets listed at the exchange as defined under the exchange assets node. It is the asset in the pair for which a quote is given, denominated in the base asset."
|
||||
|
||||
exchange_accounts: "The exchange accounts node groups the different accounts the user may have with the corresponding exchange."
|
||||
|
||||
user_account: "A user account represents a single account with the corresponding exchange, holding the definitions of user assets, including keys and balances."
|
||||
|
||||
user_keys: "The user keys node groups the various exchange account keys the user may have under the corresponding account with the exchange."
|
||||
|
||||
exchange_account_key: "The exchange account key holds the definition of the key name and secret provided by the corresponding exchange to access the user account via the exchange API."
|
||||
|
||||
user_assets: "The user assets node groups the assets the user has at the exchange."
|
||||
|
||||
exchange_account_asset: "The exchange account asset represents a single asset the user has at the exchange."
|
||||
@@ -0,0 +1,29 @@
|
||||
crypto_ecosystem: "The crypto ecosystem is a hierarchy that contains definitions about third-parties, including exchanges and their markets, as well as accounts of users with those third parties."
|
||||
|
||||
crypto_exchanges: "The crypto exchanges node groups definitions of the different exchanges the user may interact with."
|
||||
|
||||
crypto_exchange: "A crypto exchange node holds the definitions of assets and markets in a specific exchange."
|
||||
|
||||
exchange_assets: "The exchange assets node groups the definitions of assets."
|
||||
|
||||
asset: "An asset node is the definition of an asset listed at the corresponding exchange."
|
||||
|
||||
exchange_markets: "The exchange markets node groups the definitions of markets."
|
||||
|
||||
market: "A market is the definition of a pair of assets (i.e.: BTC-USDT) listed as a market in the corresponding exchange."
|
||||
|
||||
market_base_asset: "The market base asset is a reference to one of the assets listed at the exchange as defined under the exchange assets node. It is the asset in the pair used to provide a quote—a price—for the quoted asset."
|
||||
|
||||
market_quoted_asset: "The market quoted asset is a reference to one of the assets listed at the exchange as defined under the exchange assets node. It is the asset in the pair for which a quote is given, denominated in the base asset."
|
||||
|
||||
exchange_accounts: "The exchange accounts node groups the different accounts the user may have with the corresponding exchange."
|
||||
|
||||
user_account: "A user account represents a single account with the corresponding exchange, holding the definitions of user assets, including keys and balances."
|
||||
|
||||
user_keys: "The user keys node groups the various exchange account keys the user may have under the corresponding account with the exchange."
|
||||
|
||||
exchange_account_key: "The exchange account key holds the definition of the key name and secret provided by the corresponding exchange to access the user account via the exchange API."
|
||||
|
||||
user_assets: "The user assets node groups the assets the user has at the exchange."
|
||||
|
||||
exchange_account_asset: "The exchange account asset represents a single asset the user has at the exchange."
|
||||
@@ -0,0 +1,71 @@
|
||||
data_mine: "A data mine is a hierarchy that contains definitions regarding sensor bots, indicator bots, and plotters, which extract data from third-party sources, process data, and produce the visualization of data over the charts, respectively."
|
||||
|
||||
indicator_bot: "An indicator bot is an algorithm that processes available information that other bots may have generated, and produces elaborate datasets for others to consume. The indicator bot node holds all definitions required for an indicator bot to function."
|
||||
|
||||
process_definition: "The process definition node groups all definitions required for a process to function. The Multi Period Market Process deals with time frames of one hour and above. The Multi Period Daily Process deals with time frames of 45 minutes and below."
|
||||
|
||||
process_output: "The process output defines which datasets are impacted by the process."
|
||||
|
||||
output_dataset: "The output data set is a reference to a dataset definition. The effect of establishing a reference from the output dataset to a product dataset definition is that—upon execution, every time the process finishes a processing cycle—the process triggers an event that may be consumed by other entities. These events indicate that the corresponding datasets (the ones impacted by the process as per the process output definition) have been updated."
|
||||
|
||||
process_dependencies: "Process dependencies are references to various data structures on which the process depends to function."
|
||||
|
||||
status_dependency: "Status dependencies define which other processes the process depends on."
|
||||
|
||||
data_dependency: "Data dependencies define which datasets the processes uses as input."
|
||||
|
||||
status_report: "Status reports serve as temporal annotations that bots read every time they run to know what was done in the previous cycle and what the state of affairs is at present. Status reports are dynamic, and they change constantly, with updates after every cycle of the associated process."
|
||||
|
||||
execution_started_event: "The execution started event is the event that triggers the execution of a process. It usually references the execution finished event of another process on which the process depends on."
|
||||
|
||||
execution_finished_event: "The execution finished event is the event that processes trigger once they have finished an execution cylce. The event is broadcasted to whoever wants to listen, so that other bots may know when the process has finished its execution cycle."
|
||||
|
||||
product_definition: "The product definition node holds all definitions that make up a product, including how the product is calculated and the datasets the product is comprised of."
|
||||
|
||||
dataset_definition: "A dataset definition contains a configuration file that defines all aspects of the dataset. There are two types of dataset definitions: multi period market and multi period daily."
|
||||
|
||||
record_definition: "The record definition is where indicators define how many fields, what fields and in which order those fields will be stored in each record."
|
||||
|
||||
record: "A record is the compendium of information stored for each period of time, including the start and end datetime of the period along with the properties that provide the information the indicator is meant to generate."
|
||||
|
||||
formula: "In the context of a record definition, formulas are used to assign a value to the property, usually in the form of a variable declared in the calculation or data building procedure."
|
||||
|
||||
calculations_procedure: "The calculations procedure processes information to be fed to calculated properties. Calculated properties are not stored in the data set; instead, they are calculated in real-time as the data is consume by others."
|
||||
|
||||
procedure_loop: "The procedure loop holds the JavaScript code that cycles through an input processing information to generate an output."
|
||||
|
||||
javascript_code: "The JavaScript code node may hold any snippet of valid JavaScript."
|
||||
|
||||
procedure_initialization: "The procedure initialization is used to initialize variables used by the procedure loop."
|
||||
|
||||
data_building_procedure: "The data building procedure processes information to be fed to properties that are stored in the output dataset."
|
||||
|
||||
plotter: "A plotter is a device used to produce a graphic representation of the data generated by indicators."
|
||||
|
||||
plotter_module: "A plotter module is a device within a plotter that contains the definitions to create the visualization, often times, for a particular product definition."
|
||||
|
||||
plotter_panel: "A plotter panel usually shows numerical representations of data over the charts on a small window or panel. The plotter panel node features definitions to make that possible."
|
||||
|
||||
panel_data: "A panel data node represents a data field to be plotted on the plotter panel."
|
||||
|
||||
data_formula: "A data formula is the device used to assign a value to the panel data, usually in the form of the name of the corresponding record property."
|
||||
|
||||
shapes: "The shapes node contains definitions that define polygons and styles to be rendered on a per period basis over the charts."
|
||||
|
||||
chart_points: "The chart points node groups definitions of points."
|
||||
|
||||
point: "A point is a definition of an [x,y] coordinate where x is usually a datetime and y is usually a value that refers to a price, as output by the indicator."
|
||||
|
||||
point_formula: "A point formula is the node used to input the coordinates of a point."
|
||||
|
||||
polygon: "A polygon features definitions that make up shapes and their styles."
|
||||
|
||||
polygon_vertex: "A polygon vertex is a reference to a point defined in the chart points, constituting a specific coordinate to be used as vertex of a shape."
|
||||
|
||||
polygon_border: "A polygon border is a shape defined by at least two vertices used to draw lines or to apply a style to the stroke of a closed shape."
|
||||
|
||||
style: "A style is a definition of color and opacity in case of a polygon body, and of color, opacity and line thickness in case of polygon borders."
|
||||
|
||||
style_condition: "A style condition is a rule that allows applying an alternative style in cases where the rule validates true."
|
||||
|
||||
polygon_body: "A polygon body is is the fill of a shape made out of at least 3 vertices."
|
||||
@@ -0,0 +1,71 @@
|
||||
data_mine: "A data mine is a hierarchy that contains definitions regarding sensor bots, indicator bots, and plotters, which extract data from third-party sources, process data, and produce the visualization of data over the charts, respectively."
|
||||
|
||||
indicator_bot: "An indicator bot is an algorithm that processes available information that other bots may have generated, and produces elaborate datasets for others to consume. The indicator bot node holds all definitions required for an indicator bot to function."
|
||||
|
||||
process_definition: "The process definition node groups all definitions required for a process to function. The Multi Period Market Process deals with time frames of one hour and above. The Multi Period Daily Process deals with time frames of 45 minutes and below."
|
||||
|
||||
process_output: "The process output defines which datasets are impacted by the process."
|
||||
|
||||
output_dataset: "The output data set is a reference to a dataset definition. The effect of establishing a reference from the output dataset to a product dataset definition is that—upon execution, every time the process finishes a processing cycle—the process triggers an event that may be consumed by other entities. These events indicate that the corresponding datasets (the ones impacted by the process as per the process output definition) have been updated."
|
||||
|
||||
process_dependencies: "Process dependencies are references to various data structures on which the process depends to function."
|
||||
|
||||
status_dependency: "Status dependencies define which other processes the process depends on."
|
||||
|
||||
data_dependency: "Data dependencies define which datasets the processes uses as input."
|
||||
|
||||
status_report: "Status reports serve as temporal annotations that bots read every time they run to know what was done in the previous cycle and what the state of affairs is at present. Status reports are dynamic, and they change constantly, with updates after every cycle of the associated process."
|
||||
|
||||
execution_started_event: "The execution started event is the event that triggers the execution of a process. It usually references the execution finished event of another process on which the process depends on."
|
||||
|
||||
execution_finished_event: "The execution finished event is the event that processes trigger once they have finished an execution cylce. The event is broadcasted to whoever wants to listen, so that other bots may know when the process has finished its execution cycle."
|
||||
|
||||
product_definition: "The product definition node holds all definitions that make up a product, including how the product is calculated and the datasets the product is comprised of."
|
||||
|
||||
dataset_definition: "A dataset definition contains a configuration file that defines all aspects of the dataset. There are two types of dataset definitions: multi period market and multi period daily."
|
||||
|
||||
record_definition: "The record definition is where indicators define how many fields, what fields and in which order those fields will be stored in each record."
|
||||
|
||||
record: "A record is the compendium of information stored for each period of time, including the start and end datetime of the period along with the properties that provide the information the indicator is meant to generate."
|
||||
|
||||
formula: "In the context of a record definition, formulas are used to assign a value to the property, usually in the form of a variable declared in the calculation or data building procedure."
|
||||
|
||||
calculations_procedure: "The calculations procedure processes information to be fed to calculated properties. Calculated properties are not stored in the data set; instead, they are calculated in real-time as the data is consume by others."
|
||||
|
||||
procedure_loop: "The procedure loop holds the JavaScript code that cycles through an input processing information to generate an output."
|
||||
|
||||
javascript_code: "The JavaScript code node may hold any snippet of valid JavaScript."
|
||||
|
||||
procedure_initialization: "The procedure initialization is used to initialize variables used by the procedure loop."
|
||||
|
||||
data_building_procedure: "The data building procedure processes information to be fed to properties that are stored in the output dataset."
|
||||
|
||||
plotter: "A plotter is a device used to produce a graphic representation of the data generated by indicators."
|
||||
|
||||
plotter_module: "A plotter module is a device within a plotter that contains the definitions to create the visualization, often times, for a particular product definition."
|
||||
|
||||
plotter_panel: "A plotter panel usually shows numerical representations of data over the charts on a small window or panel. The plotter panel node features definitions to make that possible."
|
||||
|
||||
panel_data: "A panel data node represents a data field to be plotted on the plotter panel."
|
||||
|
||||
data_formula: "A data formula is the device used to assign a value to the panel data, usually in the form of the name of the corresponding record property."
|
||||
|
||||
shapes: "The shapes node contains definitions that define polygons and styles to be rendered on a per period basis over the charts."
|
||||
|
||||
chart_points: "The chart points node groups definitions of points."
|
||||
|
||||
point: "A point is a definition of an [x,y] coordinate where x is usually a datetime and y is usually a value that refers to a price, as output by the indicator."
|
||||
|
||||
point_formula: "A point formula is the node used to input the coordinates of a point."
|
||||
|
||||
polygon: "A polygon features definitions that make up shapes and their styles."
|
||||
|
||||
polygon_vertex: "A polygon vertex is a reference to a point defined in the chart points, constituting a specific coordinate to be used as vertex of a shape."
|
||||
|
||||
polygon_border: "A polygon border is a shape defined by at least two vertices used to draw lines or to apply a style to the stroke of a closed shape."
|
||||
|
||||
style: "A style is a definition of color and opacity in case of a polygon body, and of color, opacity and line thickness in case of polygon borders."
|
||||
|
||||
style_condition: "A style condition is a rule that allows applying an alternative style in cases where the rule validates true."
|
||||
|
||||
polygon_body: "A polygon body is is the fill of a shape made out of at least 3 vertices."
|
||||
@@ -0,0 +1,12 @@
|
||||
elephant: "This is a sample definition."
|
||||
|
||||
baseball: "Baseball is considered America's pasttime sport, though that may be more of a historical term than a current one. There's a lot more excitement about football than baseball. A baseball game is somewhat of a snooze to watch, for the most part."
|
||||
|
||||
basketball: "Basketball is a sport involving two teams of five players each competing to put a ball through a small circular rim 10 feet above the ground. Basketball requires players to be in top physical condition, since they spend most of the game running back and forth along a 94-foot-long floor."
|
||||
|
||||
football: "No doubt the most fun sport to watch, football also manages to accrue the most injuries with the players. From concussions to blown knees, football players have short sport lives."
|
||||
|
||||
soccer: "If there's one sport that dominates the world landscape, it's soccer. However, US soccer fans are few and far between. Apart from the popularity of soccer during the World Cup, most people don't even know the name of the professional soccer organization in their area."
|
||||
|
||||
workspace: "The workspace is a concept that refers to the visual environment that contains all hierarchies with all of their nodes, nodes that may be floating around detached from hierarchies, and the information regarding the physical position and status of all nodes within the Designer, even those detached from the hierarchies. You may think of the workspace as your desktop. It is not part of any of the hierarchies; instead, it contains them."
|
||||
|
||||
@@ -0,0 +1,11 @@
|
||||
jekyll_platform: "Jekyll is a static site generator that builds sites using most modern web technologies."
|
||||
|
||||
fractious: "Like a little mischevious child, full of annoying and constant trouble."
|
||||
|
||||
gratuitous: "Something that is unwarranted and uncouth, like the social equivalent of a flagrant foul."
|
||||
|
||||
haughty: "Proud and flaunting it. Holding your head high up like a snooty, too-good-for-everything rich person."
|
||||
|
||||
impertinent: "Someone acting rude and insensitive to others."
|
||||
|
||||
intrepid: "Brave and courageous especially in a difficult, dangerous situation."
|
||||
@@ -0,0 +1,45 @@
|
||||
network: "The network hierarchy contains definitions regarding the physical location in which certain nodes live or function. For instance, a certain process my run and store data in your local machine, or in some other machine in the network."
|
||||
|
||||
network_node: "A network node represents a machine in the network on which processes run or data is stored."
|
||||
|
||||
task_manager: "A task manager is a device used to organize and control any number of tasks."
|
||||
|
||||
task: "A task is a device used to control bot instances."
|
||||
|
||||
indicator_bot_instance: "An indicator bot instance is a reference to an indicator bot as defined in a data mine. The instance of the bot runs the defined processes and generates the defined data products."
|
||||
|
||||
indicator_process_instance: "An indicator process instance is a reference to the process definition of an indicator bot, as defined in a data mine."
|
||||
|
||||
sensor_bot_instance: "A sensor bot instance is a reference to a sensor bot as defined in a data mine. The instance of the bot runs the defined processes and generates the defined data products."
|
||||
|
||||
sensor_process_instance: "A sensor process instance is a reference to the process definition of a sensor bot, as defined in a data mine."
|
||||
|
||||
market_reference: "A market reference is a reference to a specific market in a specific exchange, as defined in the Crypto Ecosystem hierarchy. The reference dictates which market the process works with."
|
||||
|
||||
trading_bot_instance: "A trading bot instance is a reference to the trading bot as defined in the Masters data mine. The instance of the bot runs the defined processes and generates the defined data products."
|
||||
|
||||
trading_process_instance: "A trading process instance is a reference to the process definition of the trading bot, as defined in the Masters data mine."
|
||||
|
||||
backtesting_session: "A backtesting session is a trading mode by which the trading bot instance reads historic market data in a user-defined datetime range, applies the rules defined in the associated trading system, and generates a trading simulation."
|
||||
|
||||
paper_trading_session: "A paper trading session is a trading mode by which the trading bot instance reads a live market data feed, applies the rules defined in the associated trading system, and generates a trading simulation."
|
||||
|
||||
forward_testing_session: "A forward testing session is a trading mode by which the trading bot instance performs live trading with a user-defined fraction of the available capital."
|
||||
|
||||
live_trading_session: "A live trading session is a trading mode by which the trading bot instance reads a live market data feed, applies the rules as defined in the associated trading system, places the corresponding orders at the associated exchange, and stores the defined data products."
|
||||
|
||||
key_instance: "The key instance is a reference to an exchange account key as defined in a specific user account, in a specific exchange, on the Crypto Ecosystem hierarchy."
|
||||
|
||||
data_storage: "The data storage node controls aspects of what data is to be stored in the corresponding network node."
|
||||
|
||||
session-based_data: "Session-based data refers to data that is generated as a consequence of running a session, that is, data the trading bot instance generates while running backtesting, paper trading, forward testing or live trading sessions."
|
||||
|
||||
session_reference: "A session reference establishes which session is the one which shall store data in the current location."
|
||||
|
||||
single_market_data: "Single market data represents the group of data products generated by the referenced session, in a specific market."
|
||||
|
||||
data_product: "A data product represents the collection of datasets generated by the instance of a bot as defined in the corresponding data mine."
|
||||
|
||||
dataset: "A data set is a collection of files stored in the designated location, as per the definitions on the referenced data product in the corresponding data mine."
|
||||
|
||||
session-independent_data: "Session independent data refers to data generated by sensors and indicators, not related to trading sessions."
|
||||
@@ -0,0 +1,45 @@
|
||||
network: "The network hierarchy contains definitions regarding the physical location in which certain nodes live or function. For instance, a certain process my run and store data in your local machine, or in some other machine in the network."
|
||||
|
||||
network_node: "A network node represents a machine in the network on which processes run or data is stored."
|
||||
|
||||
task_manager: "A task manager is a device used to organize and control any number of tasks."
|
||||
|
||||
task: "A task is a device used to control bot instances."
|
||||
|
||||
indicator_bot_instance: "An indicator bot instance is a reference to an indicator bot as defined in a data mine. The instance of the bot runs the defined processes and generates the defined data products."
|
||||
|
||||
indicator_process_instance: "An indicator process instance is a reference to the process definition of an indicator bot, as defined in a data mine."
|
||||
|
||||
sensor_bot_instance: "A sensor bot instance is a reference to a sensor bot as defined in a data mine. The instance of the bot runs the defined processes and generates the defined data products."
|
||||
|
||||
sensor_process_instance: "A sensor process instance is a reference to the process definition of a sensor bot, as defined in a data mine."
|
||||
|
||||
market_reference: "A market reference is a reference to a specific market in a specific exchange, as defined in the Crypto Ecosystem hierarchy. The reference dictates which market the process works with."
|
||||
|
||||
trading_bot_instance: "A trading bot instance is a reference to the trading bot as defined in the Masters data mine. The instance of the bot runs the defined processes and generates the defined data products."
|
||||
|
||||
trading_process_instance: "A trading process instance is a reference to the process definition of the trading bot, as defined in the Masters data mine."
|
||||
|
||||
backtesting_session: "A backtesting session is a trading mode by which the trading bot instance reads historic market data in a user-defined datetime range, applies the rules defined in the associated trading system, and generates a trading simulation."
|
||||
|
||||
paper_trading_session: "A paper trading session is a trading mode by which the trading bot instance reads a live market data feed, applies the rules defined in the associated trading system, and generates a trading simulation."
|
||||
|
||||
forward_testing_session: "A forward testing session is a trading mode by which the trading bot instance performs live trading with a user-defined fraction of the available capital."
|
||||
|
||||
live_trading_session: "A live trading session is a trading mode by which the trading bot instance reads a live market data feed, applies the rules as defined in the associated trading system, places the corresponding orders at the associated exchange, and stores the defined data products."
|
||||
|
||||
key_instance: "The key instance is a reference to an exchange account key as defined in a specific user account, in a specific exchange, on the Crypto Ecosystem hierarchy."
|
||||
|
||||
data_storage: "The data storage node controls aspects of what data is to be stored in the corresponding network node."
|
||||
|
||||
session-based_data: "Session-based data refers to data that is generated as a consequence of running a session, that is, data the trading bot instance generates while running backtesting, paper trading, forward testing or live trading sessions."
|
||||
|
||||
session_reference: "A session reference establishes which session is the one which shall store data in the current location."
|
||||
|
||||
single_market_data: "Single market data represents the group of data products generated by the referenced session, in a specific market."
|
||||
|
||||
data_product: "A data product represents the collection of datasets generated by the instance of a bot as defined in the corresponding data mine."
|
||||
|
||||
dataset: "A data set is a collection of files stored in the designated location, as per the definitions on the referenced data product in the corresponding data mine."
|
||||
|
||||
session-independent_data: "Session independent data refers to data generated by sensors and indicators, not related to trading sessions."
|
||||
@@ -0,0 +1,322 @@
|
||||
# This is your sidebar TOC. The sidebar code loops through sections here and provides the appropriate formatting.
|
||||
|
||||
entries:
|
||||
- title: sidebar
|
||||
product: Superalgos Suite
|
||||
version: 0.0.6
|
||||
folders:
|
||||
|
||||
- title:
|
||||
output: pdf
|
||||
type: frontmatter
|
||||
folderitems:
|
||||
- title:
|
||||
url: /titlepage.html
|
||||
output: pdf
|
||||
type: frontmatter
|
||||
- title:
|
||||
url: /tocpage.html
|
||||
output: pdf
|
||||
type: frontmatter
|
||||
|
||||
- title: Before you Begin
|
||||
output: web
|
||||
folderitems:
|
||||
|
||||
- title: Welcome!
|
||||
url: /index.html
|
||||
output: web
|
||||
type: homepage
|
||||
|
||||
- title: What to expect
|
||||
url: /suite-what-to-expect.html
|
||||
output: web
|
||||
|
||||
- title: System requirements
|
||||
url: /suite-system-requirements.html
|
||||
output: web
|
||||
|
||||
- title: Getting Started
|
||||
output: web
|
||||
folderitems:
|
||||
|
||||
- title: Download and set up
|
||||
url: /suite-download-and-set-up.html
|
||||
output: web
|
||||
|
||||
- title: Run the suite
|
||||
url: /suite-run-the-suite.html
|
||||
output: web
|
||||
|
||||
- title: Quick overview
|
||||
url: /suite-quick-overview.html
|
||||
output: web
|
||||
|
||||
- title: Run your first backtest
|
||||
url: /suite-run-your-first-backtest.html
|
||||
output: web
|
||||
|
||||
- title: Update datasets
|
||||
url: /suite-update-datasets.html
|
||||
output: web
|
||||
|
||||
- title: Trade with an open-source strategy
|
||||
url: /suite-trade-live-with-an-open-source-strategy.html
|
||||
output: web
|
||||
|
||||
- title: What's next?
|
||||
url: /suite-what-is-next.html
|
||||
output: web
|
||||
|
||||
|
||||
- title: Charts
|
||||
output: web
|
||||
folderitems:
|
||||
|
||||
- title: Overview
|
||||
url: /suite-charts-overview.html
|
||||
output: web
|
||||
|
||||
- title: Interface
|
||||
url: /suite-charts-interface.html
|
||||
output: web
|
||||
|
||||
- title: Layers panel
|
||||
url: /suite-layers-panel.html
|
||||
output: web
|
||||
|
||||
- title: Designer
|
||||
output: web
|
||||
folderitems:
|
||||
|
||||
- title: Intro, workspace and data structures
|
||||
url: /suite-designer-workspace-and-data-structures.html
|
||||
output: web
|
||||
|
||||
- title: Hierarchies
|
||||
url: /suite-hierarchies.html
|
||||
output: web
|
||||
|
||||
- title: Interface
|
||||
url: /suite-designer-interface.html
|
||||
output: web
|
||||
|
||||
- title: Atachment and detachment of nodes
|
||||
url: /suite-detachment-and-attachment-of-nodes.html
|
||||
output: web
|
||||
|
||||
- title: References
|
||||
url: /suite-references.html
|
||||
output: web
|
||||
|
||||
- title: Trading System
|
||||
output: web
|
||||
folderitems:
|
||||
|
||||
- title: Overview
|
||||
url: /suite-trading-system-overview.html
|
||||
output: web
|
||||
|
||||
- title: Working with strategies
|
||||
url: /suite-working-with-strategies.html
|
||||
output: web
|
||||
|
||||
- title: Conditions & Formulas
|
||||
output: web
|
||||
folderitems:
|
||||
|
||||
- title: Syntax Overview
|
||||
url: /suite-sysntax-overview.html
|
||||
output: web
|
||||
|
||||
- title: Internal variables
|
||||
url: /suite-internal-variables.html
|
||||
output: web
|
||||
|
||||
- title: Indicators included in the data release
|
||||
url: /suite-indicators-included-in-the-data-release.html
|
||||
output: web
|
||||
|
||||
- title: Indicators not included in the release
|
||||
url: /suite-indicators-not-included-in-the-data-release.html
|
||||
output: web
|
||||
|
||||
- title: Using non-included indicators
|
||||
url: /suite-using-non-included-indicators.html
|
||||
output: web
|
||||
|
||||
- title: Network
|
||||
output: web
|
||||
folderitems:
|
||||
|
||||
- title: Overview
|
||||
url: /suite-network-overview.html
|
||||
output: web
|
||||
|
||||
- title: Managing processes
|
||||
url: /suite-managing-processes.html
|
||||
output: web
|
||||
|
||||
- title: Backtests & Paper Trading
|
||||
output: web
|
||||
folderitems:
|
||||
|
||||
- title: Overview
|
||||
url: /suite-testing-overview.html
|
||||
output: web
|
||||
|
||||
- title: Session parameters
|
||||
url: /suite-session-parameters.html
|
||||
output: web
|
||||
|
||||
- title: Simulation layers
|
||||
url: /suite-simulation-layers.html
|
||||
output: web
|
||||
|
||||
- title: Advanced backtesting
|
||||
url: /suite-advanced-backtesting.html
|
||||
output: web
|
||||
|
||||
- title: Forward Tests & Live Trading
|
||||
output: web
|
||||
folderitems:
|
||||
|
||||
- title: Overview
|
||||
url: /suite-live-trading-overview.html
|
||||
output: web
|
||||
|
||||
- title: Getting ready to trade live
|
||||
url: /suite-getting-ready-to-trade-live.html
|
||||
output: web
|
||||
|
||||
- title: Live trading history layer
|
||||
url: /suite-live-trading-history-layer.html
|
||||
output: web
|
||||
|
||||
- title: Execution limitations
|
||||
url: /suite-execution-limitations.html
|
||||
output: web
|
||||
|
||||
- title: Multiple sessions
|
||||
url: /suite-multiple-forward-testing-and-live-trading-sessions.html
|
||||
output: web
|
||||
|
||||
- title: Data Mining & Research
|
||||
output: web
|
||||
folderitems:
|
||||
|
||||
- title: Data Mining Overview
|
||||
url: /suite-data-mining-overview.html
|
||||
output: web
|
||||
|
||||
- title: Bots
|
||||
url: /suite-bots.html
|
||||
output: web
|
||||
|
||||
- title: Anatomy of an indicator
|
||||
url: /suite-anatomy-of-an-indicator.html
|
||||
output: web
|
||||
|
||||
- title: ":: Process definition"
|
||||
url: /suite-process-definition.html
|
||||
output: web
|
||||
|
||||
- title: ":: Product definition"
|
||||
url: /suite-product-definition.html
|
||||
output: web
|
||||
|
||||
- title: Input-to-output cycle
|
||||
url: /suite-input-to-output-cycle.html
|
||||
output: web
|
||||
|
||||
- title: Datasets
|
||||
url: /suite-datasets.html
|
||||
output: web
|
||||
|
||||
- title: Dependencies
|
||||
url: /suite-dependencies.html
|
||||
output: web
|
||||
|
||||
- title: Build an indicator
|
||||
url: /suite-build-an-indicator.html
|
||||
output: web
|
||||
|
||||
- title: Build a plotter
|
||||
url: /suite-build-a-plotter.html
|
||||
output: web
|
||||
|
||||
- title: Productivity Tools
|
||||
output: web
|
||||
folderitems:
|
||||
|
||||
- title: Backups
|
||||
url: /suite-backups.html
|
||||
output: web
|
||||
|
||||
- title: Clones
|
||||
url: /suite-clones.html
|
||||
output: web
|
||||
|
||||
- title: Shares
|
||||
url: /suite-shares.html
|
||||
output: web
|
||||
|
||||
- title: Telegram Announcements
|
||||
url: /suite-telegram-announcements.html
|
||||
output: web
|
||||
|
||||
- title: Hierarchies Directory
|
||||
output: web
|
||||
folderitems:
|
||||
|
||||
- title: Crypto ecosystem
|
||||
url: /suite-crypto-ecosystem-hierarchy.html
|
||||
output: web
|
||||
|
||||
- title: Charting system
|
||||
url: /suite-charting-system-hierarchy.html
|
||||
output: web
|
||||
|
||||
- title: Trading system
|
||||
url: /suite-trading-system-hierarchy.html
|
||||
output: web
|
||||
|
||||
- title: Network
|
||||
url: /suite-network-hierarchy.html
|
||||
output: web
|
||||
|
||||
- title: Data mine
|
||||
url: /suite-data-mine-hierarchy.html
|
||||
output: web
|
||||
|
||||
- title: Troubleshooting
|
||||
output: web
|
||||
folderitems:
|
||||
|
||||
- title: Upgrading your existing installation
|
||||
url: /suite-upgrading-your-existing-instalation.html
|
||||
output: web
|
||||
|
||||
- title: My system gets slow
|
||||
url: /suite-my-system-gets-slow.html
|
||||
output: web
|
||||
|
||||
- title: On-screen errors and warnings
|
||||
url: /suite-on-screen-errors-and-warnings.html
|
||||
output: web
|
||||
|
||||
- title: Market data seems to be outdated
|
||||
url: /suite-market-data-indicators-seem-to-be-outdated.html
|
||||
output: web
|
||||
|
||||
- title: Reporting bugs
|
||||
url: /suite-reporting-bugs.html
|
||||
output: web
|
||||
|
||||
- title: Consulting logs
|
||||
url: /suite-consulting-logs.html
|
||||
output: web
|
||||
|
||||
|
||||
|
||||
|
||||
@@ -0,0 +1,116 @@
|
||||
# This is your sidebar TOC. The sidebar code loops through sections here and provides the appropriate formatting.
|
||||
|
||||
entries:
|
||||
- title: sidebar
|
||||
product: Systematic Trading
|
||||
version:
|
||||
folders:
|
||||
|
||||
- title:
|
||||
output: pdf
|
||||
type: frontmatter
|
||||
folderitems:
|
||||
- title:
|
||||
url: /titlepage.html
|
||||
output: pdf
|
||||
type: frontmatter
|
||||
|
||||
- title:
|
||||
url: /tocpage.html
|
||||
output: pdf
|
||||
type: frontmatter
|
||||
|
||||
- title: Trading System
|
||||
output: web
|
||||
folderitems:
|
||||
|
||||
- title: Overview
|
||||
url: /systematic-trading-system-overview.html
|
||||
output: web
|
||||
|
||||
- title: Working with strategies
|
||||
url: /systematic-working-with-strategies.html
|
||||
output: web
|
||||
|
||||
- title: Conditions & Formulas
|
||||
output: web
|
||||
folderitems:
|
||||
|
||||
- title: Syntax Overview
|
||||
url: /systematic-sysntax-overview.html
|
||||
output: web
|
||||
|
||||
- title: Internal variables
|
||||
url: /systematic-internal-variables.html
|
||||
output: web
|
||||
|
||||
- title: Indicators included in the data release
|
||||
url: /systematic-indicators-included-in-the-data-release.html
|
||||
output: web
|
||||
|
||||
- title: Indicators not included in the release
|
||||
url: /systematic-indicators-not-included-in-the-data-release.html
|
||||
output: web
|
||||
|
||||
- title: Using indicators not included in the release
|
||||
url: /systematic-using-indicators-not-included-in-the-data-release.html
|
||||
output: web
|
||||
|
||||
- title: Backtests & Paper Trading
|
||||
output: web
|
||||
folderitems:
|
||||
|
||||
- title: Overview
|
||||
url: /systematic-testing-overview.html
|
||||
output: web
|
||||
|
||||
- title: Session parameters
|
||||
url: /systematic-session-parameters.html
|
||||
output: web
|
||||
|
||||
- title: Simulation layers
|
||||
url: /systematic-simulation-layers.html
|
||||
output: web
|
||||
|
||||
- title: Advanced backtesting
|
||||
url: /systematic-advanced-backtesting.html
|
||||
output: web
|
||||
|
||||
- title: Forward Tests & Live Trading
|
||||
output: web
|
||||
folderitems:
|
||||
|
||||
- title: Overview
|
||||
url: /systematic-live-trading-overview.html
|
||||
output: web
|
||||
|
||||
- title: Getting ready to trade live
|
||||
url: /systematic-getting-ready-to-trade-live.html
|
||||
output: web
|
||||
|
||||
- title: Live trading history layer
|
||||
url: /systematic-live-trading-history-layer.html
|
||||
output: web
|
||||
|
||||
- title: Execution limitations
|
||||
url: /systematic-execution-limitations.html
|
||||
output: web
|
||||
|
||||
- title: Multiple sessions
|
||||
url: /systematic-multiple-forward-testing-and-live-trading-sessions.html
|
||||
output: web
|
||||
|
||||
- title: API Keys
|
||||
output: web
|
||||
folderitems:
|
||||
|
||||
- title: Poloniex API keys
|
||||
url: /systematic-poloniex-api-keys.html
|
||||
output: web
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
@@ -0,0 +1,5 @@
|
||||
|
||||
|
||||
# placed here for translation purposes
|
||||
search_placeholder_text: Search...
|
||||
search_no_results_text: No results found.
|
||||
@@ -0,0 +1,15 @@
|
||||
# Note:
|
||||
# If you are using the createtag script, don't leave an blank line at the end of this file.
|
||||
# In other words, the last line must be the last tag in the allowed-tags list.
|
||||
allowed-tags:
|
||||
- getting_started
|
||||
- content_types
|
||||
- navigation
|
||||
- formatting
|
||||
- publishing
|
||||
- single_sourcing
|
||||
- special_layouts
|
||||
- collaboration
|
||||
- news
|
||||
- troubleshooting
|
||||
- mobile
|
||||
@@ -0,0 +1 @@
|
||||
apple: "apple - the fruit of a disiduous tree."
|
||||
@@ -0,0 +1,34 @@
|
||||
## Topnav single links
|
||||
## if you want to list an external url, use external_url instead of url. the theme will apply a different link base.
|
||||
topnav:
|
||||
- title: Topnav
|
||||
items:
|
||||
- title: Releases
|
||||
external_url: https://github.com/Superalgos/Platform/releases
|
||||
- title: Issues
|
||||
external_url: https://github.com/Superalgos/Platform/issues
|
||||
- title: Suite Docs
|
||||
url: index.html
|
||||
|
||||
#Topnav dropdowns
|
||||
topnav_dropdowns:
|
||||
- title: Topnav dropdowns
|
||||
folders:
|
||||
- title: Product Docs
|
||||
folderitems:
|
||||
- title: Systematic Trading
|
||||
url: /systematic-trading-system-overview.html
|
||||
- title: Algorithmic Trading
|
||||
url: /algorithmic-trading-system-overview.html
|
||||
- title: Discretionary Trading
|
||||
url: /discretionary-introduction.html
|
||||
- title: Smart Holding
|
||||
url: /smart-introduction.html
|
||||
- title: Trading Coach
|
||||
url: /coach-introduction_page.html
|
||||
- title: Signals Broadcast
|
||||
url: /signal-introduction.html
|
||||
- title: Markets Research
|
||||
url: /market-introduction_page.html
|
||||
- title: Data Mining
|
||||
url: /mine-introduction.html
|
||||
@@ -0,0 +1,61 @@
|
||||
trading_system: "A trading system is a hierarchy that contains definitions regarding any number of trading strategies, all sharing the same market, the same base asset, and the same initial capital."
|
||||
|
||||
parameters: "Parameters are user definitions over several concepts. When defined at the level of a session, parameters take precedence over those defined at the level of the trading system, which act as a fallback instance. The behavior of parameters may vary depending on the type of session."
|
||||
|
||||
base_asset: "In the context of a trading system or a session, the base asset is the asset in the pair on which capital stands when out of a trade."
|
||||
|
||||
quoted_asset: "In the context of a trading system or a session, the quoted asset is the asset in the pair for wich capital is traded."
|
||||
|
||||
time_frame: "The time frame is the frequency on which the session runs, meaning that the associated process instance runs once per unit of the time frame."
|
||||
|
||||
time_range: "The time range is the specific period of time between a starting and an ending date on which the session runs."
|
||||
|
||||
slippage: "The slippage is an assumption on the difference between the simulated rate and the actual fill rate of an order, most relevant in the context of backtesting and paper-trading sessions. The parameter is a tool to make simulations more realistic."
|
||||
|
||||
fee_structure: "The fee structure is a parameter enabling users to enter assumptions on fees, to be computed on backtesting and paper trading sessions to make simulations more realistic."
|
||||
|
||||
strategy: "A strategy is a set of actions occurring in stages, designed to achieve a specific goal within a broader plan, via executing trades."
|
||||
|
||||
trigger_stage: "The trigger stage deals with monitoring the market in search for trading oportunities with the corresponding strategy."
|
||||
|
||||
trigger-on_event: "The trigger-on event defines the set of rules that need to be met in order for the corresponding strategy to be triggered on. A strategy that is triggered on may use all the capital available to the trading system, preventing other strategies in the system from triggering."
|
||||
|
||||
situation: "A situation refers to a specific state of the market in which a certain event should take place, as defined by any number of conditions."
|
||||
|
||||
condition: "Conditions are rules within a situation. When all conditions under a situation validate true, then the situation gets validated as well, and the associated event is triggered."
|
||||
|
||||
trigger-off_event: "The trigger-off event defines the set of rules that need to be met in order for the corresponding strategy to be triggered-off. A strategy that is triggered-off releases the capital in reserve and makes it available to other strategies in the trading system."
|
||||
|
||||
take_position_event: "The take position event defines the set of rules that need to be met in order for the taking a position. "
|
||||
|
||||
open_stage: "The open stage deals with all the parameters that define a trade, including position rate and size as well as initial stop and take profit targets."
|
||||
|
||||
initial_definition: "The initial definition node groups the parameters that define the trade at the moment the position is taken."
|
||||
|
||||
initial_stop: "The initial stop defines the initial target to stop a loss, before the trade gets to be managed."
|
||||
|
||||
phase_0: "Phase 0 represents starting point for a stop or take profit target, which may be managed in subsequent phases on the manages stage."
|
||||
|
||||
formula: "A formula is a mathematical expression intended to determine a numerical value to be used for a certain purpose."
|
||||
|
||||
next_phase_event: "The next-phase event describes a market situation upon which the management of the trade should shift from one phase to the next."
|
||||
|
||||
initial_take_profit: "The initial take profit defines the initial target to take profit, before the trade gets to be managed."
|
||||
|
||||
position_size: "The position size allows setting a size for the position using a formula."
|
||||
|
||||
position_rate: "The position rate is currently overriden by the system as execution is limited to market orders until a more robust execution system is deployed."
|
||||
|
||||
open_execution: "Open execution is the node that will eventually hold the information regarding the execution of the trade opening orders."
|
||||
|
||||
manage_stage: "The manage stage is the third stage in the definition of a strategy and deals with the management of stop and take profit targets."
|
||||
|
||||
stop: "Stop sets a new stop loss target associated with the corresponding phase."
|
||||
|
||||
phase_1: "Phase 1 is the first phase in the management of a stop or take profit target. The management of targets may have as many phases as required."
|
||||
|
||||
take_profit: "Take profit sets a new take profit target associated with the corresponding phase."
|
||||
|
||||
close_stage: "Close stage is not developed yet. In the future, it will deal with the execution of the closing orders, trading log, and related matters."
|
||||
|
||||
close_execution: "Close execution is the node that will eventually hold the information regarding the execution of the trade closing orders."
|
||||
@@ -0,0 +1,61 @@
|
||||
trading_system: "A trading system is a hierarchy that contains definitions regarding any number of trading strategies, all sharing the same market, the same base asset, and the same initial capital."
|
||||
|
||||
parameters: "Parameters are user definitions over several concepts. When defined at the level of a session, parameters take precedence over those defined at the level of the trading system, which act as a fallback instance. The behavior of parameters may vary depending on the type of session."
|
||||
|
||||
base_asset: "In the context of a trading system or a session, the base asset is the asset in the pair on which capital stands when out of a trade."
|
||||
|
||||
quoted_asset: "In the context of a trading system or a session, the quoted asset is the asset in the pair for wich capital is traded."
|
||||
|
||||
time_frame: "The time frame is the frequency on which the session runs, meaning that the associated process instance runs once per unit of the time frame."
|
||||
|
||||
time_range: "The time range is the specific period of time between a starting and an ending date on which the session runs."
|
||||
|
||||
slippage: "The slippage is an assumption on the difference between the simulated rate and the actual fill rate of an order, most relevant in the context of backtesting and paper-trading sessions. The parameter is a tool to make simulations more realistic."
|
||||
|
||||
fee_structure: "The fee structure is a parameter enabling users to enter assumptions on fees, to be computed on backtesting and paper trading sessions to make simulations more realistic."
|
||||
|
||||
strategy: "A strategy is a set of actions occurring in stages, designed to achieve a specific goal within a broader plan, via executing trades."
|
||||
|
||||
trigger_stage: "The trigger stage deals with monitoring the market in search for trading oportunities with the corresponding strategy."
|
||||
|
||||
trigger-on_event: "The trigger-on event defines the set of rules that need to be met in order for the corresponding strategy to be triggered on. A strategy that is triggered on may use all the capital available to the trading system, preventing other strategies in the system from triggering."
|
||||
|
||||
situation: "A situation refers to a specific state of the market in which a certain event should take place, as defined by any number of conditions."
|
||||
|
||||
condition: "Conditions are rules within a situation. When all conditions under a situation validate true, then the situation gets validated as well, and the associated event is triggered."
|
||||
|
||||
trigger-off_event: "The trigger-off event defines the set of rules that need to be met in order for the corresponding strategy to be triggered-off. A strategy that is triggered-off releases the capital in reserve and makes it available to other strategies in the trading system."
|
||||
|
||||
take_position_event: "The take position event defines the set of rules that need to be met in order for the taking a position. "
|
||||
|
||||
open_stage: "The open stage deals with all the parameters that define a trade, including position rate and size as well as initial stop and take profit targets."
|
||||
|
||||
initial_definition: "The initial definition node groups the parameters that define the trade at the moment the position is taken."
|
||||
|
||||
initial_stop: "The initial stop defines the initial target to stop a loss, before the trade gets to be managed."
|
||||
|
||||
phase_0: "Phase 0 represents starting point for a stop or take profit target, which may be managed in subsequent phases on the manages stage."
|
||||
|
||||
formula: "A formula is a mathematical expression intended to determine a numerical value to be used for a certain purpose."
|
||||
|
||||
next_phase_event: "The next-phase event describes a market situation upon which the management of the trade should shift from one phase to the next."
|
||||
|
||||
initial_take_profit: "The initial take profit defines the initial target to take profit, before the trade gets to be managed."
|
||||
|
||||
position_size: "The position size allows setting a size for the position using a formula."
|
||||
|
||||
position_rate: "The position rate is currently overriden by the system as execution is limited to market orders until a more robust execution system is deployed."
|
||||
|
||||
open_execution: "Open execution is the node that will eventually hold the information regarding the execution of the trade opening orders."
|
||||
|
||||
manage_stage: "The manage stage is the third stage in the definition of a strategy and deals with the management of stop and take profit targets."
|
||||
|
||||
stop: "Stop sets a new stop loss target associated with the corresponding phase."
|
||||
|
||||
phase_1: "Phase 1 is the first phase in the management of a stop or take profit target. The management of targets may have as many phases as required."
|
||||
|
||||
take_profit: "Take profit sets a new take profit target associated with the corresponding phase."
|
||||
|
||||
close_stage: "Close stage is not developed yet. In the future, it will deal with the execution of the closing orders, trading log, and related matters."
|
||||
|
||||
close_execution: "Close execution is the node that will eventually hold the information regarding the execution of the trade closing orders."
|
||||
Reference in new issue
Block a user