Installation instructions for MacOS #1

2021-08-02T22:06:30Z

m-wierzba commented

2021-08-02 22:06:30 +00:00

(Migrated from github.com)

The suggested changes include:

Update of the "Software requirements for automatic recomputation" section
"Installation tips for MacOS" section

Please review, before merging!

The suggested changes include: - Update of the "Software requirements for automatic recomputation" section - "Installation tips for MacOS" section Please review, before merging!

adswa (Migrated from github.com) reviewed

2021-08-03 07:10:33 +00:00

adswa (Migrated from github.com) left a comment

Thank you, @m-wierzba! I left a few comments/suggestions, but overall cool, and an important addition!

README.md

				`@ -9,8 +9,54 @@ https://github.com/psychoinformatics-de/processing-workflow.`

- [DataLad](http://www.datalad.org): Please make sure that you have installed a recent version of DataLad (`0.14.3` or higher), as well as recent versions of its dependencies (git, `2.24.0` or higher; git-annex, `8.20*` or higher). Installation instructions are available at: [http://handbook.datalad.org](http://handbook.datalad.org/en/latest/intro/installation.html#install).

I would probably cut this - it is true for some systems, but I wouldn't want to force e.g. a pip user to get a separate conda environment, or a Windows user to fight with two separate Python installations.

```suggestion - [DataLad](http://www.datalad.org): Please make sure that you have installed a recent version of DataLad (`0.14.3` or higher), as well as recent versions of its dependencies (git, `2.24.0` or higher; git-annex, `8.20*` or higher). Installation instructions are available at: [http://handbook.datalad.org](http://handbook.datalad.org/en/latest/intro/installation.html#install). ``` I would probably cut this - it is true for some systems, but I wouldn't want to force e.g. a ``pip`` user to get a separate ``conda`` environment, or a Windows user to fight with two separate Python installations.

I would probably phrase this a bit less like "your OS is not supported" and rather like "here is how you do it". Below is a potential suggestion:

An installation of [Singularity on MacOS(https://sylabs.io/guides/3.8/admin-guide/installation.html#installation-on-windows-or-mac) requires using a virtual machine. It is recommended to use [VirtualBox](https://www.virtualbox.org) and (optionally) [Vagrant](https://www.vagrantup.com) software. This software can be installed via [Homebrew](https://brew.sh) package manager.

I would probably phrase this a bit less like "your OS is not supported" and rather like "here is how you do it". Below is a potential suggestion: ```suggestion An installation of [Singularity on MacOS(https://sylabs.io/guides/3.8/admin-guide/installation.html#installation-on-windows-or-mac) requires using a virtual machine. It is recommended to use [VirtualBox](https://www.virtualbox.org) and (optionally) [Vagrant](https://www.vagrantup.com) software. This software can be installed via [Homebrew](https://brew.sh) package manager. ```

Naive question: Do I need to do this before or after starting the VM?

Maybe this paragraph can move upwards, or become a footnote of the section

Please substitute the value of the $VM variable with a name of your Vagrant box (debian/buster64 in this example
?

Maybe this paragraph can move upwards, or become a footnote of the section > Please substitute the value of the `$VM` variable with a name of your Vagrant box (`debian/buster64` in this example ?

Probably worthwhile to note something like

Lastly, install the required software, as described in the ["Software requirements for automatic recomputation"](#software-requirements-for-automatic-recomputation) section above in your VM, as if your operating system was Linux.

Probably worthwhile to note something like ```suggestion Lastly, install the required software, as described in the ["Software requirements for automatic recomputation"](#software-requirements-for-automatic-recomputation) section above in your VM, as if your operating system was Linux. ```

m-wierzba (Migrated from github.com) reviewed

2021-08-03 07:46:39 +00:00

README.md

				`@ -9,8 +9,54 @@ https://github.com/psychoinformatics-de/processing-workflow.`

Yes, I agree.

m-wierzba (Migrated from github.com) reviewed

2021-08-03 07:47:44 +00:00

README.md

				`@ -9,8 +9,54 @@ https://github.com/psychoinformatics-de/processing-workflow.`

Sounds good. :)

m-wierzba (Migrated from github.com) reviewed

2021-08-03 07:54:43 +00:00

README.md

				`@ -9,8 +9,54 @@ https://github.com/psychoinformatics-de/processing-workflow.`

It could become a footnote.

The intended meaning was: "If you wan't to spare yourself trouble of installing Singularity by yourself, this is the way to go."

It could become a footnote. The intended meaning was: "If you wan't to spare yourself trouble of installing Singularity by yourself, this is the way to go."

m-wierzba (Migrated from github.com) reviewed

2021-08-03 07:58:50 +00:00

README.md

				`@ -9,8 +9,54 @@ https://github.com/psychoinformatics-de/processing-workflow.`

Agree, I would only split it into smaller chunks like so:

Lastly, install the required software in your VM, as if your operating system was Linux. Please follow instructions described in the ["Software requirements for automatic recomputation"](#software-requirements-for-automatic-recomputation) section above.

Agree, I would only split it into smaller chunks like so: ```suggestion Lastly, install the required software in your VM, as if your operating system was Linux. Please follow instructions described in the ["Software requirements for automatic recomputation"](#software-requirements-for-automatic-recomputation) section above. ```

m-wierzba (Migrated from github.com) reviewed

2021-08-03 08:06:34 +00:00

README.md

				`@ -9,8 +9,54 @@ https://github.com/psychoinformatics-de/processing-workflow.`

I believe this needs to be done once the VM is initialised, so after:

$ export VM=debian/buster64 && \
    vagrant init $VM

There's a possibility that you need to take your VM down and up again for the configuration changes to be applied.

I believe this needs to be done once the VM is [initialised](https://www.vagrantup.com/docs/cli/init), so after: ``` $ export VM=debian/buster64 && \ vagrant init $VM ``` There's a possibility that you need to take your VM down and up again for the configuration changes to be applied.

adswa (Migrated from github.com) reviewed

2021-08-03 08:19:16 +00:00

README.md

				`@ -9,8 +9,54 @@ https://github.com/psychoinformatics-de/processing-workflow.`

The intended meaning was: "If you wan't to spare yourself trouble of installing Singularity by yourself, this is the way to go."

Makes sense! its probably just fair to link to this upfront, so that people that do want to spare themselves the trouble know about this right away.

> The intended meaning was: "If you wan't to spare yourself trouble of installing Singularity by yourself, this is the way to go." Makes sense! its probably just fair to link to this upfront, so that people that do want to spare themselves the trouble know about this right away.

adswa (Migrated from github.com) reviewed

2021-08-03 08:19:28 +00:00

README.md

				`@ -9,8 +9,54 @@ https://github.com/psychoinformatics-de/processing-workflow.`

cool, sounds great!

adswa (Migrated from github.com) reviewed

2021-08-03 08:20:17 +00:00

README.md

				`@ -9,8 +9,54 @@ https://github.com/psychoinformatics-de/processing-workflow.`

ok, cool. Do you want to add this, or refer to the docs for it?

adswa (Migrated from github.com) approved these changes

2021-08-03 12:08:59 +00:00

adswa (Migrated from github.com) left a comment

great, thx!

Sign in to join this conversation.

No reviewers

adswa

No labels

No milestone

No project

No assignees

1 participant

Notifications

Due date

The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference

datalad/fairly-big-processing-workflow-tutorial!1

Rows
Columns