Skip to content

Commit 7bd8e28

Browse files
committed
More tidying up.
1 parent 7506ca3 commit 7bd8e28

19 files changed

+82
-50
lines changed

docs/source/index.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -59,6 +59,7 @@ A lack of project standardization in systems neuroscience
5959
[hinders data sharing and collaboration](https://neuroinformatics.dev/blog/neuroblueprint.html),
6060
creating barriers to reproducibility and scientific progress
6161

62+
6263
``datashuttle`` helps creates, validate and transfer projects standardised to the
6364
[NeuroBlueprint](https://neuroblueprint.neuroinformatics.dev) specification:
6465

@@ -74,10 +75,9 @@ creating barriers to reproducibility and scientific progress
7475
```
7576

7677
Dive right into ``datashuttle`` with our
77-
[Getting Started Tutorial](tutorial-getting-started)
78-
or targeted [How-To Guides](how-tos). \
78+
[Getting Started Tutorial](getting-started-walkthrough)
79+
or targeted [User Guides](pages/user_guides/index). \
7980
It can be used through a graphical interface or Python API.
80-
[create-folders.md](pages%2Fuser_guides%2Fcreate-folders.md)
8181

8282
Don't hesitate to get in contact through our
8383
[GitHub Issues](https://github.com/neuroinformatics-unit/datashuttle/issues)

docs/source/pages/get_started/choose-a-terminal.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
(how-to-choose-a-terminal)=
1+
(choose-a-terminal_)=
22

3-
# How to Choose a Terminal
3+
# Choose a Terminal
44

55
``datashuttle``'s graphical interface can run in almost any terminal—but
66
native Windows and macOS terminals may display with rendering errors.
@@ -13,12 +13,12 @@ If you are using Linux, the native terminal will work without issue.
1313

1414
:::{tab-item} Good Rendering
1515

16-
```{image} /_static/screenshots/how-to-choose-a-terminal-good-dark.png
16+
```{image} /_static/screenshots/choose-a-terminal-good-dark.png
1717
:align: center
1818
:class: only-dark
1919
:width: 900px
2020
```
21-
```{image} /_static/screenshots/how-to-choose-a-terminal-good-light.png
21+
```{image} /_static/screenshots/choose-a-terminal-good-light.png
2222
:align: center
2323
:class: only-light
2424
:width: 900px
@@ -30,12 +30,12 @@ If you are using Linux, the native terminal will work without issue.
3030

3131
:::{tab-item} Bad Rendering
3232

33-
```{image} /_static/screenshots/how-to-choose-a-terminal-bad-dark.png
33+
```{image} /_static/screenshots/choose-a-terminal-bad-dark.png
3434
:align: center
3535
:class: only-dark
3636
:width: 900px
3737
```
38-
```{image} /_static/screenshots/how-to-choose-a-terminal-bad-light.png
38+
```{image} /_static/screenshots/choose-a-terminal-bad-light.png
3939
:align: center
4040
:class: only-light
4141
:width: 900px
@@ -80,6 +80,6 @@ with rendering errors.
8080
## Getting started with the Graphical Interface
8181

8282
Once you've chosen a terminal, get started with
83-
``datashuttle`` with our [Getting Started Tutorial](tutorial-getting-started).
83+
``datashuttle`` with our [Getting Started Tutorial](getting-started-walkthrough).
8484

8585
To quit ``datashuttle`` in the terminal, press `CTRL+C`.

docs/source/pages/get_started/getting-started.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
(tutorial-getting-started)=
1+
(getting-started-walkthrough)=
22

33
# Getting Started
44

@@ -88,7 +88,7 @@ We need to set the:
8888

8989
``datashuttle`` supports connecting to the central storage machine
9090
either as a mounted drive or through SHH. \
91-
See [How to Make a New Project](make-a-full-project_target)
91+
See [Set up configs for transfer(set-up-configs-for-transfer_)
9292
for detailed instructions for
9393
connecting a mounted drive or by using SSH.
9494

@@ -584,7 +584,7 @@ from your **local path**.
584584
We will next download data from the **central path** to our now-empty local project.
585585
586586
In practice when setting up ``datashuttle`` on a new machine, you would
587-
again [make a new project](make-a-full-project_target).
587+
again [make a new project](set-up-configs-for-transfer_).
588588
```
589589

590590
We will look at a small subset of possible

docs/source/pages/get_started/index.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -31,12 +31,12 @@ formatting issues
3131
:::
3232

3333

34-
:::{grid-item-card} {fas}`desktop;sd-text-primary` Manage a project
35-
:link: make-a-local-project
34+
:::{grid-item-card} {fas}`desktop;sd-text-primary` Set up a project
35+
:link: set-up-a-local-project
3636
:link-type: doc
3737
:class-img-top: tutorial-link-image
3838

39-
Create, validate and transfer project folders
39+
Start a new project or manage an existing project
4040
:::
4141

4242
::::
@@ -66,7 +66,7 @@ install
6666
choose-a-terminal
6767
6868
quick-validate-project
69-
make-a-local-project
69+
set-up-a-local-project
7070
7171
getting-started
7272
```

docs/source/pages/get_started/install.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
(how-to-install)=
2-
# How to Install
2+
# Install
33

44
``datashuttle`` requires
55
[Python](https://www.python.org/)
@@ -97,5 +97,5 @@ datashuttle launch
9797
```
9898

9999
Before using the graphical interface, you may want to
100-
[choose the best terminal](how-to-choose-a-terminal)
100+
[choose the best terminal](choose-a-terminal_)
101101
for your operating system.

docs/source/pages/get_started/quick-validate-project.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
(quick-validate-projects)=
22

3-
# How to Quickly Validate an Existing Project
3+
# Quickly Validate an Existing Project
44

55
Datashuttle provides the functionality to validate an existing
66
[NeuroBlueprint](https://neuroblueprint.neuroinformatics.dev/latest/index.html)-formatted project.

docs/source/pages/get_started/make-a-local-project.md renamed to docs/source/pages/get_started/set-up-a-local-project.md

Lines changed: 31 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,15 @@
1-
# How to Make a Local Project
1+
(set-up-a-local-project)=
2+
# Set up a Local Project
3+
4+
``datashuttle`` can be used to create, validate and transfer
5+
[NeuroBlueprint](https://neuroblueprint.neuroinformatics.dev/latest/index.html) projects. In this guide, we will
6+
set up a local-only project that can manage creation
7+
and validation of project folders. This requires
8+
setting up minimal configurations to get started.
9+
10+
To see how a datashuttle project can be set up for transfer,
11+
see the [transfer](how-to-transfer-data) user guide.
212

3-
``datashuttle`` can be used to create and validate
4-
[NeuroBlueprint](https://neuroblueprint.neuroinformatics.dev/latest/index.html) projects,
5-
as well as transfer data. If you want to quickly create or validate a project's folders,
6-
but not transfer data, you can make a local-only project and immediately get started.
713

814
::::{tab-set}
915

@@ -28,6 +34,25 @@ are now disabled).
2834
```
2935
<br>
3036

37+
38+
You will now be able to go to the project manager screen:
39+
40+
```{image} /_static/screenshots/how-to-create-folders-example-dark.png
41+
:align: center
42+
:class: only-dark
43+
:width: 900px
44+
```
45+
```{image} /_static/screenshots/how-to-create-folders-example-light.png
46+
:align: center
47+
:class: only-light
48+
:width: 900px
49+
```
50+
<br>
51+
52+
53+
See the [create folders](how-to-create-folders) and [validate folders](tutorial-validation)
54+
for details on how to create and validate your project.
55+
3156
:::
3257

3358
:::{tab-item} Python API
@@ -62,7 +87,7 @@ have to set the `local_path` again).
6287

6388
If you wish to change the project settings at a later time, use ``project.update_config_file()``.
6489

65-
For example, it is possible to immediately validate the project:
90+
For example, it is possible to immediately validate the project (if it already exists):
6691

6792
```python
6893
project.validate_project("rawdata", error_or_warn="warn")
@@ -82,14 +107,4 @@ see [Create Folders](how-to-create-folders) for more details.
82107
:::
83108
::::
84109

85-
:::{note}
86-
87-
When in local-only mode, some functionality of ``datashuttle`` is lost.
88-
89-
It will not be possible to:
90-
- transfer data, which requires passing configs related to a centrally-stored project.
91-
- Any method that exposes a ``include_central`` argument will always set this to ``False``.
92-
For example, validation will only ever be performed on the local project.
93-
94-
See [](make-a-full-project_target) for more information on setting up for data transfer.
95110
:::

docs/source/pages/user_guides/create-folders.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
(how-to-create-folders)=
2-
# How to Create Folders
2+
# Create Folders
33

44
``datashuttle`` automates project folder creation and validation
55
according to the [NeuroBlueprint](https://neuroblueprint.neuroinformatics.dev/).
@@ -40,7 +40,7 @@ Now, let's get started with folder creation!
4040
## Creating project folders
4141

4242
The project-name folder is located at the **local path**
43-
specified when [setting up the project](make-a-full-project_target).
43+
specified when [setting up the project](set-up-configs-for-transfer_).
4444

4545
We will now create subject, session and
4646
datatype folders within a `rawdata` top-level folder.

docs/source/pages/user_guides/index.md

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
:gutter: 4
99

1010

11-
:::{grid-item-card} {fas}`desktop;sd-text-primary` Validate
11+
:::{grid-item-card} {fas}`desktop;sd-text-primary` Validate Folders
1212
:link: validate
1313
:link-type: doc
1414
:class-img-top: tutorial-link-image
@@ -25,6 +25,14 @@ Create [NeuroBlueprint](https://neuroblueprint.neuroinformatics.dev/latest/index
2525
:::
2626

2727

28+
:::{grid-item-card} {fas}`desktop;sd-text-primary` Set up Configs for Transfer
29+
:link: set-up-configs-for-transfer
30+
:link-type: doc
31+
32+
Set up a project for data-transfer
33+
:::
34+
35+
2836
:::{grid-item-card} {fas}`desktop;sd-text-primary` Transfer Data
2937
:link: transfer-data
3038
:link-type: doc
@@ -65,7 +73,7 @@ A handy feature for template subject and session names.
6573
6674
validate
6775
create-folders
68-
make-a-full-project
76+
set-up-configs-for-transfer
6977
transfer-data
7078
update-configs
7179
read-logs

docs/source/pages/user_guides/read-logs.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
(how-to-read-the-logs)=
22

3-
# How to Read the Logs
3+
# Read the Logs
44

55
``datashuttle`` stores detailed logs when commands that
66
create folders, change project configs or perform data transfers are run.

docs/source/pages/user_guides/make-a-full-project.md renamed to docs/source/pages/user_guides/set-up-configs-for-transfer.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,9 @@
1-
(make-a-full-project_target)=
2-
# How to Make a Full Project
1+
(set-up-configs-for-transfer_)=
2+
# Set up configurations for transfer
33

44
This guide will cover all you need to know for setting up a new project
5-
in ``datashuttle``.
5+
in ``datashuttle`` for transfer. If you just want to create and validate
6+
folders, see [set up a local project](set-up-a-local-project).
67

78
First, make sure you have
89
[installed and launched ``datashuttle``](how-to-install).

docs/source/pages/user_guides/transfer-data.md

Lines changed: 11 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,18 @@
11
(how-to-transfer-data)=
2-
# How to Transfer Data
2+
# Transfer Data
3+
4+
:::{note}
5+
6+
This guide assumes that you have already set up your project
7+
for data transfer. Please see [set up a project for transfer](set-up-a-local-project)
8+
for details.
9+
10+
:::
311

412
``datashuttle`` facilitates convenient transfer of data between
513
local and central storage machines.
614

15+
716
This includes:
817
- 'Uploading' data from an acquisition machine to central data storage.
918
- 'Downloading' subsets of data from central storage to analysis machines.
@@ -22,7 +31,6 @@ This includes:
2231
:::{admonition} Transfer Direction
2332
:class: note
2433

25-
2634
In ``datashuttle``, the *upload* refers to transfer
2735
from a local to the central machine.
2836
*Download* refers to transfer from the central machine to a local machine.
@@ -76,7 +84,7 @@ to central storage while existing files will be ignored.
7684
```
7785
<br>
7886

79-
To transfer the entire project navitgate to the `Transfer tab`. The
87+
To transfer the entire project navigate to the `Transfer tab`. The
8088
`All` button is selected to transfer the entire project.
8189

8290
Click `Transfer` to begin.

docs/source/pages/user_guides/update-configs.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11

2-
# How to Update Configs
2+
# Update Configs
33

44
The project configs can be updated at any time following the initial setup.
55

docs/source/pages/user_guides/use-name-templates.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
(how-to-use-name-templates)=
22

3-
# How to use Name Templates
3+
# Name Templates
44

55
Validation in ``datashuttle`` is by default restricted to the
66
NeuroBlueprint specification. Any subject or session names

docs/source/pages/user_guides/validate.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -109,7 +109,7 @@ folders across 'local' and 'central' before validation. This is useful check aga
109109
(e.g. `sub-001` vs `sub-02`) and duplicate names (e.g. ``sub-001`` and ``sub-001_date-20240101``) across
110110
the 'local' and 'central' project.
111111

112-
To perform this type of validation, connection configurations [must be set](make-a-full-project_target).
112+
To perform this type of validation, connection configurations [must be set](set-up-configs-for-transfer_).
113113
The ``include_central`` argument must be set to ``True``:
114114

115115
```python

0 commit comments

Comments
 (0)