This repository is designed for creating and analyzing investment scenarios. The purpose is to simulate different investing situations and help users make informed decisions by forecasting potential returns and risks under various conditions.
To set up the environment and start using the investment scenario generator, follow the steps below.
Make sure you have Python 3.x installed on your system. The repository uses venv to create an isolated Python environment for dependencies.
- Clone the repository to your local machine:
git clone <repository_url>
cd <repository_directory>- Create a virtual environment using venv:
python3 -m venv venv- Activate the virtual environment:
- On macOS and linux:
source venv/bin/activate- On windows:
.\venv\Scripts\activate- Install the required dependencies:
pip install -r requirements.txt- Start using the investment scenario generator:
python main.py