Skip to content

Commit

Permalink
Update example project paths to be more explicit.
Browse files Browse the repository at this point in the history
  • Loading branch information
JoeZiminski committed Oct 9, 2023
1 parent 217cf9d commit 31bc584
Showing 1 changed file with 5 additions and 5 deletions.
10 changes: 5 additions & 5 deletions docs/source/pages/documentation.md
Original file line number Diff line number Diff line change
Expand Up @@ -78,16 +78,16 @@ The optional arguments `overwrite_old_files`, `transfer_verbosity` and `show_tra

### Example

An example call to `make-config-file` below creates a new project called `my_first_project`, sets the *local* project path to `/path/to/my/project/my_first_project`, the *central* path (to a remote Linux server) to `/nfs/nhome/live/username/my_first_project`, the required SSH configurations, and indicates that *behavioural*, _electrophysiological_ and *histological* data will be used on this machine for this project.
An example call to `make-config-file` below creates a new project called `my_first_project`, sets the *local* project path to `/path/to/my_projects/my_first_project`, the *central* path (to a remote Linux server) to `/nfs/nhome/live/username/my_projects/my_first_project`, the required SSH configurations, and indicates that *behavioural*, _electrophysiological_ and *histological* data will be used on this machine for this project.

Note that in the terminal, ``\`` indicates a new-line (allowing a single command to be spread across multiple lines for display purposes). On Windows, the `^` character is used instead.

```
datashuttle \
my_first_project \
make-config-file \
/path/to/my/project/my_first_project \
/nfs/nhome/live/username/my_first_project \
/path/to/my/my_projects/my_first_project \
/nfs/nhome/live/username/my_projects/my_first_project \
ssh \
--central_host_id ssh.swc.ucl.ac.uk \
--central_host_username username \
Expand Down Expand Up @@ -323,8 +323,8 @@ project = DataShuttle("my_first_project")
The configuration file can be setup similarly to the *Get Started* example:
```
project.make_config_file(
local_path="/path/to/my/project/my_first_project",
central_path="/nfs/nhome/live/username/my_first_project",
local_path="/path/to/my/my_projects/my_first_project",
central_path="/nfs/nhome/live/username/my_projects/my_first_project",
connection_method="ssh",
central_host_id="ssh.swc.ucl.ac.uk",
central_host_username="username",
Expand Down

0 comments on commit 31bc584

Please sign in to comment.