This guide will walk you through the process of setting up the Marcello Dynamics project on your local machine, including installing dependencies and running the project.
- Git: Version control system to clone the repository.
- Python 3.11: Required version of Python for the project.
- pip: Python package manager to install dependencies.
If you don't have Git installed, you can download and install it from the official website:
Follow the instructions for your operating system.
Once you have Git installed, open your terminal (Command Prompt, PowerShell, or terminal for macOS/Linux) and run the following command to clone the repository:
git clone https://github.com/dagl1/Marcello_dynamics
Navigate into the cloned directory:
Ensure that Python 3.11 is installed on your system. You can download the latest version of Python from the official website:
After installing, verify the installation by running: python --version
is should return Python 3.11.x.
It's a good practice to use a virtual environment to manage project-specific dependencies. To create one, run the following command:
python -m venv venv
Activate the virtual environment:
- On Windows: .\venv\Scripts\activate Once activated, your terminal prompt should show the virtual environment's name.
With the virtual environment activated, install the required dependencies by running:
pip install -r requirements.txt
This will install all the necessary Python packages listed in the requirements.txt file.
Finally, you can run the project by executing the main.py script:
python main.py
This should start the program and perform the desired functionality.
- If you encounter issues with package installations, make sure you're using the correct version of Python and that the virtual environment is activated.
- Ensure that all required packages are properly listed in
requirements.txt.