Repository template for scientific research projects (replace with paper/project title)

@comp-medicine-uc

(Add a description of your repo here)

Abstract

(Add paper abstract here)

Directories

• src: Source files for libraries with general functions go here. Do NOT include main or test files that generate the final results of your work.
• tests: Main files that implement examples and tests go here.
• results: Figures and tables resulting from analysis go here. Do NOT include source data or movies here.

Dependencies

(Modify accordingly, include versions for each library) Coded in Python 3.8.2 64-bit.

Used libraries:

• FEniCS 2019.1.0
• numpy
• scipy
• matplotlib
• os
• sys

Regarding Data

Raw Data, processed data, and results should NOT be included in the GitHub repo. Use the current lab Data Repository and a local copy in your computer for Data purposes.

Regarding Documents

Paper drafts, reports, theses, presentation slides, and other sources of documentation should NOT be included in the GitHub repo. Use the lab Overleaf account for storage and version control of papers, reports, and theses. Codes and libraries shold be documented in README.md files in your GitHub repo.