siat 3.4.6__py3-none-any.whl → 3.4.7__py3-none-any.whl

{siat-3.4.6.dist-info → siat-3.4.7.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: siat
-Version: 3.4.6
+Version: 3.4.7
 Summary: Securities Investment Analysis Tools (siat)
 Home-page: https://pypi.org/project/siat/
 Author: Prof. WANG Dehong, International Business School, Beijing Foreign Studies University
@@ -35,34 +35,37 @@ Requires-Dist: itables
 Requires-Dist: py-trans
 Requires-Dist: bottleneck
 
-# Welcome to the Magic World of siat
+<center><font size=6>Welcome to SIAT
 
-# Version history
-Current version: 3.2
-
-This version unifies the architecture of stock, bond and investment fund together.
+# What is siat?
+siat is a Python plug-in for security investment analysis, specially designed for teaching and learning purposes in universities for undergraduate and postgraduate programs.
 
-The unifcation not only makes it convenient to analyze stock, bond and investment fund in same scripts, but also make it easier to construct an investment portfolio with stock, bond and investment fund as components.
+Most of the results by siat are in the form of figures and/or tables.
+# Version history
 Version structure: X.Y.Z
 
 X is the major version for architecture upgrade only.
 Y is the functional version for functional enhancement.
 Z is the minor version just for bug fixing.
-# What is siat?
-siat is a Python plug-in, which stands for security investment analysis toolkit. 
-
-It is specially designed for teaching and learning purposes on security investment in universities for undergraduate and postgraduate programs.
 # Quick examples of using siat
 
 
 ```python
+# Enable siat
 from siat import *
 ```
 
+
+```python
+# Set language to English, default is Chinese
+set_language("English")
+```
+
 ## Example 1: Apple stock price for the recent month
 
 
 ```python
+# Simple way: show Apple's stock price in recent month
 apple=security_trend("AAPL")
 ```
 You may expect to more information, such as price trend in a recent year (MRY), with the high/low point, current price and average price, like below:
@@ -96,6 +99,7 @@ comp=security_trend(['AAPL','MSFT','NVDA'],
 apple=security_technical("AAPL",
                          technical="Bollinger",
                          start="MRQ",
+                         facecolor="white",
                          loc1="upper left", loc2="lower right")
 ```
 
@@ -111,7 +115,7 @@ apple=security_technical2("AAPL",
                          loc1="upper left", loc2="lower right")
 ```
 
-# What sorts of security product does siat support?
+# What security product does siat support?
 1. Public company profile:  world-wide
 2. Stock & stock market index: world-wide
 3. Stock valuation: primarily in China (mainland and HK) and the U.S.
@@ -125,9 +129,9 @@ apple=security_technical2("AAPL",
 11. Balance sheet: in China (full function) and world-wide (basic function)
 12. Income statement: in China mainland (full function) and world-wide (basic function)
 13. Cash flow statement: in China mainland (full function) and world-wide (basic function)
-14. Du Pont Identity:  world-wide
+14. DuPont Identity: world-wide
 15. Sector trend and valuation: primarily in China
-# What sorts of analytical methodology does siat support?
+# What analytical methodology does siat support?
 1. Trend analysis
 2. Panel comparation
 3. Return analysis: rolling returns, holding period returns
@@ -184,9 +188,21 @@ upgrade_siat(alternative="tsinghua")
 
 upgrade_siat(alternative="alibaba")
 
-If the above methods do not work for you, you have to goto the traditional ways to use command-line script, such as:
+If the above methods do not work for your environment, you have to goto the traditional ways to use command-line script, such as:
 
 pip install --upgrade siat
+
+*** For users in China
+The pypi mirror websites may provide siat installing and upgrading in a much faster speed in the following commands: taking aliyun as an example
+
+pip install siat -i https://mirrors.aliyun.com/pypi/simple/
+
+pip install --upgrade siat https://mirrors.aliyun.com/pypi/simple/
+
+*** Warning
+1. The pip command itself may need upgrade as well.
+2. The pip command sometimes may have conflicts with some vpn programs.
+If in this case, try quit vpn program, and try again. 
 # Are there more detailed case studies on using siat?
 YES!
 
@@ -197,7 +213,3 @@ https://space.bilibili.com/284812153
 Welcome to follow the channel!
 # How to report a bug or look for help?
 Write to the author, Prof. WANG Dehong, wdehong2000@163.com
-
-```python
-
-```

{siat-3.4.6.dist-info → siat-3.4.7.dist-info}/RECORD

@@ -139,7 +139,7 @@ siat/valuation_china.py,sha256=EkZQaVkoBjM0c4MCNbaX-bMnlG0e3FXeaWczZDnkptU,67784
 siat/valuation_market_china_test.py,sha256=gbJ0ioauuo4koTPH6WKUkqcXiQPafnbhU5eKJ6lpdLA,1571
 siat/var_model_validation.py,sha256=R0caWnuZarrRg9939hxh3vJIIpIyPfvelYmzFNZtPbo,14910
 siat/yf_name.py,sha256=H1EM8YYXA8nQHIqsJlso0I3HKPiJLT3QujO4gRVQXWs,13945
-siat-3.4.6.dist-info/METADATA,sha256=Agk7WFoMV7XNYw3oVZAWg1hEo1UmDFKgavjPoVFN0z8,7309
-siat-3.4.6.dist-info/WHEEL,sha256=GJ7t_kWBFywbagK5eo9IoUwLW6oyOeTKmQ-9iHFVNxQ,92
-siat-3.4.6.dist-info/top_level.txt,sha256=r1cVyL7AIKqeAmEJjNR8FMT20OmEzufDstC2gv3NvEY,5
-siat-3.4.6.dist-info/RECORD,,
+siat-3.4.7.dist-info/METADATA,sha256=CBhvM44KsB402bBfbLnm-GCCgCv3gKurQdlBVG6s7z8,7682
+siat-3.4.7.dist-info/WHEEL,sha256=2wepM1nk4DS4eFpYrW1TTqPcoGNfHhhO_i5m4cOimbo,92
+siat-3.4.7.dist-info/top_level.txt,sha256=r1cVyL7AIKqeAmEJjNR8FMT20OmEzufDstC2gv3NvEY,5
+siat-3.4.7.dist-info/RECORD,,

{siat-3.4.6.dist-info → siat-3.4.7.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: bdist_wheel (0.43.0)
+Generator: bdist_wheel (0.38.4)
 Root-Is-Purelib: true
 Tag: py3-none-any