This GitHub page is a reference and companion repository to the FOSS 2023 course.
The goal of this page is to provide FOSS learners with an idea of what (hopefully) a well constructed GitHub repository should look like.
Throughout FOSS, learners will be given the opportunity to reinforce their knowledge through self-paced assignments: a novel topic will be covered each week, and at the end of the lesson learners will be asked to add their newly gained knowledge to their own GitHub repository. This repository aims to be a reference learners can use when adding to their own work.
The repository aims to represent a well structured page for a research tool following FAIR and CARE principles. In addition, the resporitory tries to follow best practices for project management, data management, version control and documentation with the goal of being reproducible for collaborators and potential contributors.
Each of the aims discussed above are associated with their specific FOSS lessons:
.
├── AUTHORS.md
├── LICENSE
├── README.md
├── mkdocs.yml <- Governing file for website building
├── requirements.txt <- Requirements file for pip installation (required by website)
├── code
│ ├── src
│ │ ├── *.py <- Python files part of dplPy
│ │ └── execution_sample.ipynb <- runnable example (executable Jupyter notebook)
│ ├── Dockerfile <- Docker script in charge of container creation
│ └── tests_data <- Data from third party sources used for testing (in rwl and csv formats.
│ ├── csv
│ └── rwl
└── docs
├── assets <- Folder for images and additional graphic assets
├── stylesheets <- Folder containing style-related code for the website
├── index.md <- Main website home page
├── installation.md <- Installation steps for dplPy
├── manual.md <- Manual for dplPy
├── Data_Management_Plan.md <- Data Management Plan (example) applicable for this repository
└── Governance_Operations.md <- Governance & Operations (example) file applicable for this repsitory
This repository We respectfully acknowledge the University of Arizona is on the land and territories of Indigenous peoples. Today, Arizona is home to 22 federally recognized tribes, with Tucson being home to the O’odham and the Yaqui. Committed to diversity and inclusion, the University strives to build sustainable relationships with sovereign Native Nations and Indigenous communities through education offerings, partnerships, and community service.