-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathconstants.yml
More file actions
48 lines (45 loc) · 2 KB
/
Copy pathconstants.yml
File metadata and controls
48 lines (45 loc) · 2 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
md_project_setup:
type: str
when: false
default: |
## Setup
### Prerequisites
+ An installation of [git](https://git-scm.com/downloads).
+ Make sure you have `uv` [installed](https://docs.astral.sh/uv/getting-started/installation/).
For example via pip:
```
pip install uv
```
### Installation
{%- if repo_url|length > 0 %}
Clone the project with:
```
git clone {{ repo_url }}
```
{%- endif %}
Navigate to the project directory and install all dependencies:
```bash
./just.sh install
```
This will also enable pre-commit hooks.
{%- if use_dvc %}
And make sure that you have all the necessary data available.
```
uv run dvc pull
```
{%- endif %}
Now you can start coding.
md_badges:
type: str
when: false
default: |
[](https://github.com/Excidion/reproML)
[](https://github.com/copier-org/copier)
[](https://github.com/astral-sh/uv)
[](https://github.com/astral-sh/ruff)
[](https://github.com/astral-sh/ty)
[](https://squidfunk.github.io/mkdocs-material/)
{%- if ethics_checklist %}
[](http://deon.drivendata.org/)
{%- endif %}