Skip to content

Commit e6fb94e

Browse files
Merge pull request #365 from coding-for-reproducible-research/dsbp_build_warnings
Remove TOC as not needed for jupyterbook
2 parents b40c2c2 + f69493f commit e6fb94e

File tree

1 file changed

+2
-20
lines changed

1 file changed

+2
-20
lines changed

short_courses/data_science_best_practices.md

Lines changed: 2 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -6,24 +6,6 @@ The goal of this document is to offer a regularly updated resource that outlines
66

77
While it is not essential to follow every recommendation to the letter, thoughtfully considering and incorporating the practices discussed here can significantly improve the reproducibility, usability, and interpretability of your research.
88

9-
## Table of Contents
10-
11-
- [Quick-start](#quick-start)
12-
- [Language: Python](#language-python)
13-
- [Version Control: Git](#version-control-git)
14-
- [Project Structure](#project-structure)
15-
- [README: README.md](#readme)
16-
- [Project Config: TOML](#project-config-toml)
17-
- [IDE: VSCode](#ide-vscode)
18-
- [Packaging and Dependency Management: Poetry](#packaging-and-dependency-management-poetry)
19-
- [Code Formatter: Ruff](#code-formatter-ruff)
20-
- [Tests: Pytest](#tests-pytest)
21-
- [Data](#data)
22-
- [Examples](#examples)
23-
- [Scripts](#scripts)
24-
25-
---
26-
279
## Quick-start
2810

2911
Most of the instructions in this guide require use of the commandline interface in a Unix based system (Mac and Linux). For use with Windows first install Gitbash via [Git for Windows](https://gitforwindows.org).
@@ -122,15 +104,15 @@ from {project-name}.module_name import function_name
122104

123105
as with a `.py` file.
124106

125-
# Language: Python
107+
# Language: Python
126108

127109
[installation](https://www.python.org/downloads/) · [basics](https://wiki.python.org/moin/BeginnersGuide/Programmers) · [course](https://coding-for-reproducible-research.github.io/CfRR_Courses/course_homepages/python.html#)
128110

129111
Python is a popular, high-level programming language known for its readability and versatility. It’s widely used in fields like web development, data science, automation, and artificial intelligence. Python’s simple syntax and vast ecosystem of libraries make it a go-to choice for both beginners and professionals looking to build efficient, scalable applications.
130112

131113
Python is pre-installed on most macOS and Linux systems, meaning users can typically start using it right away from the terminal. However, on Windows, Python usually needs to be installed manually. Windows users can download it from the official Python [website](https://www.python.org/) and should ensure to check the box to "Add Python to PATH" during installation for easy access from the command line.
132114

133-
## Version Control: Git
115+
## Version Control: Git
134116

135117
[installation](https://git-scm.com/downloads) · [basics](https://git-scm.com/doc) · [course](https://coding-for-reproducible-research.github.io/CfRR_Courses/course_homepages/version_control.html)
136118

0 commit comments

Comments
 (0)