Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add datashuttle blog #98

Merged
merged 28 commits into from
May 7, 2024
Merged
Changes from 1 commit
Commits
Show all changes
28 commits
Select commit Hold shift + click to select a range
7ac1201
Fix blog header, minor title changes.
JoeZiminski Apr 25, 2024
ad96986
Add blog dates, fix wrong order, add html sidebar.
JoeZiminski Apr 29, 2024
e1660ce
working first draft datashuttle blog.
JoeZiminski Apr 26, 2024
375ccd8
Add slightly edited datashuttle examples.
JoeZiminski Apr 26, 2024
39c79bf
Small working changes.
JoeZiminski Apr 26, 2024
c29b66c
Small changes.
JoeZiminski Apr 29, 2024
af8b24e
Continue writing first draft.
JoeZiminski Apr 29, 2024
924492a
Close to first draft.
JoeZiminski Apr 29, 2024
7e7a26c
Typo 'datashutte'
JoeZiminski Apr 30, 2024
844db9c
make first line bold
JoeZiminski Apr 30, 2024
a6e6def
fix datashuttles typo
JoeZiminski Apr 30, 2024
58caf2d
Fix another! datashutte typo
JoeZiminski Apr 30, 2024
524e616
grammatical fix.
JoeZiminski Apr 30, 2024
68ea4a5
Remove 'convenience' a) redundant with 'shortcut' b) uninformative wi…
JoeZiminski Apr 30, 2024
9582f6c
Change 'blog' to 'blog post'.
JoeZiminski Apr 30, 2024
2440cb0
Only use light-mode top datashuttle image.
JoeZiminski Apr 30, 2024
371a1ec
Play around with author order.
JoeZiminski May 1, 2024
4abcac6
Playing ar ound with author order.
JoeZiminski May 1, 2024
f366dc3
Small fixes based on feedback.
JoeZiminski May 1, 2024
3392bb0
Small tidy ups, add logging images.
JoeZiminski May 1, 2024
d67bef0
Few more small changes.
JoeZiminski May 1, 2024
d927394
Few small edits to order and content.
JoeZiminski May 3, 2024
bd322e5
Final tidy ups, checks and edits.
JoeZiminski May 3, 2024
8b777ac
Apply Adam's typo fixes and rewordings from code review
niksirbi May 7, 2024
9ec42ae
add missing article
niksirbi May 7, 2024
2e5b304
correct closure of code block
niksirbi May 7, 2024
678adec
rephrase some sentences for clarity & data are consistently plural
niksirbi May 7, 2024
81f9b6f
cross-link datashuttle and neuroblueprint blogposts
niksirbi May 7, 2024
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Few more small changes.
JoeZiminski committed May 3, 2024
commit d67bef0a8bc63877e53465e9e71d9d6bcbb24e4d
21 changes: 12 additions & 9 deletions docs/source/blog/datashuttle.md
Original file line number Diff line number Diff line change
@@ -124,7 +124,10 @@ entering the subject and session name in the folder and clicking 'create'.
There are a number of shortcuts to ensure you only need to enter
your custom information. For example, the tags
(`@DATE@`, `@TIME@`, `@DATETIME@`) will fill the created folder
with the date / time / datetime.
with the date / time / datetime. A full list of shortcuts
(e.g. automatic suggestion of next subject / session names)
are available in the
[documentation](https://datashuttle.neuroinformatics.dev/pages/how_tos/create-folders.html#creating-project-folders)

**datashuttle** performs live-validation of inputs, ensuring
formatting errors cannot creep into the project:
@@ -179,8 +182,7 @@ as below and click `Transfer`:
```
<br>

and in code, it looks similar:

and transfers can be similarly performed through the Python API:
```python
from datashuttle import DataShuttle

@@ -192,8 +194,8 @@ project.transfer_custom(
```

## Logging
A final feature of **datashuttle** is logging—whenever a folder is created or
data transferred, full details are saved in the logs. This ensures
Whenever a folder is created or data transferred in **datashuttle**,
full details are saved in the logs. This ensures
a full history of the project is available at any time. Logs are stored
on the local filesystem and can be viewed in a text editor or through
the graphical interface:
@@ -213,15 +215,16 @@ the graphical interface:
## Getting started with **datashuttle**

We have given a brief tour of **datashuttle**'s key features,
but full details on getting started can be found at our
but full details on getting started can be found on our
[website](https://datashuttle.neuroinformatics.dev/) and
[getting started tutorial](https://datashuttle.neuroinformatics.dev/pages/tutorials/getting_started.html).
in the [getting started tutorial](https://datashuttle.neuroinformatics.dev/pages/tutorials/getting_started.html).

We are very keen to get feedback on **datashuttle**.
Standardisation is incredibly useful, but it should not come at the
expense of convenience. **datashuttle** aims to make managing your project easier than
it currently is—if it is not, we want to hear how it can be improved.
You can get in contact with get in contact through our

We are very keen to get feedback on **datashuttle**.
Please can get in contact anytime through our
[GitHub Issues](https://github.com/neuroinformatics-unit/datashuttle/issues)
or
[Zulip Chat.](https://neuroinformatics.zulipchat.com/#narrow/stream/405999-DataShuttle)