QSL_Publication_Template

The repository contains the temlpate for the research projects

Project Title

I am writing this for just a temp showcase

---

Installation

Following commands will set up and install the project locally.

Clone the project.

git clone git@github.com:<PROJECT>
cd project

Create a virtual environment

(Using Conda) conda create -n my_venv python=3.11
(Using pip) python3.11 -m venv my_venv

Activate the Virtual environment and install the requirements

(Using conda) conda activate my_venv
(Using Pip) source ./my_venv/bin/activate

pip install -r requirements.txt

How to run

Run the main.py using following command

python <SCRIPT>.py

Results

File Structure

Project/
│
├── Project/                  
│   ├── file_1/                
│   └── more_files/            
│
├── docs/              
├── configs/         
├── results/
├── requirements.txt
└── main.py

Acknowledgment

Cite

License