Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Hopefully helping newcommers #3

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Hopefully helping newcommers #3

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
cc988b8
Foolproof readme
EricDriussi Jun 27, 2021
95e58b4
format
EricDriussi Jun 27, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 26 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,11 +1,33 @@
# cwarp

Streamlit App and Notebook For CWARP

## DISCLAIMER

ANY AND ALL CONTENTS OF THIS STREAMLIT APPLICATION ARE FOR INFORMATIONAL PURPOSES ONLY. NEITHER THE INFORMATION PROVIDED HEREIN NOR ANY OTHER DATA OR RESOURCES RELATED TO CWARP(TM) SHOULD BE CONSTRUED AS A GUARANTEE OF ANY PORTFOLIO PERFORMANCE USING CWARPTM OR ANY OTHER METRIC DEVELOPED OR DISCUSSED HEREIN. ANY INDIVIDUAL WHO USES, REFERENCES OR OTHERWISE ACCESSES THE WEBPAGE OR ANY OTHER DATA, THEORY, FORMULA, OR ANY OTHER INFORMATION CREATED, USED, OR REFERENCED BY ARTEMIS DOES SO AT THEIR OWN RISK AND, BY ACCESSING ANY SUCH INFORMATION, INDEMNIFIES AND HOLDS HARMLESS ARTEMIS CAPITAL MANAGEMENT LP, ARTEMIS CAPITAL ADVISERS LP, AND ALL OF ITS AFFILIATES (TOGETHER, “ARTEMIS”) AGAINST ANY LOSS OF CAPITAL THEY MAY OR MAY NOT INCUR BY UTILIZING SUCH DATA. ARTEMIS DOES NOT BEAR ANY RESPONSIBILITY FOR THE OUTCOME OF ANY PORTFOLIO NOT DIRECTLY OWNED AND/OR MANAGED BY ARTEMIS.

This is live and hosted at:
https://share.streamlit.io/jpartemis/cwarp/main/cwarp_app.py
## Where

The project is live and hosted [here](https://share.streamlit.io/jpartemis/cwarp/main/cwarp_app.py), although it is quite unstable.

We will keep monitoring and reboot the app when it fails. We are looking into this issue for longer term maintenance.
If the app is not working when you try to access it, we welcome you to run the streamlit app locally.

## How

Most fool proof way to run the project locally is to either download the `.zip` or
```
git clone https://github.com/jpartemis/cwarp.git
```
from this repo, make sure you have both `python3` and `pip` installed and set in your system PATH.

### Install

NOTE: The Streamlit app hosted at this server seems to be unstable, and sometimes fails when it encounters web traffic. We will keep monitoring and reboot the app when it fails. We are looking into this issue for longer term maintenance. If the app is not working when you try to access it, we welcome you to run the streamlit app locally or use the Jupyter notebook in the repository, if you have a python development environment installed.
```
pip install pandas matplotlib seaborn yfinance streamlit
```
### Run

Please go to https://www.python.org/downloads/ to install the latest version of Python3. For running the jupyter notebook, you will of course need to install jupyter notebook dependency via the Package Installer for Python (pip). For running the streamlit app locally, you can install the streamlit dependency via pip as well.
Hopefully just running `streamlit run cwarp_app.py` from the command line just launches the script and opens your browser on `localhost:8501`.
In some cases it might not work.
You might find that installing [Anaconda](https://www.anaconda.com/products/individual) and using its command prompt does the trick. Probably overkill but hey, it works.