diff --git a/README.md b/README.md index ba579aea8334..430e93dc3781 100644 --- a/README.md +++ b/README.md @@ -95,7 +95,7 @@ As a modern Python-based environment, OpenBBTerminal opens access to numerous Py If you wish to install the Terminal, there are currently four options: -- [Using the Installer](https://openbb-finance.github.io/OpenBBTerminal/terminal/#accessing-the-openbb-terminal) (recommended if you just want to use the terminal) +- [Using the Installer](https://openbb-finance.github.io/OpenBBTerminal/#accessing-the-openbb-terminal) (recommended if you just want to use the terminal) - [Using Python](openbb_terminal/README.md#anaconda--python) (recommended if you want to develop new features) - [Using Docker](openbb_terminal/README.md#Docker-Installation) (alternative option to the installer if preferred) - [Using Docker Web UI](openbb_terminal/README.md#web-ui---docker) (if you want to deploy the web UI for users to access diff --git a/website/config.toml b/website/config.toml index 7f215176c495..9e2d2008540e 100644 --- a/website/config.toml +++ b/website/config.toml @@ -24,7 +24,7 @@ enableGitInfo = true # (Optional, default static/brand.svg) Set the path to a logo for the Geekdoc # relative to your 'static/' folder. - geekdocLogo = "gst_logo_green.png" + geekdocLogo = "openbb_logo.png" # (Optional, default false) Render menu from data file im 'data/menu/main.yaml'. geekdocMenuBundle = true diff --git a/website/content/_index.md b/website/content/_index.md index 5c100fbcad46..31418270f9d9 100644 --- a/website/content/_index.md +++ b/website/content/_index.md @@ -2,9 +2,9 @@ title: Getting Started keywords: "getting started, openbb, bots, api, beginner guide, how to use openbb, openbb keys, openbb terminal, openbb" excerpt: "This page guides you how to use the OpenBB terminal, developed by OpenBB." +description: "The OpenBB Documentation provides guidance on how to use the OpenBB Terminal, a free, custom built +financial terminal that will help you make more informed decisions, faster." geekdocCollapseSection: true -aliases: - - /terminal/_index.md --- ## Introduction @@ -96,35 +96,77 @@ or visit our contact pagethe following link -2. Click on the 'Latest' release and scroll down -3. Click on the ".exe" file, this downloads the installation program +2. Click on the `Latest` release and scroll down +3. Click on the `.exe` file, this downloads the installation program -When the file is downloaded, you can follow the following steps: +When the file is downloaded, use the following steps to run the OpenBB Terminal: -| Installation instructions | Illustration | -|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| Double click the .exe file that got downloaded to your "Downloads" folder. You will most likely receive the error on the right stating "Windows protected your PC". This is because the installer is still in beta phase, and the team has not yet requested verification from Windows.

Click on "More info" and select "Run anyway" to start the installation process. Proceed by following the steps. Do note that if you wish to install the application to 'Program Files' that you will have to run the resulting application as Administrator.

By clicking on the application that appeared on your Desktop, you are able to run the Terminal. The first time this takes a bit longer to load. |

windows_protected_your_pc

run_anyway

run_the_terminal

| +{{< columns >}} + +**Step 1: Double-click the `.exe` file that got downloaded to your `Downloads` folder** + +You will most likely receive the error below stating "Windows protected your PC". This is because the installer is +still in beta phase, and the team has not yet requested verification from Windows. + +

windows_protected_your_pc

+ +<---> + +**Step 2: Click on `More info` and select `Run anyway` to start the installation process** + +Proceed by following the steps. Do note that if you wish to install the application to "Program Files" that you will have to run the resulting application as Administrator. + +

run_anyway

+ +<---> + +**Step 3: Double-click on the application that appeared on your Desktop, you are now able to run the OpenBB Terminal** + +The first time this takes a bit longer to load, this can take up to a few minutes. + +

run_the_terminal

+ +{{< /columns >}} ### Installation for macOS The process starts off by downloading the installer, see below for how to download the most recent release: 1. Go to the following link -2. Click on the 'Latest' release and scroll down -3. Click on the ".dmg" file, this downloads the installation program +2. Click on the `Latest` release and scroll down +3. Click on the `.dmg` file, this downloads the installation program -Installation instructions: +When the file is downloaded, use the following steps to run the OpenBB Terminal: -1. Open the .dmg file that got downloaded to your "Downloads" folder. -2. Drag the folder into your "Applications" folder. This should take some time as it is extracting the - files from the .dmg file. -3. Open the folder and click on the "OpenBB Terminal" file, this should run the application. +{{< columns >}} + +**Step 1: Open the downloaded file and move the folder inside your `Applications` folder** + +Open the .dmg file that got downloaded to your "Downloads" folder and drag the folder into your "Applications" folder. +Note that this should take some time as it is extracting the files from the .dmg file. + +You can find the `Applications` folder on the left side of the Finder application (`⌥ + ⌘ + SPACEBAR`). Alternatively, +search for the Finder with `⌘ + SPACEBAR`. + +

mac_os_installation

+ +<---> + +**Step 2: Open the folder and click on the `OpenBB Terminal` file, this should run the application.** -mac_os_installation +You will most likely receive a message that macOS was not able to check whether the application contains malicious software. This is because the installer is still in beta phase, and the team has not yet requested verification from Apple. See below how to correct for this. -| Note about "Cannot check it for malicious software" warning | Illustration | -|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| Run the file. You will most likely receive a message that macOS was not able to check whether the application contains malicious software. This is because the installer is still in beta phase, and the team has not yet requested verification from Apple. See below how to correct for this.

Go to `System Preferences > Security & Privacy > General`. You should see a message at the bottom that says that the file "was blocked from use because it is not from an identified developer". Click on “Allow anyway” or "Open anyway".

You should now be able to launch the application. |

malicious_software_warning

warning_fix

| +

malicious_software_warning

+ +<---> + +**Step 3: Allow the application to be run by going into your settings** + +Go to `System Preferences > Security & Privacy > General`. You should see a message at the bottom that says that the file "was blocked from use because it is not from an identified developer". Click on `Allow anyway` or `Open anyway`. + +

warning_fix

+ +{{< /columns >}} ## Structure of the OpenBB Terminal @@ -151,15 +193,15 @@ This opens a new menu as depicted below. Stocks Menu -Depending on the menu you are in, you are presented with a new set of commands (see "Explanation of Commands") +Depending on the menu you are in, you are presented with a new set of commands (see Explanation of Commands) and menus you can select. There are interactions in place between each menu. For example, when selecting a company within the `stocks` menu, the terminal will remember your selection when you visit the `fa` or `options` menu. -See Introduction to Stocks for more information. +See Introduction to Stocks for more information. ### Explanation of Commands Commands, depicted in Light Blue, execute an action or task. For example, -the commands that you are able to use from any menu in the terminal (see "Explanation of Menus") are as follows: +the commands that you are able to use from any menu in the terminal (see Explanation of Menus) are as follows: - `cls`: clears the screen, by executing this command you are left with an empty screen. - `help`, `h` or `?`: displays the menu that you are currently on. @@ -168,7 +210,7 @@ use `q` and press `ENTER` (⏎) you return to where you started. Validate this b - `support`: allows you to submit bugs, questions and suggestions. Continuing with the example mentioned at `quit`, revisit the `stocks` menu and look at the commands. At the top you -will see a command named load. To understand what this command can do, you can use `load -h` followed by `ENTER` (⏎). The `-h` stands for `help` and every command will have this feature. This will return the following: +will see a command named load. To understand what this command can do, you can use `load -h` followed by `ENTER` (⏎). The `-h` stands for `help` and every command will have this feature. This will return the following: ``` 2022 May 19, 05:27 (🦋) /stocks/ $ load -h @@ -250,8 +292,8 @@ selected period. ``` Amazon Candle Chart -As mentioned in the "Explanation of Menus", some information also transfers over to other menus and this includes the -loaded market data from load. +As mentioned in the Explanation of Menus, some information also transfers over to other menus and this includes the +loaded market data from load. So, if you would visit the `ta` menu (which stands for Technical Analysis) you will see that, by running any command, the selected period above is depicted again. Return to the Stocks menu again by using `q` and use it again to return to the home screen which can be shown with `?`. ## Accessing other sources of data via API keys @@ -294,38 +336,37 @@ To figure out where you can obtain the API key, you can enter the command (e.g. | smartstake | Smartstake | https://www.smartstake.io | | github | GitHub | https://docs.github.com/en/rest/guides/getting-started-with-the-rest-api | -## Available menus +## Available menus within the OpenBB Terminal -There is a large collection of (sub) menus available. Here, the asset class and other menus are described. To find a detailed description and explanation of its usage for each menu, click on the corresponding link to visit the introduction page. +There is a large collection of (sub) menus available. Here, the asset class and other menus are described. To find a detailed description and explanation of its usage for each menu, click on the corresponding link to visit the introduction page. The asset class menus are as follows: -- Introduction to Stocks: access historical pricing data, options, sector and +- Introduction to Stocks: access historical pricing data, options, sector and industry analysis, and overall due diligence. -- Introduction to Crypto: dive into onchain data, tokenomics, circulation supply, +- Introduction to Crypto: dive into onchain data, tokenomics, circulation supply, nfts and more. -- Introduction to ETF: explore exchange traded funds, historical pricing, holdings +- Introduction to ETF: explore exchange traded funds, historical pricing, holdings and screeners. -- Introduction to Forex: see foreign exchanges, quotes, forward rates for currency +- Introduction to Forex: see foreign exchanges, quotes, forward rates for currency pairs and Oanda integration. -- Introduction to Funds: discover mutual funds, general overviews, holdings and +- Introduction to Funds: discover mutual funds, general overviews, holdings and sector weights. The other menus are as follows: -- Introduction to Economy: explore global macroeconomic data including +- Introduction to Economy: explore global macroeconomic data including interest and inflation rates, GDP and its components, futures, yield curves and treasury rates. -- Introduction to Alternative: explore alternative datasets such as COVID and +- Introduction to Alternative: explore alternative datasets such as COVID and open source metrics. -- Introduction to Econometrics: perform (advanced) regression techniques and +- Introduction to Econometrics: perform (advanced) regression techniques and statistical tests on custom datasets to understand relationships for both time series and panel data. -- Introduction to Portfolio: understand how your portfolio evolved over time, what +- Introduction to Portfolio: understand how your portfolio evolved over time, what assets contributed the most to this performance, compare this to a benchmark and make adjustments via various portfolio optimization techniques. -- Introduction to Dashboards: see interactive dashboards using voila and -jupyter notebooks. -- Introduction to Reports: create customizable research reports through +- Introduction to Dashboards: see interactive dashboards using voila and jupyter notebooks. +- Introduction to Reports (Work in Progress): create customizable research reports through jupyter notebooks. To adjust the lay-out and settings of the OpenBB Terminal you can access the `settings` menu. This menu allows you to tweak how the terminal behaves. For example, you are able to define the coloring, interactive graphs and whether to use @@ -364,6 +405,6 @@ Alternatively, you can contact us via the following routes: [bugs-closed-shield]: https://img.shields.io/github/issues-closed/OpenBB-finance/OpenBBTerminal/bug.svg?style=for-the-badge&color=success [bugs-closed-url]: https://github.com/OpenBB-finance/OpenBBTerminal/issues?q=is%3Aissue+label%3Abug+is%3Aclosed [license-shield]: https://img.shields.io/github/license/OpenBB-finance/OpenBBTerminal.svg?style=for-the-badge -[license-url]: https://github.com/OpenBB-finance/OpenBBTerminal/blob/main/LICENSE.txt +[license-url]: https://github.com/OpenBB-finance/OpenBBTerminal/blob/main/LICENSE [twitter-shield]: https://img.shields.io/twitter/follow/openbb_finance?style=for-the-badge&color=blue [twitter-url]: https://twitter.com/openbb_finance \ No newline at end of file diff --git a/website/content/gst_logo_lockup_rGreen_with_letters.png b/website/content/gst_logo_lockup_rGreen_with_letters.png deleted file mode 100644 index a3e6d6782f64..000000000000 Binary files a/website/content/gst_logo_lockup_rGreen_with_letters.png and /dev/null differ diff --git a/website/content/terminal/_index.md b/website/content/terminal/_index.md index 039c4173e35e..752408c70884 100644 --- a/website/content/terminal/_index.md +++ b/website/content/terminal/_index.md @@ -76,6 +76,6 @@ Navigate through 750+ terminal features using fast shortcuts and leverage auto-c [bugs-closed-shield]: https://img.shields.io/github/issues-closed/OpenBB-finance/OpenBBTerminal/bug.svg?style=for-the-badge&color=success [bugs-closed-url]: https://github.com/OpenBB-finance/OpenBBTerminal/issues?q=is%3Aissue+label%3Abug+is%3Aclosed [license-shield]: https://img.shields.io/github/license/OpenBB-finance/OpenBBTerminal.svg?style=for-the-badge -[license-url]: https://github.com/OpenBB-finance/OpenBBTerminal/blob/main/LICENSE.txt +[license-url]: https://github.com/OpenBB-finance/OpenBBTerminal/blob/main/LICENSE [twitter-shield]: https://img.shields.io/twitter/follow/openbb_finance?style=for-the-badge&color=blue [twitter-url]: https://twitter.com/openbb_finance \ No newline at end of file diff --git a/website/content/terminal/alternative/_index.md b/website/content/terminal/alternative/_index.md index 093e02e215d7..11dc36d4a3c0 100644 --- a/website/content/terminal/alternative/_index.md +++ b/website/content/terminal/alternative/_index.md @@ -2,4 +2,7 @@ geekdocCollapseSection: true --- +Investors utilize alternative data to analyze a company or investment that is not available through typical data sources (financial statements, SEC filings, management presentations, press releases, etc.). Traditional data sources do not provide investors with as accurate, timely, or granular insights and measurements into corporate performance as alternative data does. Increases in computing power and personal device usage have resulted in tremendous data production during the previous ten years. As a result, a slew of new businesses have sprung up to collect, clean, analyze, and interpret data in order to sell it as a product that might help investors make better decisions. + +**Available commands** {{< toc-tree >}} diff --git a/website/content/terminal/alternative/covid/_index.md b/website/content/terminal/alternative/covid/_index.md index 093e02e215d7..cf01e10c0a44 100644 --- a/website/content/terminal/alternative/covid/_index.md +++ b/website/content/terminal/alternative/covid/_index.md @@ -2,4 +2,5 @@ geekdocCollapseSection: true --- +**Available commands:** {{< toc-tree >}} diff --git a/website/content/terminal/alternative/oss/_index.md b/website/content/terminal/alternative/oss/_index.md index 093e02e215d7..cf01e10c0a44 100644 --- a/website/content/terminal/alternative/oss/_index.md +++ b/website/content/terminal/alternative/oss/_index.md @@ -2,4 +2,5 @@ geekdocCollapseSection: true --- +**Available commands:** {{< toc-tree >}} diff --git a/website/content/terminal/common/_index.md b/website/content/terminal/common/_index.md index 093e02e215d7..a5c117fe473f 100755 --- a/website/content/terminal/common/_index.md +++ b/website/content/terminal/common/_index.md @@ -2,4 +2,9 @@ geekdocCollapseSection: true --- +The Common menu is a menu that serves the purpose of being able to make multiple analysis techniques available +on multiple menus within the Terminal. E.g. technical and quantitative analysis is available for both stocks and +cryptocurrencies. + +**Available commands** {{< toc-tree >}} diff --git a/website/content/terminal/common/prediction_techniques/_index.md b/website/content/terminal/common/prediction_techniques/_index.md index 093e02e215d7..f893c9c6fd23 100755 --- a/website/content/terminal/common/prediction_techniques/_index.md +++ b/website/content/terminal/common/prediction_techniques/_index.md @@ -2,4 +2,7 @@ geekdocCollapseSection: true --- +**Prediction Techniques** are methods of using historical data to train machine learning models that can predict future outcomes based on statistical computations. Predictive analytics is being used by businesses to tackle difficulties such as choosing which items to advertise to specific client segments and on which platforms, as well as uncover new insights from existing data. Predictive modeling is defined as the process of approximating a mapping function (f) from input variables (X) to output variables (Y). + +**Available commands** {{< toc-tree >}} diff --git a/website/content/terminal/common/quantitative_analysis/_index.md b/website/content/terminal/common/quantitative_analysis/_index.md index 093e02e215d7..2ef190434dcd 100755 --- a/website/content/terminal/common/quantitative_analysis/_index.md +++ b/website/content/terminal/common/quantitative_analysis/_index.md @@ -2,4 +2,7 @@ geekdocCollapseSection: true --- +In finance and investment management, **Quantitative Analysis** refers to the application of mathematical and statistical methodologies. Quantitative analysts are those that work in this subject (quants). Quants typically focus on a few topics, such as derivative structure or pricing, risk management, algorithmic trading, and investment management. Industrial mathematics jobs are similar to those in other industries. The procedure usually entails scanning through large databases for patterns, such as correlations between liquid assets or price movement patterns (trend following or mean reversion). High-frequency trading may be used in the resulting strategies. + +**Available commands** {{< toc-tree >}} diff --git a/website/content/terminal/common/technical_analysis/_index.md b/website/content/terminal/common/technical_analysis/_index.md index 093e02e215d7..7e8c86c1e4a8 100755 --- a/website/content/terminal/common/technical_analysis/_index.md +++ b/website/content/terminal/common/technical_analysis/_index.md @@ -2,4 +2,7 @@ geekdocCollapseSection: true --- +The study of financial market action is known as **Technical Analysis**. The technician examines price changes that occur on a daily, weekly, or monthly basis, or over any other fixed time period displayed graphically as charts. As a result, the term "chart analysis" was coined. A chartist merely looks at price charts, whereas a technical analyst looks at technical indications resulting from price changes as well. Instead of looking at the fundamental causes that (appear to) influence market prices, technical analysts look at how the financial markets behave. Even if all relevant information about a specific market or stock were accessible, technicians believe it would be impossible to forecast an exact market "reaction" to that information. + +**Available commands** {{< toc-tree >}} diff --git a/website/content/terminal/cryptocurrency/_index.md b/website/content/terminal/cryptocurrency/_index.md index 093e02e215d7..e3ca5afb6481 100644 --- a/website/content/terminal/cryptocurrency/_index.md +++ b/website/content/terminal/cryptocurrency/_index.md @@ -2,4 +2,9 @@ geekdocCollapseSection: true --- +Cryptocurrency is a type of electronic money. This sort of currency employs blockchain technology, which is regarded as secure since it can achieve distributed consensus even among untrustworthy people. Cryptocurrency blockchains are similar to traditional bookkeepers' ledgers, with the exception that the ledger is electronic and anybody with access to it can act as the bookkeeper. + +Cryptocurrency has attracted investors from all across the world, and more are on the way. Though Bitcoin is the most well-known digital currency, there are thousands of others. 1 Cryptocurrency is one of the most innovative and intriguing asset classes available to investors. + +**Available commands** {{< toc-tree >}} diff --git a/website/content/terminal/cryptocurrency/defi/_index.md b/website/content/terminal/cryptocurrency/defi/_index.md index 093e02e215d7..c683fbd1c932 100644 --- a/website/content/terminal/cryptocurrency/defi/_index.md +++ b/website/content/terminal/cryptocurrency/defi/_index.md @@ -2,4 +2,7 @@ geekdocCollapseSection: true --- +DeFi (short for "decentralized finance") refers to financial services provided by public blockchains, most notably Ethereum. You can earn interest, borrow, lend, purchase insurance, trade derivatives, exchange assets, and more with DeFi, but it's faster and doesn't involve paperwork or a third party. DeFi is global, peer-to-peer (directly between two people, not through a centralized system), pseudonymous, and available to anyone, just like crypto in general. + +**Available commands:** {{< toc-tree >}} diff --git a/website/content/terminal/cryptocurrency/due_diligence/_index.md b/website/content/terminal/cryptocurrency/due_diligence/_index.md index 093e02e215d7..ccb1f3799fb9 100644 --- a/website/content/terminal/cryptocurrency/due_diligence/_index.md +++ b/website/content/terminal/cryptocurrency/due_diligence/_index.md @@ -1,5 +1,7 @@ --- geekdocCollapseSection: true --- +Due diligence is a process that involves doing an investigation, audit, or review to verify facts or information about a subject. Due diligence in the financial industry entails a review of financial records prior to entering into a proposed deal with another party. +**Available commands** {{< toc-tree >}} diff --git a/website/content/terminal/cryptocurrency/nft/_index.md b/website/content/terminal/cryptocurrency/nft/_index.md index 093e02e215d7..a4e7cbab7187 100644 --- a/website/content/terminal/cryptocurrency/nft/_index.md +++ b/website/content/terminal/cryptocurrency/nft/_index.md @@ -2,4 +2,7 @@ geekdocCollapseSection: true --- +A digital asset that depicts real-world elements like as art, music, in-game items, and films is known as an NFT. They're bought and traded online, often using cryptocurrency, and they're usually encoded with the same software as many other cryptos. + +**Available commands:** {{< toc-tree >}} diff --git a/website/content/terminal/cryptocurrency/onchain/_index.md b/website/content/terminal/cryptocurrency/onchain/_index.md index 093e02e215d7..2c9c5933687f 100644 --- a/website/content/terminal/cryptocurrency/onchain/_index.md +++ b/website/content/terminal/cryptocurrency/onchain/_index.md @@ -2,4 +2,7 @@ geekdocCollapseSection: true --- +On-chain analysis is a way of determining market sentiment by leveraging data from a blockchain ledger. More precisely, it entails examining transaction data and crypto wallet balances, both of which are helpful when deciding whether or not to invest. After all, if a token isn't traded and the great bulk of its circulating supply is controlled by a few large investors known as whales, investing in it is generally not a wise idea. + +**Available commands:** {{< toc-tree >}} diff --git a/website/content/terminal/cryptocurrency/overview/_index.md b/website/content/terminal/cryptocurrency/overview/_index.md index 093e02e215d7..cf01e10c0a44 100644 --- a/website/content/terminal/cryptocurrency/overview/_index.md +++ b/website/content/terminal/cryptocurrency/overview/_index.md @@ -2,4 +2,5 @@ geekdocCollapseSection: true --- +**Available commands:** {{< toc-tree >}} diff --git a/website/content/terminal/cryptocurrency/technical_analysis/_index.md b/website/content/terminal/cryptocurrency/technical_analysis/_index.md deleted file mode 100644 index 093e02e215d7..000000000000 --- a/website/content/terminal/cryptocurrency/technical_analysis/_index.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -geekdocCollapseSection: true ---- - -{{< toc-tree >}} diff --git a/website/content/terminal/cryptocurrency/tools/_index.md b/website/content/terminal/cryptocurrency/tools/_index.md index 093e02e215d7..cf01e10c0a44 100644 --- a/website/content/terminal/cryptocurrency/tools/_index.md +++ b/website/content/terminal/cryptocurrency/tools/_index.md @@ -2,4 +2,5 @@ geekdocCollapseSection: true --- +**Available commands:** {{< toc-tree >}} diff --git a/website/content/terminal/econometrics/_index.md b/website/content/terminal/econometrics/_index.md index 7607de3f17c0..3012b04c2cda 100644 --- a/website/content/terminal/econometrics/_index.md +++ b/website/content/terminal/econometrics/_index.md @@ -7,5 +7,6 @@ The menu allows the user to load in his/her own dataset(s), modify the data by ( indices, apply statistical tests (e.g. Breusch-Godfrey autocorrelation tests) as well as OLS regressions and Panel regressions (e.g. Random Effects and Fixed Effects) +**Available commands** {{< toc-tree >}} diff --git a/website/content/terminal/economy/_index.md b/website/content/terminal/economy/_index.md index 093e02e215d7..87094d817d14 100644 --- a/website/content/terminal/economy/_index.md +++ b/website/content/terminal/economy/_index.md @@ -2,4 +2,7 @@ geekdocCollapseSection: true --- +Economics is concerned with the actions and interactions of economic agents as well as the functioning of economies. Microeconomics is a branch of economics that studies the fundamental parts of the economy, such as individual agents and markets, as well as their interactions and effects. Households, businesses, buyers, and sellers are all examples of individual agents. Macroeconomics studies the economy as a system in which production, consumption, saving, and investment interact, as well as the factors that influence it, such as the use of labor, capital, and land, currency inflation, economic growth, and public policies that affect these aspects. + +**Available commands** {{< toc-tree >}} diff --git a/website/content/terminal/economy/prediction_techniques/_index.md b/website/content/terminal/economy/prediction_techniques/_index.md deleted file mode 100644 index 093e02e215d7..000000000000 --- a/website/content/terminal/economy/prediction_techniques/_index.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -geekdocCollapseSection: true ---- - -{{< toc-tree >}} diff --git a/website/content/terminal/economy/quantitative_analysis/_index.md b/website/content/terminal/economy/quantitative_analysis/_index.md deleted file mode 100644 index 093e02e215d7..000000000000 --- a/website/content/terminal/economy/quantitative_analysis/_index.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -geekdocCollapseSection: true ---- - -{{< toc-tree >}} diff --git a/website/content/terminal/etf/_index.md b/website/content/terminal/etf/_index.md index e48826afb26d..e4384375a1b0 100644 --- a/website/content/terminal/etf/_index.md +++ b/website/content/terminal/etf/_index.md @@ -1,5 +1,11 @@ --- +title: Exchange Traded Funds (ETFs) geekdocCollapseSection: true --- +In recent years, exchange-traded funds have become one of the most essential and profitable products offered for individual investors. ETFs have a number of advantages and, when used properly, can help investors accomplish their investment objectives. + +In a nutshell, an ETF is a collection of securities that may be purchased or sold on a stock exchange through a brokerage business. ETFs are available in almost every asset class imaginable, ranging from standard investments to so-called nontraditional assets such as commodities and currencies. Furthermore, new ETF formats enable investors to short markets, obtain leverage, and avoid paying short-term capital gains taxes. + +**Available commands** {{< toc-tree >}} \ No newline at end of file diff --git a/website/content/terminal/etf/disc/_index.md b/website/content/terminal/etf/disc/_index.md index e48826afb26d..eba6506f2f42 100644 --- a/website/content/terminal/etf/disc/_index.md +++ b/website/content/terminal/etf/disc/_index.md @@ -2,4 +2,5 @@ geekdocCollapseSection: true --- +**Available commands:** {{< toc-tree >}} \ No newline at end of file diff --git a/website/content/terminal/forex/_index.md b/website/content/terminal/forex/_index.md index 0a484f910965..1c93d48fb943 100644 --- a/website/content/terminal/forex/_index.md +++ b/website/content/terminal/forex/_index.md @@ -2,6 +2,11 @@ geekdocCollapseSection: true --- -## TODO: Update after refactoring +Forex trading takes place in the foreign exchange market. Currency is significant because it allows us to buy goods and services both locally and internationally. To undertake international trade and business, international currencies must be exchanged. +If you live in the United States and wish to purchase goods from Europe, you or the firm from which you purchase the goods must pay in euros (EUR). This means that the importer in the United States would have to convert the same amount of dollars (USD) into euros. + +The same is true when it comes to traveling. Because euros are not accepted in China, visitors must exchange euros for the local currency. + +**Available commands** {{< toc-tree >}} diff --git a/website/content/terminal/forex/oanda/_index.md b/website/content/terminal/forex/oanda/_index.md index 0a484f910965..3c76affdb155 100644 --- a/website/content/terminal/forex/oanda/_index.md +++ b/website/content/terminal/forex/oanda/_index.md @@ -2,6 +2,7 @@ geekdocCollapseSection: true --- -## TODO: Update after refactoring +OANDA Corporation is a foreign exchange company that provides internet-based forex trading and currency information services. +**Available commands:** {{< toc-tree >}} diff --git a/website/content/terminal/funds/_index.md b/website/content/terminal/funds/_index.md index 7e73fda8a4b0..f183dfacd0e3 100644 --- a/website/content/terminal/funds/_index.md +++ b/website/content/terminal/funds/_index.md @@ -2,6 +2,7 @@ geekdocCollapseSection: true --- -{{< toc-tree >}} +Funds are a collection of money set aside for a specific purpose. A fund can be created for a variety of reasons, such as a municipal government putting money aside to build a new civic center, a college putting money away to grant a scholarship, or an insurance company putting money aside to settle its customers' claims. -Mutual funds +**Available commands** +{{< toc-tree >}} diff --git a/website/content/terminal/jupyter/_index.md b/website/content/terminal/jupyter/_index.md index 2905b248408f..ff2f89a9941a 100644 --- a/website/content/terminal/jupyter/_index.md +++ b/website/content/terminal/jupyter/_index.md @@ -2,6 +2,7 @@ geekdocCollapseSection: true --- -{{< toc-tree >}} +Create notebook templates (through papermill) which can be run on different tickers. This level of automation allows speeding up the development of your investment thesis and reduce human error. -Jupyter +**Available commands** +{{< toc-tree >}} diff --git a/website/content/terminal/jupyter/dashboards/_index.md b/website/content/terminal/jupyter/dashboards/_index.md index 790b9f1d45ed..eba6506f2f42 100644 --- a/website/content/terminal/jupyter/dashboards/_index.md +++ b/website/content/terminal/jupyter/dashboards/_index.md @@ -2,6 +2,5 @@ geekdocCollapseSection: true --- -{{< toc-tree >}} - -Dashboards \ No newline at end of file +**Available commands:** +{{< toc-tree >}} \ No newline at end of file diff --git a/website/content/terminal/portfolio/_index.md b/website/content/terminal/portfolio/_index.md index 9dc72465fbe0..7d4c5562bc67 100644 --- a/website/content/terminal/portfolio/_index.md +++ b/website/content/terminal/portfolio/_index.md @@ -2,28 +2,11 @@ geekdocCollapseSection: true --- -{{< toc-tree >}} +A **Portfolio** is a collection of financial assets such as stocks, bonds, commodities, cash, and cash equivalents, as well as closed-end funds and exchange-traded funds (ETFs). Stocks, bonds, and cash are commonly seen to be the foundation of a portfolio. This isn't always the case, but it doesn't have to be. Real estate, art, and private investments are all examples of assets that can be found in a portfolio. -```text -(✨) / $ portfolio +**Portfolio Attribution** is a complex way for evaluating a portfolio or fund manager's performance. It aims to objectively assess components of an active fund manager's investment selections and decisions—and to discover sources of excess returns, especially when contrasted to an index or other benchmark. It is also known as "return attribution" or "performance attribution." This can be a useful technique for portfolio managers and investment firms to evaluate strategies. For investors, attribution analysis is a useful tool for evaluating fund or money manager performance. -What do you want to do? +**Portfolio optimization** is usually referred to as Modern Portfolio Theory (MPT). This is started by the famous paper from Harry Markowitz that shows “that the performance of an individual stock is not as important as the performance and composition of an investor's entire portfolio.” The biggest criticism of the MPT that if two portfolios have equal variance and equal return, the MPT is indifferent what portfolio you choose even though the downside risk of one portfolio could be much higher than that of the other, meaning significant losses can be sporadic (but large) for one portfolio while frequent (but of smaller size) for the other while having the same variance. This is where Post-Modern Portfolio Theory (PMPT) makes proper adjustments for. The main difference: “The differences in risk, as defined by the standard deviation of returns, between the PMPT and the MPT is the key factor in portfolio construction. The MPT assumes symmetrical risk whereas the PMPT assumes asymmetrical risk. Downside risk is measured by target semi-deviation, termed downside deviation, and captures what investors fear most: having negative returns.” This goes deeper into the concept of Utility and Risk Aversion where the perceived negative impact of -10% is larger than the perceived positive impact of 10%. -> bro brokers holdings, supports: robinhood, ally, degiro, coinbase -> po portfolio optimization, optimal portfolio weights from pyportfolioopt -> pa portfolio analysis, analyse portfolios - -Portfolio: - load load data into the portfolio - save save your portfolio for future use - show show existing transactions - add add a security to your portfolio - rmv remove a security from your portfolio - -Reports: - ar annual report for performance of a given portfolio - -Graphs: - rmr graph your returns versus the market's returns - al displays the allocation of the portfolio -``` +**Available commands** +{{< toc-tree >}} \ No newline at end of file diff --git a/website/content/terminal/portfolio/brokers/_index.md b/website/content/terminal/portfolio/brokers/_index.md index 0a484f910965..39adf9570d70 100644 --- a/website/content/terminal/portfolio/brokers/_index.md +++ b/website/content/terminal/portfolio/brokers/_index.md @@ -2,6 +2,9 @@ geekdocCollapseSection: true --- -## TODO: Update after refactoring +A broker is a person or company who works as a go-between for an investor and a securities exchange. Individual traders and investors require the services of exchange members since securities exchanges only accept orders from persons or organizations that are members of the exchange. +Brokers provide that service and are paid in a variety of methods, including commissions, fees, and payments from the exchange itself. Investopedia examines all of the top brokers on a regular basis and keeps a list of the finest online brokers and trading platforms to assist investors in determining which broker is right for them. + +**Available commands:** {{< toc-tree >}} diff --git a/website/content/terminal/resources/_index.md b/website/content/terminal/resources/_index.md deleted file mode 100644 index 0a484f910965..000000000000 --- a/website/content/terminal/resources/_index.md +++ /dev/null @@ -1,7 +0,0 @@ ---- -geekdocCollapseSection: true ---- - -## TODO: Update after refactoring - -{{< toc-tree >}} diff --git a/website/content/terminal/stocks/backtesting/_index.md b/website/content/terminal/stocks/backtesting/_index.md index 093e02e215d7..984b0f58bcfb 100755 --- a/website/content/terminal/stocks/backtesting/_index.md +++ b/website/content/terminal/stocks/backtesting/_index.md @@ -1,5 +1,9 @@ --- geekdocCollapseSection: true --- +Backtesting allows analysts to test and compare different trading strategies without risking any money. According to the hypothesis, if their strategy failed in the past, it is unlikely to succeed in the future (and vice versa). During testing, the total profitability and the level of risk taken are the two most important factors to consider. +A backtest, on the other hand, examines a strategy's performance in relation to a variety of variables. A successful backtest will show traders a technique that has previously produced positive outcomes. While the market never moves in the same way twice, backtesting is based on the notion that equities follow similar patterns in the past. + +**Available commands:** {{< toc-tree >}} diff --git a/website/content/terminal/stocks/due_diligence/_index.md b/website/content/terminal/stocks/due_diligence/_index.md index 093e02e215d7..f9f437398f2b 100755 --- a/website/content/terminal/stocks/due_diligence/_index.md +++ b/website/content/terminal/stocks/due_diligence/_index.md @@ -2,4 +2,7 @@ geekdocCollapseSection: true --- +Due diligence is a process that involves doing an investigation, audit, or review to verify facts or information about a subject. Due diligence in the financial industry entails a review of financial records prior to entering into a proposed deal with another party. + +**Available commands** {{< toc-tree >}} diff --git a/website/content/terminal/stocks/fundamental_analysis/_index.md b/website/content/terminal/stocks/fundamental_analysis/_index.md index 093e02e215d7..dd672994aedc 100755 --- a/website/content/terminal/stocks/fundamental_analysis/_index.md +++ b/website/content/terminal/stocks/fundamental_analysis/_index.md @@ -2,4 +2,9 @@ geekdocCollapseSection: true --- +Fundamental analysis (FA) is a way of determining the intrinsic value of a securities by looking at connected economic and financial elements. Fundamental analysts look at everything that can influence the value of a security, from macroeconomic issues like the state of the economy and industry circumstances to microeconomic elements like the company's management performance. + +The ultimate goal is to arrive at a number that can be compared to the present price of a security to determine whether it is undervalued or overvalued. + +**Available commands** {{< toc-tree >}} diff --git a/website/content/terminal/stocks/government/_index.md b/website/content/terminal/stocks/government/_index.md index 093e02e215d7..5ff215d3a11f 100755 --- a/website/content/terminal/stocks/government/_index.md +++ b/website/content/terminal/stocks/government/_index.md @@ -2,4 +2,9 @@ geekdocCollapseSection: true --- +A government is the system or collection of individuals in charge of governing a formally constituted community, such as a state. In its broadest sense, government is made up of three parts: legislature, executive branch, and judiciary. Government is both a tool of enforcing organizational policies and a system for defining policy. Many governments have a constitution, which is a statement of the government's guiding ideas and ideology. + +Within this menu, the actions regarding lobbying, governmental contracts as well as governmental transactions are depicted. + +**Available commands:** {{< toc-tree >}} diff --git a/website/content/terminal/stocks/insider/_index.md b/website/content/terminal/stocks/insider/_index.md index 093e02e215d7..192082900036 100755 --- a/website/content/terminal/stocks/insider/_index.md +++ b/website/content/terminal/stocks/insider/_index.md @@ -2,4 +2,9 @@ geekdocCollapseSection: true --- +Insider trading is when someone with non-public, substantial information about a public company's shares trades in that stock for whatever purpose. Depending on when the insider makes the trade, insider trading can be either unlawful or legal. + +When material knowledge is still classified as confidential, insider trading is prohibited, and this type of insider trading carries severe penalties. + +**Available commands:** {{< toc-tree >}} diff --git a/website/content/terminal/stocks/options/_index.md b/website/content/terminal/stocks/options/_index.md index 093e02e215d7..37e6e7e3e017 100644 --- a/website/content/terminal/stocks/options/_index.md +++ b/website/content/terminal/stocks/options/_index.md @@ -1,5 +1,9 @@ --- geekdocCollapseSection: true --- +Options are in essence contracts between two parties that grant holders the right to buy or sell an underlying asset at a certain price within a certain time frame. +The underlying asset, which could be equities, bonds, currency, interest rates, market indexes, exchange-traded funds (ETFs), or futures contracts, determines the value of an option. Options are securities in and of themselves, similar to stocks and bonds, but they are referred to as derivatives because their value is derived from something else. + +**Available commands:** {{< toc-tree >}} diff --git a/website/content/terminal/stocks/research/_index.md b/website/content/terminal/stocks/research/_index.md index 093e02e215d7..56816c3537ee 100755 --- a/website/content/terminal/stocks/research/_index.md +++ b/website/content/terminal/stocks/research/_index.md @@ -2,4 +2,7 @@ geekdocCollapseSection: true --- +The research menu provides a variety of Financial sources that can be used to further delve into the chosen stock. + +**Available commands:** {{< toc-tree >}} diff --git a/website/content/terminal/stocks/sia/_index.md b/website/content/terminal/stocks/sia/_index.md index 3bc6bb9bb94c..2231b16cb6d5 100644 --- a/website/content/terminal/stocks/sia/_index.md +++ b/website/content/terminal/stocks/sia/_index.md @@ -1,45 +1,10 @@ --- +title: Sector & Industry Analysis (SIA) geekdocCollapseSection: true --- +A sector analysis is a study of the economic and financial state and prospects of a certain economic sector. An investor can use sector analysis to make a prediction about how well companies in the sector will perform. Investors that specialize in a specific sector or who utilize a top-down or sector rotation approach to investing generally use sector analysis. -{{< toc-tree >}} +The most promising sectors are chosen first under the top-down strategy, and then the investor evaluates stocks within that sector to choose which ones will be purchased. Investing in specific equities or using sector-based exchange-traded funds can be used to implement a sector rotation strategy (ETFs). -```text -┌───────────────────────────────────────────────────────────────────────────────────────────────── Stocks - Sector and Industry Analysis ──────────────────────────────────────────────────────────────────────────────────────────────────┐ -│ │ -│ load load a specific ticker and all it's corresponding parameters │ -│ │ -│ clear clear all or one of industry, sector, country and market cap parameters │ -│ industry see existing industries, or set industry if arg specified │ -│ sector see existing sectors, or set sector if arg specified │ -│ country see existing countries, or set country if arg specified │ -│ mktcap set mktcap between nano, micro, small, mid, large or mega │ -│ exchange revert exclude international exchanges flag │ -│ period set period between annual, quarterly or trailing [StockAnalyis] │ -│ │ -│ Industry : Auto Manufacturers │ -│ Sector : Consumer Cyclical │ -│ Country : United States │ -│ Market Cap : Large │ -│ Exclude Exchanges : True │ -│ Period : Annual │ -│ │ -│ Statistics │ -│ cps companies per Sector based on Country and Market Cap │ -│ cpic companies per Industry based on Country and Market Cap │ -│ cpis companies per Industry based on Sector and Market Cap │ -│ cpcs companies per Country based on Sector and Market Cap │ -│ cpci companies per Country based on Industry and Market Cap │ -│ │ -│ Financials [Yahoo Finance] │ -│ sama see all metrics available │ -│ metric visualise financial metric across filters selected │ -│ Financials [StockAnalyis] │ -│ satma see all metrics available over time │ -│ vis visualise financial metric across filters selected │ -│ │ -│ Returned tickers: │ -│ > ca take these to comparison analysis menu │ -│ │ -└───────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────── Gamestonk Terminal ─┘ -``` +**Available commands** +{{< toc-tree >}} diff --git a/website/data/menu/main.yml b/website/data/menu/main.yml index 1dec00992044..d1a16ccdd94d 100755 --- a/website/data/menu/main.yml +++ b/website/data/menu/main.yml @@ -892,7 +892,7 @@ main: - name: newest ref: "/terminal/cryptocurrency/nft/newest" - name: technical analysis - ref: "/terminal/cryptocurrency/technical_analysis" + ref: "/terminal/common/technical_analysis" sub: - name: ema ref: "/terminal/common/technical_analysis/ema" @@ -1125,6 +1125,82 @@ main: ref: "/terminal/etf/pir" - name: compare ref: "/terminal/etf/compare" + - name: technical analysis + ref: "/terminal/common/technical_analysis" + sub: + - name: view + ref: "/terminal/common/technical_analysis/view" + - name: tv + ref: "/terminal/common/technical_analysis/tv" + - name: summary + ref: "/terminal/common/technical_analysis/summary" + - name: recom + ref: "/terminal/common/technical_analysis/recom" + - name: ema + ref: "/terminal/common/technical_analysis/ema" + - name: sma + ref: "/terminal/common/technical_analysis/sma" + - name: wma + ref: "/terminal/common/technical_analysis/wma" + - name: hma + ref: "/terminal/common/technical_analysis/hma" + - name: zlma + ref: "/terminal/common/technical_analysis/zlma" + - name: vwap + ref: "/terminal/common/technical_analysis/vwap" + - name: cci + ref: "/terminal/common/technical_analysis/cci" + - name: macd + ref: "/terminal/common/technical_analysis/macd" + - name: rsi + ref: "/terminal/common/technical_analysis/rsi" + - name: stoch + ref: "/terminal/common/technical_analysis/stoch" + - name: fisher + ref: "/terminal/common/technical_analysis/fisher" + - name: cg + ref: "/terminal/common/technical_analysis/cg" + - name: adx + ref: "/terminal/common/technical_analysis/adx" + - name: aroon + ref: "/terminal/common/technical_analysis/aroon" + - name: bbands + ref: "/terminal/common/technical_analysis/bbands" + - name: donchian + ref: "/terminal/common/technical_analysis/donchian" + - name: kc + ref: "/terminal/common/technical_analysis/kc" + - name: ad + ref: "/terminal/common/technical_analysis/ad" + - name: adosc + ref: "/terminal/common/technical_analysis/adosc" + - name: obv + ref: "/terminal/common/technical_analysis/obv" + - name: fib + ref: "/terminal/common/technical_analysis/fib" + - name: prediction techniques + ref: "/terminal/common/prediction_techniques" + sub: + - name: ets + ref: "/terminal/common/prediction_techniques/ets" + - name: knn + ref: "/terminal/common/prediction_techniques/knn" + - name: regression + ref: "/terminal/common/prediction_techniques/regression" + - name: arima + ref: "/terminal/common/prediction_techniques/arima" + - name: mlp + ref: "/terminal/common/prediction_techniques/mlp" + - name: rnn + ref: "/terminal/common/prediction_techniques/rnn" + - name: lstm + ref: "/terminal/common/prediction_techniques/lstm" + - name: conv1d + ref: "/terminal/common/prediction_techniques/conv1d" + - name: mc + ref: "/terminal/common/prediction_techniques/mc" + - name: expo + ref: "/terminal/common/prediction_techniques/expo" - name: funds ref: "/terminal/funds" sub: @@ -1415,6 +1491,181 @@ main: ref: "/terminal/jupyter/dashboards/shortdata" - name: "reports" ref: "/terminal/jupyter/reports" + - name: common + ref: "/terminal/common" + sub: + - name: technical analysis + ref: "/terminal/common/technical_analysis" + sub: + - name: view + ref: "/terminal/common/technical_analysis/view" + - name: tv + ref: "/terminal/common/technical_analysis/tv" + - name: summary + ref: "/terminal/common/technical_analysis/summary" + - name: recom + ref: "/terminal/common/technical_analysis/recom" + - name: ema + ref: "/terminal/common/technical_analysis/ema" + - name: sma + ref: "/terminal/common/technical_analysis/sma" + - name: wma + ref: "/terminal/common/technical_analysis/wma" + - name: hma + ref: "/terminal/common/technical_analysis/hma" + - name: zlma + ref: "/terminal/common/technical_analysis/zlma" + - name: vwap + ref: "/terminal/common/technical_analysis/vwap" + - name: cci + ref: "/terminal/common/technical_analysis/cci" + - name: macd + ref: "/terminal/common/technical_analysis/macd" + - name: rsi + ref: "/terminal/common/technical_analysis/rsi" + - name: stoch + ref: "/terminal/common/technical_analysis/stoch" + - name: fisher + ref: "/terminal/common/technical_analysis/fisher" + - name: cg + ref: "/terminal/common/technical_analysis/cg" + - name: adx + ref: "/terminal/common/technical_analysis/adx" + - name: aroon + ref: "/terminal/common/technical_analysis/aroon" + - name: bbands + ref: "/terminal/common/technical_analysis/bbands" + - name: donchian + ref: "/terminal/common/technical_analysis/donchian" + - name: kc + ref: "/terminal/common/technical_analysis/kc" + - name: ad + ref: "/terminal/common/technical_analysis/ad" + - name: adosc + ref: "/terminal/common/technical_analysis/adosc" + - name: obv + ref: "/terminal/common/technical_analysis/obv" + - name: fib + ref: "/terminal/common/technical_analysis/fib" + - name: behavioural analysis + ref: "/terminal/common/behavioural_analysis" + sub: + - name: headlines + ref: "/terminal/common/behavioural_analysis/headlines" + - name: stats + ref: "/terminal/common/behavioural_analysis/stats" + - name: snews + ref: "/terminal/common/behavioural_analysis/snews" + - name: interest + ref: "/terminal/common/behavioural_analysis/interest" + - name: wsb + ref: "/terminal/common/behavioural_analysis/wsb" + - name: watchlist + ref: "/terminal/common/behavioural_analysis/watchlist" + - name: popular + ref: "/terminal/common/behavioural_analysis/popular" + - name: spac_c + ref: "/terminal/common/behavioural_analysis/spac_c" + - name: spac + ref: "/terminal/common/behavioural_analysis/spac" + - name: getdd + ref: "/terminal/common/behavioural_analysis/getdd" + - name: reddit_sent + ref: "/terminal/common/behavioural_analysis/reddit_sent" + - name: bullbear + ref: "/terminal/common/behavioural_analysis/bullbear" + - name: messages + ref: "/terminal/common/behavioural_analysis/messages" + - name: trending + ref: "/terminal/common/behavioural_analysis/trending" + - name: stalker + ref: "/terminal/common/behavioural_analysis/stalker" + - name: infer + ref: "/terminal/common/behavioural_analysis/infer" + - name: sentiment + ref: "/terminal/common/behavioural_analysis/sentiment" + - name: mentions + ref: "/terminal/common/behavioural_analysis/mentions" + - name: regions + ref: "/terminal/common/behavioural_analysis/regions" + - name: queries + ref: "/terminal/common/behavioural_analysis/queries" + - name: rise + ref: "/terminal/common/behavioural_analysis/rise" + - name: hist + ref: "/terminal/common/behavioural_analysis/hist" + - name: trend + ref: "/terminal/common/behavioural_analysis/trend" + - name: jcdr + ref: "/terminal/common/behavioural_analysis/jcdr" + - name: jctr + ref: "/terminal/common/behavioural_analysis/jctr" + - name: quantitative analysis + ref: "/terminal/common/quantitative_analysis" + sub: + - name: load + ref: "/terminal/common/quantitative_analysis/load" + - name: pick + ref: "/terminal/common/quantitative_analysis/pick" + - name: summary + ref: "/terminal/common/quantitative_analysis/summary" + - name: normality + ref: "/terminal/common/quantitative_analysis/normality" + - name: unitroot + ref: "/terminal/common/quantitative_analysis/unitroot" + - name: hist + ref: "/terminal/common/quantitative_analysis/hist" + - name: cdf + ref: "/terminal/common/quantitative_analysis/cdf" + - name: bw + ref: "/terminal/common/quantitative_analysis/bw" + - name: acf + ref: "/terminal/common/quantitative_analysis/acf" + - name: qqplot + ref: "/terminal/common/quantitative_analysis/qqplot" + - name: rolling + ref: "/terminal/common/quantitative_analysis/rolling" + - name: spread + ref: "/terminal/common/quantitative_analysis/spread" + - name: quantile + ref: "/terminal/common/quantitative_analysis/quantile" + - name: skew + ref: "/terminal/common/quantitative_analysis/skew" + - name: kurtosis + ref: "/terminal/common/quantitative_analysis/kurtosis" + - name: decompose + ref: "/terminal/common/quantitative_analysis/decompose" + - name: cusum + ref: "/terminal/common/quantitative_analysis/cusum" + - name: capm + ref: "/terminal/common/quantitative_analysis/capm" + - name: line + ref: "/terminal/common/quantitative_analysis/line" + - name: raw + ref: "/terminal/common/quantitative_analysis/raw" + - name: prediction techniques + ref: "/terminal/common/prediction_techniques" + sub: + - name: ets + ref: "/terminal/common/prediction_techniques/ets" + - name: knn + ref: "/terminal/common/prediction_techniques/knn" + - name: regression + ref: "/terminal/common/prediction_techniques/regression" + - name: arima + ref: "/terminal/common/prediction_techniques/arima" + - name: mlp + ref: "/terminal/common/prediction_techniques/mlp" + - name: rnn + ref: "/terminal/common/prediction_techniques/rnn" + - name: lstm + ref: "/terminal/common/prediction_techniques/lstm" + - name: conv1d + ref: "/terminal/common/prediction_techniques/conv1d" + - name: mc + ref: "/terminal/common/prediction_techniques/mc" + - name: expo + ref: "/terminal/common/prediction_techniques/expo" - name: "OpenBB Python API" ref: "/api" - name: "OpenBB Bots" diff --git a/website/public/gst_logo_lockup_rGreen_with_letters.png b/website/public/gst_logo_lockup_rGreen_with_letters.png deleted file mode 100644 index a3e6d6782f64..000000000000 Binary files a/website/public/gst_logo_lockup_rGreen_with_letters.png and /dev/null differ diff --git a/website/public/gst_logo_lockup_rGreen_with_letters_hu1e0bda937c51fd307bb3207c0afd39b9_86589_1200x0_resize_box_3.png b/website/public/gst_logo_lockup_rGreen_with_letters_hu1e0bda937c51fd307bb3207c0afd39b9_86589_1200x0_resize_box_3.png deleted file mode 100644 index 89a7fa84c1c8..000000000000 Binary files a/website/public/gst_logo_lockup_rGreen_with_letters_hu1e0bda937c51fd307bb3207c0afd39b9_86589_1200x0_resize_box_3.png and /dev/null differ diff --git a/website/public/gst_logo_lockup_rGreen_with_letters_hu1e0bda937c51fd307bb3207c0afd39b9_86589_1800x0_resize_box_3.png b/website/public/gst_logo_lockup_rGreen_with_letters_hu1e0bda937c51fd307bb3207c0afd39b9_86589_1800x0_resize_box_3.png deleted file mode 100644 index cd41d3d5d0a3..000000000000 Binary files a/website/public/gst_logo_lockup_rGreen_with_letters_hu1e0bda937c51fd307bb3207c0afd39b9_86589_1800x0_resize_box_3.png and /dev/null differ diff --git a/website/public/gst_logo_lockup_rGreen_with_letters_hu1e0bda937c51fd307bb3207c0afd39b9_86589_320x0_resize_box_3.png b/website/public/gst_logo_lockup_rGreen_with_letters_hu1e0bda937c51fd307bb3207c0afd39b9_86589_320x0_resize_box_3.png deleted file mode 100644 index 22d6047f8504..000000000000 Binary files a/website/public/gst_logo_lockup_rGreen_with_letters_hu1e0bda937c51fd307bb3207c0afd39b9_86589_320x0_resize_box_3.png and /dev/null differ diff --git a/website/public/gst_logo_lockup_rGreen_with_letters_hu1e0bda937c51fd307bb3207c0afd39b9_86589_600x0_resize_box_3.png b/website/public/gst_logo_lockup_rGreen_with_letters_hu1e0bda937c51fd307bb3207c0afd39b9_86589_600x0_resize_box_3.png deleted file mode 100644 index 1b0ec2ef7bd9..000000000000 Binary files a/website/public/gst_logo_lockup_rGreen_with_letters_hu1e0bda937c51fd307bb3207c0afd39b9_86589_600x0_resize_box_3.png and /dev/null differ diff --git a/website/public/main-5e7fc0c942.min.css b/website/public/main-5e7fc0c942.min.css index 5518963ce75f..98e0e39b6e07 100644 --- a/website/public/main-5e7fc0c942.min.css +++ b/website/public/main-5e7fc0c942.min.css @@ -735,6 +735,7 @@ code { h1, h2, h3, + h4, p, tr, li, diff --git a/website/public/gst_logo_green.png b/website/public/openbb_logo.png similarity index 100% rename from website/public/gst_logo_green.png rename to website/public/openbb_logo.png diff --git a/website/public/stocks/candle/index.html b/website/public/stocks/candle/index.html deleted file mode 100644 index d5aa87c7992c..000000000000 --- a/website/public/stocks/candle/index.html +++ /dev/null @@ -1,706 +0,0 @@ - - - - - - - - - - - - - - - - - Candle | OpenBB Terminal - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - -
-
- - - - - - - OpenBB Terminal - - - - - - - -
-
- - -
- - - - -
- - - - - - - - - - - -
- -
- -
    - - - - - - - - - - - - - - - - - - -
  1. OpenBB Terminal
  2. /
  3. Stocks
  4. /
  5. Candle
    6. - - - - - - -
-
- - -
- - - - Edit this page - - -
- -
- -
-

Candle

- - - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - Load - - - - - Discover Stocks - - - -
- -
-
- - - -
- - - - - - - - - - - - - - - - diff --git a/website/public/stocks/candle/index.xml b/website/public/stocks/candle/index.xml deleted file mode 100644 index c7696f5f9a09..000000000000 --- a/website/public/stocks/candle/index.xml +++ /dev/null @@ -1,9 +0,0 @@ - - - - OpenBB Terminal - https://OpenBBTerminal.github.io/OpenBBTerminal/stocks/candle/ - Recent content on OpenBB Terminal - Hugo -- gohugo.io - - diff --git a/website/public/stocks/discover_stocks/index.html b/website/public/stocks/discover_stocks/index.html deleted file mode 100644 index f28be052fe4b..000000000000 --- a/website/public/stocks/discover_stocks/index.html +++ /dev/null @@ -1,742 +0,0 @@ - - - - - - - - - - - - - - - - - Discover Stocks | OpenBB Terminal - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - -
-
- - - - - - - OpenBB Terminal - - - - - - - -
-
- - -
- - - - -
- - - - - - - - - - - -
- -
- -
    - - - - - - - - - - - - - - - - - - -
  1. OpenBB Terminal
  2. /
  3. Stocks
  4. /
  5. Discover Stocks
    6. - - - - - - -
-
- - -
- - - - Edit this page - - -
- -
- -
-

Discover Stocks

- - - -
- -
    - - - -
  • - - - Ipo - - - - - -
    • - - - -
  • - - - Map - - - - - -
    • - - - -
- -
- - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - Candle - - - - - ipo - - - -
- -
-
- - - -
- - - - - - - - - - - - - - - - diff --git a/website/public/stocks/discover_stocks/index.xml b/website/public/stocks/discover_stocks/index.xml deleted file mode 100644 index 239c518d1547..000000000000 --- a/website/public/stocks/discover_stocks/index.xml +++ /dev/null @@ -1,9 +0,0 @@ - - - - OpenBB Terminal - https://OpenBBTerminal.github.io/OpenBBTerminal/stocks/discover_stocks/ - Recent content on OpenBB Terminal - Hugo -- gohugo.io - - diff --git a/website/public/stocks/discover_stocks/ipo/index.html b/website/public/stocks/discover_stocks/ipo/index.html deleted file mode 100644 index 8198107346ce..000000000000 --- a/website/public/stocks/discover_stocks/ipo/index.html +++ /dev/null @@ -1,715 +0,0 @@ - - - - - - - - - - - - - - - - - Ipo | OpenBB Terminal - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - -
-
- - - - - - - OpenBB Terminal - - - - - - - -
-
- - -
- - - - -
- - - - - - - - - - - -
- -
- -
    - - - - - - - - - - - - - - - - - - - - - - - - -
  1. OpenBB Terminal
  2. /
  3. Stocks
  4. /
  5. Discover Stocks
  6. /
  7. Ipo
    8. - - - - - - - - -
-
- - -
- - - - Edit this page - - -
- -
- -
-

Ipo

- 
usage: ipo [-p PAST_DAYS] [-f FUTURE_DAYS]
-

Past and future IPOs. [Source: https://finnhub.io]

-
    -
  • -p : Number of past days to look for IPOs. Default 0.
    • -
  • -f : Number of future days to look for IPOs. Default 10.
    • -
-Captura de ecrã 2021-05-03, às 12 54 44 - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - Discover Stocks - - - - - map - - - -
- -
-
- - - -
- - - - - - - - - - - - - - - - diff --git a/website/public/stocks/discover_stocks/ipo/index.xml b/website/public/stocks/discover_stocks/ipo/index.xml deleted file mode 100644 index af9d71f7a03e..000000000000 --- a/website/public/stocks/discover_stocks/ipo/index.xml +++ /dev/null @@ -1,9 +0,0 @@ - - - - OpenBB Terminal - https://OpenBBTerminal.github.io/OpenBBTerminal/stocks/discover_stocks/ipo/ - Recent content on OpenBB Terminal - Hugo -- gohugo.io - - diff --git a/website/public/stocks/discover_stocks/map/index.html b/website/public/stocks/discover_stocks/map/index.html deleted file mode 100644 index f12cbbd18972..000000000000 --- a/website/public/stocks/discover_stocks/map/index.html +++ /dev/null @@ -1,709 +0,0 @@ - - - - - - - - - - - - - - - - - Map | OpenBB Terminal - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - -
-
- - - - - - - OpenBB Terminal - - - - - - - -
-
- - -
- - - - -
- - - - - - - - - - - -
- -
- -
    - - - - - - - - - - - - - - - - - - - - - - - - -
  1. OpenBB Terminal
  2. /
  3. Stocks
  4. /
  5. Discover Stocks
  6. /
  7. Map
    8. - - - - - - - - -
-
- - -
- - - - Edit this page - - -
- -
- -
-

Map

- - - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - ipo - - - - - - -
- -
-
- - - -
- - - - - - - - - - - - - - - - diff --git a/website/public/stocks/discover_stocks/map/index.xml b/website/public/stocks/discover_stocks/map/index.xml deleted file mode 100644 index 49abda578098..000000000000 --- a/website/public/stocks/discover_stocks/map/index.xml +++ /dev/null @@ -1,9 +0,0 @@ - - - - OpenBB Terminal - https://OpenBBTerminal.github.io/OpenBBTerminal/stocks/discover_stocks/map/ - Recent content on OpenBB Terminal - Hugo -- gohugo.io - - diff --git a/website/public/stocks/index.html b/website/public/stocks/index.html deleted file mode 100644 index d09baeea7925..000000000000 --- a/website/public/stocks/index.html +++ /dev/null @@ -1,779 +0,0 @@ - - - - - - - - - - - - - - - - - Stocks | OpenBB Terminal - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - -
-
- - - - - - - OpenBB Terminal - - - - - - - -
-
- - -
- - - - -
- - - - - - - - - - - -
- -
- -
    - - - - - - - - - - - - -
  1. OpenBB Terminal
  2. /
  3. Stocks
    4. - - - - -
-
- - -
- - - - Edit this page - - -
- -
- -
-

Stocks

- - - -
- -
    - - - -
  • - - - Candle - - - - - -
    • - - - -
  • - - - Discover Stocks - - - - - - -
      - - - -
    • - - - Ipo - - - - - -
      • - - - -
    • - - - Map - - - - - -
      • - - - -
    - - -
    • - - - -
  • - - - Load - - - - - -
    • - - - -
- -
- - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - Load - - - -
- -
-
- - - -
- - - - - - - - - - - - - - - - diff --git a/website/public/stocks/index.xml b/website/public/stocks/index.xml deleted file mode 100644 index 6551066630cf..000000000000 --- a/website/public/stocks/index.xml +++ /dev/null @@ -1,9 +0,0 @@ - - - - OpenBB Terminal - https://OpenBBTerminal.github.io/OpenBBTerminal/stocks/ - Recent content on OpenBB Terminal - Hugo -- gohugo.io - - diff --git a/website/public/stocks/load/index.html b/website/public/stocks/load/index.html deleted file mode 100644 index e44804793529..000000000000 --- a/website/public/stocks/load/index.html +++ /dev/null @@ -1,706 +0,0 @@ - - - - - - - - - - - - - - - - - Load | OpenBB Terminal - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - -
-
- - - - - - - OpenBB Terminal - - - - - - - -
-
- - -
- - - - -
- - - - - - - - - - - -
- -
- -
    - - - - - - - - - - - - - - - - - - -
  1. OpenBB Terminal
  2. /
  3. Stocks
  4. /
  5. Load
    6. - - - - - - -
-
- - -
- - - - Edit this page - - -
- -
- -
-

Load

- - - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - Stocks - - - - - Candle - - - -
- -
-
- - - -
- - - - - - - - - - - - - - - - diff --git a/website/public/stocks/load/index.xml b/website/public/stocks/load/index.xml deleted file mode 100644 index eac2dddee644..000000000000 --- a/website/public/stocks/load/index.xml +++ /dev/null @@ -1,9 +0,0 @@ - - - - OpenBB Terminal - https://OpenBBTerminal.github.io/OpenBBTerminal/stocks/load/ - Recent content on OpenBB Terminal - Hugo -- gohugo.io - - diff --git a/website/static/gst_logo_green.png b/website/static/openbb_logo.png similarity index 100% rename from website/static/gst_logo_green.png rename to website/static/openbb_logo.png