Skip to content

Commit ed04c7a

Browse files
committed
docs(copier): adds explainers to relevant files
1 parent 45adbb1 commit ed04c7a

13 files changed

Lines changed: 57 additions & 1682 deletions

File tree

‎src/copier_template/src/README.md.jinja‎

Lines changed: 5 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,9 @@
11
# Setting up a development environment
22
1. run "uv lock" to generate the uv.lock file
3-
2. Create .env in this folder (with the path src/.env) containing the following variables:
4-
5-
HOST=https://workflows.diamond.ac.uk/graphql (to submit to the production cluster)
6-
DEFAULT_IMAGE= (usually python 3.10)
7-
VISIT= (the Visit you wish to run the template on)
8-
TOKEN=
9-
EXPIRY=
10-
AUTH=
11-
3+
2. Create .env in this folder (with the path src/.env) containing the following variable (everything else will be set automatically):
4+
```bash
5+
VISIT={your visit}
6+
```
127
3. Build the dev container
138

149
# Submitting a workflow
@@ -39,6 +34,5 @@ Alternatively, you can set the default image at the top of the file by adding:
3934

4035
```python
4136
global_config.set_class_defaults( # pyright: ignore
42-
Script, image=str(os.environ.get("DEFAULT_IMAGE"))
43-
)
37+
Script, image=ghcr.io/Your-Github-Name/image-name)
4438
```

‎src/copier_template/src/{{ project_name }}/submit_workflow.py.jinja‎

Lines changed: 0 additions & 50 deletions
This file was deleted.

‎src/copier_template/src/{{ project_name }}/templates/example.txt.jinja‎

Lines changed: 0 additions & 209 deletions
This file was deleted.

0 commit comments

Comments
 (0)