Metadata-Version: 2.1
Name: ConvexTrader
Version: 0.0.2
Summary: A package for portfolio optimization using convex optimization
Home-page: https://github.com/ACquantclub/Applications-of-Convex-Optimization/
Author: Liam Davis
Author-email: Liam Davis <ljdavis27@amherst.edu>
License: MIT License
        
        Copyright (c) 2024 Amherst College Quant Club
        
        Permission is hereby granted, free of charge, to any person obtaining a copy
        of this software and associated documentation files (the "Software"), to deal
        in the Software without restriction, including without limitation the rights
        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
        copies of the Software, and to permit persons to whom the Software is
        furnished to do so, subject to the following conditions:
        
        The above copyright notice and this permission notice shall be included in all
        copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
        SOFTWARE.
        
Project-URL: Homepage, https://acquantclub.github.io/Applications-of-Convex-Optimization
Project-URL: Repository, https://github.com/ACquantclub/Applications-of-Convex-Optimization
Keywords: portfolio optimization,convex optimization,finance
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.7
Description-Content-Type: text/markdown
License-File: LICENSE

# Applications-of-Convex-Optimization

Fall 2024 Project: Applications of Convex Optimization

## Installation

### Setting Up a Virtual Environment

1. **Clone the repository**:
    ```bash
    git clone https://github.com/yourusername/Applications-of-Convex-Optimization.git
    cd Applications-of-Convex-Optimization
    ```

2. **Create a virtual environment**:
    ```bash
    python3 -m venv env
    ```

3. **Activate the virtual environment**:
    - On macOS and Linux:
        ```bash
        source env/bin/activate
        ```
    - On Windows:
        ```bash
        .\env\Scripts\activate
        ```

### Installing Dependencies

1. **Install the required packages**:
    ```bash
    pip install -r requirements.txt
    ```

### Running Tests

1. **Navigate to the tests directory**:
    ```bash
    cd tests
    ```

2. Follow the instructions in the README located in the tests directory to run the tests.
