📝 OVERVIEW

This project is implemented to streamline the initial setup of the project environment. It will first guide you through how to replicate a remote repository onto your local machine. (creating a local repository that resides on your machine). Utilizing the setup.py script attached to this project (proceed to step 2 for more information), a properly configured Virtual Environment (venv) and project-specific dependencies will be properly installed.

This allows for procedural/systematic setup of your developer environment and allows for one to start working on this code at a faster rate. A separate script may need to be implemented for settings files ~ user-specific

🪜 STEP-BY-STEP RUNDOWN

1. Clone your desired Directory

a.   THIS METHOD ONLY WORKS IF YOU HAVE READ OR WRITE PERMISSIONS FOR A REPOSITORY
b.   REMARK: This step requires you to have set up a personal SSH key previously.
c.   Create an appropriately named folder in your local GitHub directory (typically found in ~\Documents\GitHub) to access later.
d.   Then open the folder in your IDE (VS Code) and open the command prompt (cmd).
EXAMPLE: Access Powershell and CMD
   
e.   Retrieve the password-protected SSH key for your desired repository (example of how to copy the SSH key of a repository):

f.   Then clone the repository as follows:

git clone [your SSH key]
# (SSH key should be in the form git@github.com:username/repository.git)

g.   If the following method does not work, you may need to utilize GitHub Desktop to fix this.

2. Add this script into your project

• EITHER clone this repository into your project in a similar fashion as in step 1
• OR download the setup.py file and add it to your project manually

3. Creating the virtual environment:

Run the command in cmd

python setup.py

4. Activate the venv as Instructed for your Operating System

For Windows Run the following command in cmd

.venv\\Scripts\\activate

For Unix or MacOS Run the following command in cmd'

.venv/bin/activate

5. To install dependencies

Run the command in cmd

python setup.py --install

---

💡In the Case of Pysensemble Projects

6. Change your Directory to the Experiments Folder of your cloned pyensemble Directory

    cd ~

    cd pyensemble/experiments

7. Clone your Specific sub-projects into the experiments folder of the by ensemble framework by repurposing the commands in step 1

8. To access the server and AWS buckets appropriately you need to modify the params.ini files in the settings/locals folder (and modify the settings and dev files to match those changes) and activate VPN

9. SUCCESS! You can now utilize -runserver and -shell commands

---

🔎 Additional Documentation

ARCHIVE