Skip to content

Latest commit

 

History

History
86 lines (51 loc) · 2.5 KB

README.md

File metadata and controls

86 lines (51 loc) · 2.5 KB
Raw

SustainPlus

SustainPlus is a comprehensive app designed to help investors make informed decisions based on sustainability and ESG (Environmental, Social, and Governance) metrics. The app provides insights and recommendations for investments that prioritize sustainable practices and helps companies improve their ESG scores.

Features

  • Landing Page: An overview of the platform and its purpose.
  • Stock Prediction: Tools for predicting stock prices and analyzing trends.
  • Stock Price Prediction: Advanced models to forecast future stock prices.
  • ESG Data: Detailed ESG ratings and reports for various companies.
  • Chatbot: An interactive chatbot for answering queries and providing recommendations.
  • Article Suggestions: Curated articles and resources on sustainability and ESG topics.

Installation

To set up and run the app locally, follow these steps:

1. Clone the Repository

git clone https://github.com/your-repo/sustaininvest-pro.git
cd sustaininvest-pro

2. Set Up a Virtual Environment

Create and activate a virtual environment:

python -m venv venv
source venv/bin/activate  # On Windows use: venv\Scripts\activate

3. Install Required Packages

Install the required Python packages using pip:

pip install -r requirements.txt

4. Prepare the Data

Ensure you have the necessary data files in the data directory. This includes:

esg_data.csv - ESG scores for companies. news_data - Sentiment data for news articles. company_data - Time series data for stock prices.

5. Run the Streamlit App

Start the Streamlit server to run the app:

streamlit run app.py

6. Access the App

Open your web browser and go to http://localhost:8501 to access the app.

7. Usage

  • Landing Page: Provides an overview and introductory information about the app.
  • Stock Prediction: Enter stock tickers to predict future prices using historical data.
  • Stock Price Prediction: Analyze and visualize advanced stock price predictions.
  • ESG Data: View ESG ratings and detailed reports for various companies.
  • Chatbot: Interact with the chatbot for recommendations and queries.
  • Article Suggestions: Access curated articles and resources on sustainability and ESG topics.

8. Contributing

Contributions are welcome! Please submit issues and pull requests to the repository.

9. License

10. Contact

For questions or feedback, please contact us at