Skip to content

Commit f87eb71

Browse files
Update README.md
1 parent 1beb5d1 commit f87eb71

File tree

1 file changed

+24
-24
lines changed

1 file changed

+24
-24
lines changed

README.md

Lines changed: 24 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -8,30 +8,30 @@ [email protected].
88
## Repository Structure
99
The repository is organised into several directories (each corresponding to part of the training materials or supporting materials) and files:
1010

11-
`cfrr_program_details/`: General information about the CfRR program (e.g. About Us, code of conduct, how to use the website, etc.).
12-
`contributing/`: Resources and guidelines for contributing to the CfRR program (these correspond to the "Join Us!" section of the website). This includes notebooks on how to contribute, community guidelines, roles, and how to develop a new course.
13-
`course_homepages/`: Jupyter notebooks for the homepage/overview of each broad course category (e.g. Python, R, Unix, etc.).
14-
`data/`: Data files (CSV datasets) used by the notebooks to generate content on the website. For example:
15-
`workshop_info.csv`: data used to generate the upcoming Workshop Schedule and Signup page (via the notebook cfrr_program_details/courses_overview.ipynb ).
16-
`previous_workshops.csv`: data used to generate the list of past workshops (also via the above notebook).
17-
`workshop_details.csv`: data used to generate the "How do these courses relate?" network graph on the pathways page (via `pathways/related_courses.ipynb`).
18-
`individual_modules/`: The main content for each workshop module. Each subdirectory here (e.g. `introduction_to_python/`, `introduction_to_r/`, `software_development_best_practices/`, etc.) contains the Jupyter notebooks, markdown files, and images for a specific course.
19-
`section_landing_pages/`: (Within `individual_modules`) Contains overview markdown pages for each course module, including course descriptions, objectives, and prerequisites. These serve as the "landing page" for each course in the self-study notes section of the website.
20-
`pathways/`: Notebooks and content describing how the courses interrelate (for example, visualising pathways through the courses).
21-
`programme_information/`: Detailed information pages for each course offering. These notebooks form the content of the Workshop Information section of the website (providing outlines and details for each workshop).
22-
`short_courses/`: Materials for any short courses or special topics (for example, a short module on virtual environments).
23-
`where_is_my_understanding/`: Interactive quizzes to help learners gauge their understanding of various courses. (This corresponds to the self-assessment quizzes section of the website.)
11+
- `cfrr_program_details/`: General information about the CfRR program (e.g. About Us, code of conduct, how to use the website, etc.).
12+
- `contributing/`: Resources and guidelines for contributing to the CfRR program (these correspond to the "Join Us!" section of the website). This includes notebooks on how to contribute, community guidelines, roles, and how to develop a new course.
13+
- `course_homepages/`: Jupyter notebooks for the homepage/overview of each broad course category (e.g. Python, R, Unix, etc.).
14+
- `data/`: Data files (CSV datasets) used by the notebooks to generate content on the website. For example:
15+
- `workshop_info.csv`: data used to generate the upcoming Workshop Schedule and Signup page (via the notebook cfrr_program_details/courses_overview.ipynb ).
16+
- `previous_workshops.csv`: data used to generate the list of past workshops (also via the above notebook).
17+
- `workshop_details.csv`: data used to generate the "How do these courses relate?" network graph on the pathways page (via `pathways/related_courses.ipynb`).
18+
- `individual_modules/`: The main content for each workshop module. Each subdirectory here (e.g. `introduction_to_python/`, `introduction_to_r/`, `software_development_best_practices/`, etc.) contains the Jupyter notebooks, markdown files, and images for a specific course.
19+
- `section_landing_pages/`: (Within `individual_modules`) Contains overview markdown pages for each course module, including course descriptions, objectives, and prerequisites. These serve as the "landing page" for each course in the self-study notes section of the website.
20+
- `pathways/`: Notebooks and content describing how the courses interrelate (for example, visualising pathways through the courses).
21+
- `programme_information/`: Detailed information pages for each course offering. These notebooks form the content of the Workshop Information section of the website (providing outlines and details for each workshop).
22+
- `short_courses/`: Materials for any short courses or special topics (for example, a short module on virtual environments).
23+
- `where_is_my_understanding/`: Interactive quizzes to help learners gauge their understanding of various courses. (This corresponds to the self-assessment quizzes section of the website.)
2424

2525
In addition to the directories, the root of the repository contains important configuration and documentation files, including:
2626

27-
`home_page.md`: The main homepage content for the Jupyter Book (the landing page of the CfRR website).
28-
`_config.yml`: Configuration for the Jupyter Book (controls the website's appearance and behaviour).
29-
`_toc.yml`: Table of contents for the Jupyter Book (defines the structure and navigation of the site).
30-
`CITATION.cff`: Citation information for the CfRR materials (how to cite this training program and content).
31-
`references.bib`: Bibliographic references used across the materials (for citations within course content).
32-
`pyproject.toml`: Project configuration and dependencies (for Python environment, uses Poetry format) for building the Jupyter Book.
33-
`requirements.in`: List of Python packages required to run the notebooks and build the book (e.g., Jupyter Book, numpy, pandas, etc.).
34-
`.github/workflows/`: CI workflows for automated building and deployment (see Continuous Integration section below).
27+
- `home_page.md`: The main homepage content for the Jupyter Book (the landing page of the CfRR website).
28+
- `_config.yml`: Configuration for the Jupyter Book (controls the website's appearance and behaviour).
29+
- `_toc.yml`: Table of contents for the Jupyter Book (defines the structure and navigation of the site).
30+
- `CITATION.cff`: Citation information for the CfRR materials (how to cite this training program and content).
31+
- `references.bib`: Bibliographic references used across the materials (for citations within course content).
32+
- `pyproject.toml`: Project configuration and dependencies (for Python environment, uses Poetry format) for building the Jupyter Book.
33+
- `requirements.in`: List of Python packages required to run the notebooks and build the book (e.g., Jupyter Book, numpy, pandas, etc.).
34+
- `.github/workflows/`: CI workflows for automated building and deployment (see Continuous Integration section below).
3535

3636
## Getting Started: Using the Materials
3737
You can engage with the CfRR course materials in two main ways:
@@ -44,12 +44,12 @@ The easiest way to view the content is on our Jupyter Book website (hosted via G
4444
You can run the materials on your own machine to interact with the notebooks directly. To set up the repository locally and explore the content:
4545

4646
Clone this repository to your local machine:
47-
"`bash
47+
````bash
4848
git clone https://github.com/coding-for-reproducible-research/ CfRR_Courses.git
4949
```
5050

5151
Install the required dependencies, which can be done with pip:
52-
"`bash
52+
```bash
5353
pip install -r requirements.in
5454
```
5555

@@ -88,4 +88,4 @@ Since this repository aggregates several courses and materials (potentially from
8888
## Continuous Integration and Deployment
8989
This project uses GitHub Actions for continuous integration and deployment. Whenever changes are pushed or a pull request is made, the Jupyter Book is automatically built and checked using the workflow in `.github/workflows/build-book.yml`. On pushes to the main branch (and on a schedule), the site is automatically deployed to GitHub Pages via `.github/workflows/deploybook.yml`. This means the online site is kept up-to-date with the latest materials from the repository. Contributors do not need to build or deploy the website manually; the CI system handles it, ensuring that changes in the content will appear on the live site after being merged into the main branch.
9090
91-
Happy coding, and we hope you find the Coding for Reproducible Research materials useful for your research journey! Feel free to explore, learn, and contribute.
91+
Happy coding, and we hope you find the Coding for Reproducible Research materials useful for your research journey! Feel free to explore, learn, and contribute.

0 commit comments

Comments
 (0)