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

v0.0.3

Browse Source
This commit is contained in:
Julian Molina authored and GitHub committed 2019-10-07 16:11:18 +02:00
1 parent 9cc2c3a241
commit 3229f17103
1 file changed
+32 -14
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+32 -14
View File
@@ -103,6 +103,8 @@ Please refer to the [Superalgos Desktop App](https://superalgos.org/tools-supera
## Before You Begin
This *Guetting Started Guide* will quickly show you the very basics of the app, so that you can rapidly see the app's potential. It will take you through a sequence of instructions that you need to follow to download and install the app, run it for the first time, import an existing strategy and run your first backtest.
The following recommendations may make your life easier using this pre-release in alpha stage:
* We highly recommend you use Chrome to run the app, so that you have a similar environment as developers in case you need help.
@@ -117,9 +119,9 @@ The following recommendations may make your life easier using this pre-release i
**1. Downloads**:
Download the software package from the [latest software release](https://github.com/Superalgos/DesktopApp/releases/tag/v.0.0.2-alpha) (```Superalgos-Desktop-App.zip```) and extract the file in an accessible route (you will launch the app from these folders).
Download the software package from the [latest software release](https://github.com/Superalgos/DesktopApp/releases/tag/v.0.0.3-alpha) (```Superalgos-Desktop-App.zip```) and extract the file in an accessible route (you will launch the app from these folders).
Download historic market data from the [latest data release](https://github.com/Superalgos/DesktopApp/releases/tag/data.poloniex.btc.usdt.2019.09.24) (```Poloniex.BTC.USDT.Historic.Data.zip```) and extract the file inside the ```Superalgos Desktop App``` folder generated by the software ZIP package.
Download historic market data from the [latest data release](https://github.com/Superalgos/DesktopApp/releases/tag/data.poloniex.btc.usdt.2019.10.05) (```Poloniex.BTC.USDT.Historic.Data.zip```) and extract the file inside the ```Superalgos Desktop App``` folder generated by the software ZIP package.
You should end up with the following folder structure:
@@ -137,7 +139,7 @@ You should end up with the following folder structure:
**1. Download the Software Package**:
Go to the [latest Superalgos Desktop App release](https://github.com/Superalgos/DesktopApp/releases/tag/v.0.0.2-alpha) and download ```Superalgos-Desktop-App.zip```.
Go to the [latest Superalgos Desktop App release](https://github.com/Superalgos/DesktopApp/releases/tag/v.0.0.3-alpha) and download ```Superalgos-Desktop-App.zip```.
**2. Extract the ZIP file**:
@@ -151,7 +153,7 @@ You may extract/unpack the files in any location of your drive, however, we reco
For your convenience and [the reasons explained](https://superalgos.org/tools-superalgos-desktop-app.shtml#expectations) in the Superalgos Desktop App page on the website, we maintain a downloadable market-data file that you can download, so that you may be up and running as quickly as possible.
Go to the [latest Data release](https://github.com/Superalgos/DesktopApp/releases/tag/data.poloniex.btc.usdt.2019.09.24) and download ```Poloniex.BTC.USDT.Historic.Data.zip```.
Go to the [latest Data release](https://github.com/Superalgos/DesktopApp/releases/tag/data.poloniex.btc.usdt.2019.10.05) and download ```Poloniex.BTC.USDT.Historic.Data.zip```.
The ZIP file includes highly-compressed complete historic BTC/USDT Ploniex market data. Expect decompression to take from 30 to 60 minutes, depending on your system. Once you have the historic data, the app will make sure the data stays up to date.
@@ -215,11 +217,11 @@ If you haven't yet, start by importing either ```Share - Workspace - Bull run ri
**2. Start processes**:
| Task Manager | Definition |
| Task Manager | Network Node |
| :---: | :---: |
| ![task](https://user-images.githubusercontent.com/13994516/65537996-a99dce00-df06-11e9-8f02-0bd0fd6d29dd.png) | ![definition](https://user-images.githubusercontent.com/13994516/63503991-deb29d00-c4d0-11e9-8c03-bf2e618f9ef6.png) |
| ![task](https://user-images.githubusercontent.com/13994516/66308205-ca9eef80-e906-11e9-8864-f7dba886bc7d.png) | ![network-node](https://user-images.githubusercontent.com/13994516/66308204-ca065900-e906-11e9-8b66-80f7fa605f2d.png) |
Open up the Designer section of the app by dragging the horizontal bar upwards and locate the two Task Manager elements connected to the Definition element on the left-hand side of the screen.
Open up the Designer section of the app by dragging the horizontal bar upwards and locate the two Task Manager elements connected to the Network Node element on the left-hand side of the screen.
> To move around the Designer, click on the black background and drag to pan in the desired direction.
@@ -227,6 +229,8 @@ Then, hover your mouse pointer over either of the Task Manager elements and clic
Do the same with the second Task Manager element.
> Notice how each of the two Task Manager elements display a name when you hover your mouse pointer.
![Designer-Start-Processes](https://user-images.githubusercontent.com/13994516/65596168-9f2b1500-df96-11e9-9559-7395124c00a0.gif)
> **NOTES ON MARKET DATA**: You just started the *Trading Engine* along with the *sensors* that extract live data from the exchange and the *indicators* that process raw trades data. These processes will remain running for as long as you keep the browser open running the app. The bots processing exchange data and building indicators datasets will work to bring your data up to date. In our experience, it may take between 10 to 20 minutes per day worth of Poloniex data to be processed. The time it will take for these processes to complete the job depends on several things:
@@ -237,18 +241,32 @@ Do the same with the second Task Manager element.
**3. Run your first backtest**:
Pull down the horizontal bar to go to the charts and make sure you are standing in the 1 hr (one hour) time period. Notice the time box at the bottom of the charts:
| Task Manager | Expand |
| :---: | :---: |
| ![task](https://user-images.githubusercontent.com/13994516/66308205-ca9eef80-e906-11e9-8864-f7dba886bc7d.png) | ![menu-tree-plus](https://user-images.githubusercontent.com/13994516/63041077-45c7c480-bec7-11e9-965c-38e4fd706c38.png) |
Go to the *Tests & Live Trades Tasks* Task Manager (hover over either of the Task Manager elements to see it's name) and expand the view of child elements by clicking on the *plus sign* icon.
[ILLUSTRATION]
Follow the tree of child elements until you find the *Backtesting Session* element.
| Backtesting Session |
| :---: |
| ![session-backtesting](https://user-images.githubusercontent.com/13994516/66318052-e7452280-e91a-11e9-94a7-90ebe6ee6e62.png) |
Hover over the Backtesting Session element and click *Run*.
You just started a backtesting session with a series of pre-configured parameters, including, for instance, the date range on which the backtesting session runs. Later on, you will learn how to adjust these parameters.
You will notice the element will display a date, signalling the progress of the session. The current session will backtest the strategy during the first nine months of 2019. It may take anything between 5 to 20 minutes (depending on your machine's processing power) to finish. You can tell the process finished calculating the backtesting session once the progress date dissapears.
Then, you may pull down the horizontal bar to go to the charts to see the results. Make sure you are standing in the 1 hr (one hour) time period. Notice the time box at the bottom of the charts:
![Getting-Started-Charts-Time-Period](https://user-images.githubusercontent.com/13994516/65598453-c0423480-df9b-11e9-9346-04631dd9719e.gif)
If you are not, use the wheel of your mouse while pointing at the charts to scroll into the 1 hr time period. You do this so that the backtest runs in the time period for which the strategy was designed.
You are now ready to click the START BACKTESTING button on the right-hand side of the horizontal bar.
![Getting-Started-Backtesting](https://user-images.githubusercontent.com/13994516/65598454-c0dacb00-df9b-11e9-8e58-a149b0bffef7.gif)
Once you click the button, it will turn yellow. It may take several minutes for the Trading Engine to do the calculations and get ready to present the simulation over the charts. Once the Trading Engine finishes, the button will turn back to its normal state. That means that you may now turn on the simulation layers in the Layers Panel.
![Getting-Started-Backtesting02](https://user-images.githubusercontent.com/13994516/65598904-c97fd100-df9c-11e9-93f4-324979e67a2d.gif)
You may now navigate the charts by clicking and dragging, or by zooming in and out with the wheel of your mouse. If you change the time period, you will not see the simulated data, as each time period may hold its own simulation.