fez5587/Superalgos
1
0 Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Introduction 1-4

Browse Source
This commit is contained in:
Julian Molina committed 2021-01-06 16:21:18 +01:00
1 parent 1cef450030
commit 7e5104d63a
6 files changed
+429 -38
Download Patch File Download Diff File Expand all files Collapse all files

No files matched your search

Projects/Superalgos/Schemas/Docs-Books/the-docs-explained.json
-36
View File
@@ -1,36 +0,0 @@
{
"type": "The Docs Explained",
"definition": {
"text": "This book will walk you through everything you need to know about the Docs.",
"updated": 1609762580891
},
"paragraphs": [
{
"style": "Chapter",
"text": "Superalgos->I->Docs Basics->Read Chapter I to learn the basics concepts. They are the foundation that will let you understand the commands and styles explained later in this book.",
"updated": 1609763076399
},
{
"style": "Chapter",
"text": "Superalgos->II->Docs Commands->The Docs include a powerful command line interface that allows you to quickly fire commands from the search box. Dive into Chapter II to learn the details of each available command.",
"updated": 1609763122458
},
{
"style": "Chapter",
"text": "Superalgos->III->Docs Commands Errors"
},
{
"style": "Chapter",
"text": "Superalgos->IV->Docs Commands Messages",
"updated": 1609783744261
},
{
"style": "Chapter",
"text": "Superalgos->V->Docs Paragraph Styles"
},
{
"style": "Chapter",
"text": "Superalgos->VI->Docs Context Menu Actions"
}
]
}
Projects/Superalgos/Schemas/Docs-Topics/app-commands-errors-002-app-error-github-credentials-missing.json
+2 -2
View File
@@ -3,8 +3,8 @@
"pageNumber": "2",
"type": "App Error Github Credentials Missing",
"definition": {
"text": "In order to manage contributions from within the app, you first need to provide your Github.com credentials so that we can get authenticated when pushing your changes to the remote repository. 5",
"updated": 1609939011496
"text": "In order to manage contributions from within the app, you first need to provide your Github.com credentials so that we can get authenticated when pushing your changes to the remote repository.",
"updated": 1609855182001
},
"paragraphs": [
{
Projects/Superalgos/Schemas/Docs-Topics/introduction-001-fundamental-superalgos-concepts.json
+60
View File
@@ -0,0 +1,60 @@
{
"topic": "Introduction",
"pageNumber": "1",
"type": "Fundamental Superalgos Concepts",
"definition": {
"text": "Superalgos breaks up complexity and describes the fundamental concepts that make up trading intelligence in hierarchies of nodes. Nodes may reference other nodes to access information in other hierarchies.",
"updated": 1609943915544
},
"paragraphs": [
{
"style": "Text",
"text": "Algorithmic trading is a data-driven application. It is the superior ability to derive intelligence from data—above all—that gives automated trading an edge over trading manually.",
"updated": 1609943931550
},
{
"style": "Text",
"text": "However, it would be simplistic to assume that trading intelligence emerges from data alone."
},
{
"style": "Callout",
"text": "Trading intelligence emerges from harnessing the interactions of multiple complex concepts."
},
{
"style": "Text",
"text": "Superalgos is a software infrastructure that contributes to harnessing those concepts and interactions by breaking complexity into small units of information called nodes and arranging them into larger data structures called hierarchies."
},
{
"style": "Text",
"text": "A hierarchy is a data structure representing an overarching, top-level concept, resulting in a long chain of nodes, usually with many ramifications. The system manages different types of hierarchies, each of them with a specific focus. For example, crypto ecosystem, data mines, or charting space."
},
{
"style": "Text",
"text": "A node is a small data structure containing information that may be related to market information, trading intelligence, the operation of the system, or other concepts. They are visually represented by icons in the design space."
},
{
"style": "Text",
"text": "The design space is the visual environment that hosts all system and user definitions. In practical terms, it is the black space below the slider that splits the screen horizontally, separating the design space in the bottom from the charting space on top. As a hierarchy, it features nodes that enable user-control over certain aspects of the look, feel, and behavior of the space."
},
{
"style": "Callout",
"text": "In other words, nodes arranged in hierarchical data structures describe the top-level concepts that make up trading intelligence in a way that helps users visualize and better understand them."
},
{
"style": "Text",
"text": "These top-level concepts described as hierarchies interact with other concepts, that is, with other hierarchies. Interactions among hierarchies are called references."
},
{
"style": "Text",
"text": "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."
},
{
"style": "Text",
"text": "To organize all of this information, Superalgos manages the concept of workspaces. A workspace is an entity storing all system and user-generated information, excluding the state and contents of plugins. In technical terms, a workspace is a JSON file."
},
{
"style": "Note",
"text": " Note: The Bots page brings these conceptual definitions down to earth and offers an overview of how what these top-level concepts are and how they interact with each other."
}
]
}
Projects/Superalgos/Schemas/Docs-Topics/introduction-002-bots-in-superalgos.json
+109
View File
@@ -0,0 +1,109 @@
{
"topic": "Introduction",
"pageNumber": "2",
"type": "Bots In Superalgos",
"definition": {
"text": "Bots are a crucial concept in Superalgos, and a good thread to explain how hierarchies interact with each other.",
"updated": 1609944023850
},
"paragraphs": [
{
"style": "Text",
"text": "While sometimes people use the terms trading bot, trading strategy, and trading system interchangeably, in Superalgos the distinction is sharp and unequivocal. Let’s start by offering three fundamental definitions:",
"updated": 1609944046617
},
{
"style": "List",
"text": "Trading System: A trading system is a framework handling the low-level logic that serves to structure the processes and methods used to implement and deploy trading strategies."
},
{
"style": "List",
"text": "Trading Strategy: A trading strategy is the description of a set of actions or events run in stages. Events are triggered upon the validation of precise conditions describing specific market situations. Trading strategies are designed to achieve a specific goal within the broader plan of a trading system via taking and managing positions."
},
{
"style": "List",
"text": "Trading Bot: A trading bot is a computer program that—based on datasets exposed as products by other bots (counting sensors, indicators and even other trading bots)—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."
},
{
"style": "Callout",
"text": "In Superalgos, trading systems and trading strategies are definitions describing trading logic, while the trading bot is the computer program that uses the trading logic to test strategies, produce simulations, and trade."
},
{
"style": "Note",
"text": "This documentation expands extensively on these three concepts. For the time being, the above distinction is sufficient to continue.",
"updated": 1609944079526
},
{
"style": "Text",
"text": "Before diving into an in-depth exploration of each hierarchy, a quick overview is in order. One of the most important underlying concepts in Superalgos is that of bots. Let’s then use bots as the guiding thread to show you how the different hierarchies in Superalgos interact with each other."
},
{
"style": "Title",
"text": "Bot Definitions"
},
{
"style": "Text",
"text": "In the pages describing data mines and trading mines you will learn that bots are algorithms defined in such mines. That is, mines hold the source code and configuration—the complete set of definitions—of the three existing kinds of bots: sensors, indicators, and the trading bot."
},
{
"style": "Text",
"text": "As a user, you may use all bots in data mines shipping with the system. As a developer, you may create your own mines to develop your own sensors, indicators, and even a new trading bot."
},
{
"style": "Title",
"text": "Bot Instances"
},
{
"style": "Text",
"text": "Using any of these bots entails creating an instance of the bot definition, so that this instance may run the bot’s code. You will seldom need to create bot instances manually, as the process of installing a new market creates all necessary bot instances for your data mining operation and for running trading sessions (by the way, markets are defined and installed from within the crypto ecosystem hierarchy)."
},
{
"style": "Text",
"text": "A bot instance is a reference to a bot as defined in a data or trading mine. The instance of the bot runs the defined processes and generates the defined data products."
},
{
"style": "Text",
"text": "Bot instances are run from within the network hierarchy. You use task managers and tasks to control bot instances, meaning, to start and stop them. Also in the network hierarchy lies the configurations about where the data they generate is to be stored."
},
{
"style": "Title",
"text": "Bot Dependencies"
},
{
"style": "Text",
"text": "Upon execution, bot instances run in a branched sequence determined by their status and data dependencies. For instance, if bot Alice depends on the data produced by bot Bob, then Alice is configured to run as soon as Bob finishes its execution. These configurations are already set up in the corresponding data mines for all existing bots. Therefore, you only need to worry about this if you develop new bots."
},
{
"style": "Text",
"text": "What you do need to understand as a user is that, if Alice depends on data Bob produces, then Bob needs to be running for Alice to do her job. If Bob is not running, then Alice can only sit and wait for Bob to do his part first."
},
{
"style": "Text",
"text": "A good example of such dependencies may be found when running a live trading session. In such a case, the trading bot depends on the sensor and all indicator bots used in the referenced trading system. Indicators must process the data so that the trading bot may analyze it in realtime. Therefore, before running a live trading session, the data mining operation must be running and up to date."
},
{
"style": "Title",
"text": "Bots Execution"
},
{
"style": "Text",
"text": "Each bot runs for as long as it may require to perform its job, usually in the order of a few seconds, and remains asleep until the next cycle is due. That is, bots run for short bursts, in frequent cycles. The reason for this behavior is that bots are prepared to read live data feeds and process it online."
},
{
"style": "Text",
"text": "Bots need to know which market of which exchange they should work with. Exchanges and markets are defined in the crypto ecosystem hierarchy. Bots obtain that information by establishing references with the appropriate markets in that hierarchy."
},
{
"style": "Text",
"text": "In the case of the trading bot, it also needs to know which type of trading session it should run, and what trading system’s rules it should follow. For those reasons, trading bots are paired with a specific session, which in turn, references a trading system."
},
{
"style": "Text",
"text": "Trading systems are themselves hierarchies. You may create a trading system by following a framework in which strategies are described in stages. You do not need to code to create a strategy, as the rules are written with simple mathematical statements. However, both basic and advanced knowledge of JavaScript will give you an edge. You may test and deploy your trading system by running trading sessions from within the network hierarchy."
},
{
"style": "Text",
"text": ""
}
]
}
Projects/Superalgos/Schemas/Docs-Topics/introduction-003-hierarchies.json
+203
View File
@@ -0,0 +1,203 @@
{
"topic": "Introduction",
"pageNumber": "3",
"type": "Hierarchies",
"definition": {
"text": "A hierarchy is a data structure representing an overarching, top-level concept, resulting in a long chain of nodes, usually with many ramifications. The system manages different types of hierarchies, each of them with a specific focus.",
"updated": 1609945718294
},
"paragraphs": [
{
"style": "Text",
"text": " In the design space, the head or parent node of each hierarchy is represented by the corresponding icon surrounded by an ever-present white ring, so that they are easier to locate within the workspace.",
"updated": 1609944331184
},
{
"style": "Important",
"text": " Hierarchies included in the workspace as plugins are not saved at the workspace level. As such, changes made in those hierarchies do not persist. If you wish to modify a plugin and keep working with the modified version in the future, you must either clone or backup the plugin and work on the resulting copy instead.",
"updated": 1609945802943
},
{
"style": "Title",
"text": "Superalgos Project",
"updated": 1609945005370
},
{
"style": "Include",
"text": "Superalgos->Node->Superalgos Project->Definition",
"updated": 1609944933341
},
{
"style": "Include",
"text": "Superalgos->Node->Superalgos Project->Content",
"updated": 1609944944285
},
{
"style": "Title",
"text": "Design Space",
"updated": 1609945819410
},
{
"style": "Include",
"text": "Superalgos->Node->Design Space->Definition",
"updated": 1609945823788
},
{
"style": "Include",
"text": "Superalgos->Node->Design Space->Content",
"updated": 1609945827564
},
{
"style": "Title",
"text": "Crypto Ecosystem"
},
{
"style": "Include",
"text": "Superalgos->Node->Crypto Ecosystem->Definition",
"updated": 1609945187089
},
{
"style": "Include",
"text": "Superalgos->Node->Crypto Ecosystem->Content",
"updated": 1609945202345
},
{
"style": "Title",
"text": "Network",
"updated": 1609945037649
},
{
"style": "Include",
"text": "Superalgos->Node->Network->Definition",
"updated": 1609945860234
},
{
"style": "Include",
"text": "Superalgos->Node->Network->Content",
"updated": 1609945864347
},
{
"style": "Title",
"text": "Charting Space",
"updated": 1609945048562
},
{
"style": "Include",
"text": "Superalgos->Node->Charting Space->Definition",
"updated": 1609945880962
},
{
"style": "Include",
"text": "Superalgos->Node->Charting Space->Content",
"updated": 1609945886008
},
{
"style": "Title",
"text": "Trading System",
"updated": 1609945101604
},
{
"style": "Include",
"text": "Superalgos->Node->Trading System->Definition",
"updated": 1609945942207
},
{
"style": "Include",
"text": "Superalgos->Node->Trading System->Content",
"updated": 1609945952584
},
{
"style": "Title",
"text": "Trading Mine"
},
{
"style": "Include",
"text": "Superalgos->Node->Trading Mine->Definition",
"updated": 1609945981528
},
{
"style": "Include",
"text": "Superalgos->Node->Trading Mine->Content",
"updated": 1609945984960
},
{
"style": "Title",
"text": "Trading Engine",
"updated": 1609945113032
},
{
"style": "Include",
"text": "Superalgos->Node->Trading Engine->Definition",
"updated": 1609945998216
},
{
"style": "Include",
"text": "Superalgos->Node->Trading Engine->Content",
"updated": 1609946001567
},
{
"style": "Title",
"text": "Data Mine",
"updated": 1609945134789
},
{
"style": "Include",
"text": "Superalgos->Node->Data Mine->Definition",
"updated": 1609946022992
},
{
"style": "Include",
"text": "Superalgos->Node->Data Mine->Content",
"updated": 1609946026584
},
{
"style": "Title",
"text": "Plugins",
"updated": 1609945527199
},
{
"style": "Include",
"text": "Superalgos->Node->Plugins->Definition",
"updated": 1609946038957
},
{
"style": "Include",
"text": "Superalgos->Node->Plugins->Content",
"updated": 1609946042538
},
{
"style": "Title",
"text": "Tutorial",
"updated": 1609946064589
},
{
"style": "Include",
"text": "Superalgos->Node->Tutorial->Definition",
"updated": 1609946067573
},
{
"style": "Include",
"text": "Superalgos->Node->Tutorial->Content",
"updated": 1609946070683
},
{
"style": "Title",
"text": "Super Scripts",
"updated": 1609945544452
},
{
"style": "Include",
"text": "Superalgos->Node->Super Scripts->Definition",
"updated": 1609946084954
},
{
"style": "Include",
"text": "Superalgos->Node->Super Scripts->Content",
"updated": 1609946088312
},
{
"style": "Text",
"text": ""
}
]
}
Projects/Superalgos/Schemas/Docs-Topics/introduction-004-workflows.json
+55
View File
@@ -0,0 +1,55 @@
{
"topic": "Introduction",
"pageNumber": "4",
"type": "Workflows",
"definition": {
"text": "Your preferred workflow will emerge from the understanding of how Superalgos administers the complexity of multiple concepts that make up trading intelligence.",
"updated": 1609946305313
},
"paragraphs": [
{
"style": "Text",
"text": "Superalgos features multiple intertwining workflows, each with multiple ramifications and variations. Use cases for a trading automation platform like Superalgos abound and are probably impossible to extricate from one another:"
},
{
"style": "List",
"text": "Users may download data from multiple exchanges and multiple markets."
},
{
"style": "List",
"text": "They may process data using existing indicators, modify those indicators, or create their own technical studies with varying degrees of complexity."
},
{
"style": "List",
"text": "They may use simple charts or may configure complex charts superimposing information from different markets and different exchanges."
},
{
"style": "List",
"text": "They may use and modify existing trading systems or create their own, both with or without coding."
},
{
"style": "List",
"text": "They may trade in a fully automated fashion, use the system for backtesting, or for generating signals from paper trading sessions."
},
{
"style": "List",
"text": "They may run minimalistic, home-sized trading operations or deploy industrial-grade trading farms."
},
{
"style": "List",
"text": "They may operate in a single market or leverage multiple exchanges and markets with a complex web of trading systems."
},
{
"style": "Callout",
"text": "All of these use cases and the infinite permutations that may result from combining each dimension of use in varying measures may as well produce infinite workflows."
},
{
"style": "Text",
"text": "The best approach to start developing your workflow is to build up your understanding of how the system is structured, and—in particular—how information is made available to each of the components of the system."
},
{
"style": "Text",
"text": "As a rule of thumb, one of the foremost system design criteria for Superalgos is flexibility. The system should impose no constraints and let your imagination and hardware resources set the limits of what you may or may not do."
}
]
}