diff --git a/CanvasApp/ChartingSpace/TimeMachine.js b/CanvasApp/ChartingSpace/TimeMachine.js index 948938cd1..71122a7d9 100644 --- a/CanvasApp/ChartingSpace/TimeMachine.js +++ b/CanvasApp/ChartingSpace/TimeMachine.js @@ -139,9 +139,7 @@ function newTimeMachine () { function initialize (callBackFunction) { timeFrame = INITIAL_TIME_PERIOD loadFrame(thisObject.payload, thisObject.container.frame) - - // thisObject.container.frame.position.x = 0 - // thisObject.container.frame.position.y = 0 + saveFrame(thisObject.payload, thisObject.container.frame) recalculateCoordinateSystem() recalculateCurrentDatetime() diff --git a/docs/_data/sidebars/suite_sidebar.yml b/docs/_data/sidebars/suite_sidebar.yml index aec03cb4f..7cfa2bb6b 100644 --- a/docs/_data/sidebars/suite_sidebar.yml +++ b/docs/_data/sidebars/suite_sidebar.yml @@ -36,21 +36,29 @@ entries: url: /suite-system-requirements.html output: web -# - title: Getting Started -# output: web -# folderitems: + - title: Getting Started + output: web + folderitems: -# - title: Download and set up -# url: /suite-download-and-set-up.html -# output: web + - title: "Step 0: Get ready" + url: /suite-step-0.html + output: web -# - title: Run the suite -# url: /suite-run-the-suite.html -# output: web + - title: "Step 1: Download and set up" + url: /suite-step-1.html + output: web -# - title: Quick overview -# url: /suite-quick-overview.html -# output: web + - title: "Step 2: Run the system" + url: /suite-step-2.html + output: web + + - title: "Step 3: First impression" + url: /suite-step-3.html + output: web + + - title: "Step 4: Quick overview" + url: /suite-step-4.html + output: web # - title: Run your first backtest # url: /suite-run-your-first-backtest.html @@ -86,8 +94,8 @@ entries: output: web folderitems: - - title: Design space, workspace, and nodes - url: /suite-design-space-workspace-and-data-structures.html + - title: Fundamental concepts + url: /suite-fundamental-concepts.html output: web - title: Interface diff --git a/docs/pages/suite/suite-fundamental-concepts.md b/docs/pages/suite/suite-fundamental-concepts.md new file mode 100644 index 000000000..043c10eca --- /dev/null +++ b/docs/pages/suite/suite-fundamental-concepts.md @@ -0,0 +1,66 @@ +--- +title: "Fundamental Concepts" +summary: "The design space controlling the workspace, nodes, structures of nodes, and their parent-offspring relationships are the overarching concepts arranging all information handled by the system." +sidebar: suite_sidebar +permalink: suite-fundamental-concepts.html +--- + +Superalgos handles numerous concepts encompassing fields such as market information, trading strategies, visualization features, workflows, infrastructure, technical resources, and many more. Superalgos structures these concepts in an attempt to make their use intuitive. + +However, each of the above are complex subjects in their own merit. Therefore, it is necessary to acquire a basic level of understanding of the Superalgos paradigm for the desired intuition to emerge. Understanding the following concepts is a first step in that direction. + +## Design Space + +**{{site.data.concepts.design_space}}** + +In practical terms, the design space is the portion of the system you access when you pull up the sliding panel, hiding the charts in the process. + +## Workspace + +**{{site.data.concepts.workspace}}** + +It contains: + +* All hierarchies with all of their nodes. + +* Nodes that may be floating around detached from hierarchies. + +* Information regarding the physical position and status of all nodes within the design space, even those detached from the hierarchies. + +The workspace is not part of any of the hierarchies; instead, it contains them. + +{% include note.html content="Users may manage multiple workspaces, but only one workspace may be loaded in the system at any point." %} + +{% include tip.html content="Backing up your workspace is the best way to store all the information within the design space, ready to be deployed. Your workspace is saved at the browser level every time you make a change, but still, you should back up your workspace once in a while so that you can go back to past versions or recover from the occasional crash. Also, backups allow you to switch seamlessly from one workspace to another workspace." %} + +## Nodes + +**{{site.data.concepts.node}}** + +### Structure of Nodes + +{{site.data.concepts.structure_of_nodes}} + +As a consequence, structures of nodes are hierarchical structures, and a logical representation of how the concepts embodied by each node relate to each other. + +### Parent-Offspring Relationships + +{{site.data.concepts.parent-offspring_relationships}} + +The direction of the relationship is determined, in most cases, by the ability of a node to produce the offspring node. That is, the parent node is the one which, by software design, may produce the offspring node. + +### Attaching and Detaching Nodes + +{{site.data.concepts.chain}} + +This feature is useful when testing different configurations, rules or parameters, as it allows to keep alternatives handy in the workspace. + +[![Design-Space-Attach-Detach](https://user-images.githubusercontent.com/13994516/63227849-6d7e9b80-c1eb-11e9-9a02-6f760f383751.gif)](https://user-images.githubusercontent.com/13994516/63227849-6d7e9b80-c1eb-11e9-9a02-6f760f383751.gif) + +To detach a node, right-click on it and drag it away from the parent node. To attach a node, right-click on it and move it closer to the node you wish to attach it to. + +Nodes may be attached only to potential parents. The system limits the way in which nodes may be attached, according to the logic of the information they contain. + +{% include note.html content="Nodes may not be detached or attached to frozen nodes. You need to unfreeze them before attaching or detaching." %} + +{% include note.html content="The verbs *to chain* and *to attach* may be used interchangeably, as synonyms. Similarly, *to unchain* and *to detach* are both valid." %} \ No newline at end of file diff --git a/docs/pages/suite/suite-step-0.md b/docs/pages/suite/suite-step-0.md new file mode 100644 index 000000000..9aa3985bc --- /dev/null +++ b/docs/pages/suite/suite-step-0.md @@ -0,0 +1,25 @@ +--- +title: "Step 0: Get ready" +summary: Before you begin, please install Chrome. If you are on Mac OS or Linux, install Node JS too. +sidebar: suite_sidebar +permalink: suite-step-0.html +toc: false +--- + +This *Getting Started Guide* will quickly show you the very basics of Superalgos so that you may rapidly grasp the system's potential. The guide will take you through a sequence of instructions to download and install the system, run it for the first time, fetch some data from your preferred exchanges, browse markets on the charts, run a first backtest with an existing strategy, and even try a live trading session, for demonstration purposes. + +But, before you begin, it is highly reccommended that you install Chrome and set it up as your default browser. + +{% include note.html content="Use Chrome so that you have a similar environment as the dev team in case you need help. We are not testing on any other browsers, and it is a well-known fact that browsers behave differently." %} + +## If You Are NOT on Windows + +If you are running Mac OS, Linux or other operating systems, you will need to install Node JS, an open-source server environment required to run Superalgos. + +**1. Go to the Node JS downloads page**. + +**2. Download your system's installer** (the *LTS Recommended for Most Users* version is enough). + +**3. Run the installer** and go through the process until Node JS is fully installed. + +{% include note.html content="Windows users may choose to install Node JS and run the system in the full version of the server too." %} diff --git a/docs/pages/suite/suite-step-1.md b/docs/pages/suite/suite-step-1.md new file mode 100644 index 000000000..e8210d659 --- /dev/null +++ b/docs/pages/suite/suite-step-1.md @@ -0,0 +1,13 @@ +--- +title: "Step 1: Download and Set-Up" +summary: Set up is easy. Just download and extract a ZIP file. +sidebar: suite_sidebar +permalink: suite-step-1.html +toc: false +--- + +**1. Go to the Superalgos repository** within the Superalgos organization in GitHub. + +**2. Click the green *Clone or download* button** on the right-hand side of the page. If you are a developer, feel free to clone the repository, otherwise, click the Download ZIP button. + +**3. Extract the ZIP file** in an accessible location on your local drive. For your convenience, don't put it too deep within a folder structure as you will launch the system from this location. diff --git a/docs/pages/suite/suite-step-2.md b/docs/pages/suite/suite-step-2.md new file mode 100644 index 000000000..0015564f5 --- /dev/null +++ b/docs/pages/suite/suite-step-2.md @@ -0,0 +1,15 @@ +--- +title: "Step 2: Run the System" +summary: Windows users launch the system using an EXE file. Other users launch the system via Node JS. +sidebar: suite_sidebar +permalink: suite-step-2.html +toc: false +--- + +**1. Go to the ```Superalgos-master``` folder** you extracted from the ZIP file on the prior step. + +**2. On Windows systems, double click on ```Superalgos.exe```** and skip points 3 and 4. + +**3. On other systems, open a console/command line/terminal** inside the ```Superalgos-master``` folder. + +**4. Type ```node run```** and hit *Enter* to launch the system. \ No newline at end of file diff --git a/docs/pages/suite/suite-step-3.md b/docs/pages/suite/suite-step-3.md new file mode 100644 index 000000000..ef3e60664 --- /dev/null +++ b/docs/pages/suite/suite-step-3.md @@ -0,0 +1,31 @@ +--- +title: "Step 3: First Impression" +summary: The node server runs the system on the console and the browser runs the web application functioning as a user interface. +sidebar: suite_sidebar +permalink: suite-step-3.html +toc: false +--- + +## On the Console + +If you run the *.exe* file on Windows, a Command Prompt window opens. If you run ```node run``` from within the console/command line/terminal, the Node JS server runs the system on the same console window. + +This is what you should see in your console: + +[IMAGE] + +{% include note.html content="The console must be open for as long as the system is running. Feel free to minimize it, but keep in mind it will later display valuable information." %} + +## On the Browser + +The system opens your default browser and loads the web application functioning as a user interface. + +{% include tip.html content="You should either set Chrome as your default browser before firing up the system, or simply close the non-Chrome browser, open Chrome, and go to http://localhost:9999/." %} + +This is what you should see on your browser: + +[IMAGE] + +Congratulations! You are up and running! + +Now you are ready to learn the basic operation of the system so that you may fetch some data from your preferred exchanges, browser markets on the charts, run your first backtest, or try a live trading session. \ No newline at end of file diff --git a/docs/pages/suite/suite-step-4.md b/docs/pages/suite/suite-step-4.md new file mode 100644 index 000000000..974df5c01 --- /dev/null +++ b/docs/pages/suite/suite-step-4.md @@ -0,0 +1,25 @@ +--- +title: Quick Overview +summary: The charting space on top features the charts, and the design space at the bottom features the control room of the system. +sidebar: suite_sidebar +permalink: suite-step-4.html +--- + +The first time you run the system, you see a screen split in half. The top half features the charting space and the bottom half features the design space. + +Use the control in the center of the turquoise bar to pull the slider up and down to make more room for either space. + +You may also use the keyboard as follows: + +1. Ctrl or ⌘ + Shift + ↑ to close the charting space and open the design space. +1. Ctrl or ⌘ + Shift + ↓ to close the design space and open the charting space. +1. Ctrl or ⌘ + Shift + → to incrementally lower the slider. +1. Ctrl or ⌘ + Shift + ← to incrementally raise the slider. + +{% include tip.html content="Pulling the slider to the top of the screen causes the charting space to stop consuming resources and gives an ample view of the design space." %} + +**The design space** is the place where you create. Think of the design space as the control room of the system. This is where you will control every aspect of your data, your trading strategies, your infrastructure, and the overall behavior of the system. + +{% include tip.html content="Pulling the slider to the bottom of the screen causes the design space to stop consuming resources and offers a full-screen view of the charting space." %} + +**The charting space** shows the charts, which feature market data, indicators, and—eventually—the actions of trading strategies. This is the section of the system in which you will monitor markets and analyze the progress and results of your strategies. diff --git a/docs/pages/suite/suite-system-requirements.md b/docs/pages/suite/suite-system-requirements.md index 0e9289794..d603745a6 100644 --- a/docs/pages/suite/suite-system-requirements.md +++ b/docs/pages/suite/suite-system-requirements.md @@ -37,9 +37,13 @@ These are a few examples of use cases demanding significant processing power: The system is not RAM-intensive. One dedicated gigabyte should be enough for intensive use, and two gigabytes may be required for extreme charting. Those are ball-park, non-scientific figures. +## Graphics Processing Unit + +The system benefits from a powerful GPU, as all of the visual experience Superalgos enables derives from the implementation of an HTML5 canvas animation. The more powerful your GPU, the more data you will be able to visualize at the same time, and the more fluid the visual experience becomes. + ## Console/Command Line -Processes started from the system log their activity on the default console application, or the console used to fire up the app. Windows Command Prompt is particularly bad. It is recommended to install and use a decent application, such as Console Emulator Cmder This will save you time and hassle in the long run. +Processes started from the system log their activity on the default console application, or the console used to fire up the app. Windows Command Prompt is particularly bad. It is recommended to install and use a decent application, such as Console Emulator Cmder. This will save you time and hassle in the long run. ## Deploying a Linux VPS to Trade Live diff --git a/docs/pages/suite/suite-what-to-expect.md b/docs/pages/suite/suite-what-to-expect.md index 2c9c73db9..437febdad 100644 --- a/docs/pages/suite/suite-what-to-expect.md +++ b/docs/pages/suite/suite-what-to-expect.md @@ -23,7 +23,7 @@ Traders rely on datasets for backtesting. The system retrieves raw trades data d The volume of trades data generated at exchanges is significant. Exchanges APIs impose limits on the bandwidth of data you may retrieve from your machine per unit of time. Different exchanges have different transaction volumes, and imposse different limits. -For those reasons, retrieving historic data takes considerably different times on each exchange. For example, retrieving the USDT-BTC market for the whole of 2019 from Poloniex may take three to four hours. The same period for Bitmex may take double or more. +For those reasons, retrieving historic data takes considerably different times on each exchange. For example, retrieving the USDT-BTC market for the whole of 2019 from Bitfinex may take three to four hours. The same period for Bitmex may take several days. A third factor affecting data-retrieval times and initial candles-processing is the computational power of your machine. Check the [system requirements](suite-system-requirements.html) for more details in this regard.