search

precice / vm

Vagrant box with preCICE and examples preinstalled
MIT License
5 stars 3 forks source link

Adds hint to be patient until machine is provisioned #3

Closed BenjaminRodenberg closed 3 years ago

BenjaminRodenberg commented 3 years ago

After I killed the session (I thought it was already done and this is just noise), I had no GUI. I think we should explicitly tell the user to wait until provisioning finishes, since this process cannot be continued, if it was killed.

The exact phrasing of the documentation is not ideal, but you should be able to get the gist. @fsimonis , @MakisH: Do you think this is a valid point or am I just not patient enough?

BenjaminRodenberg commented 3 years ago

This is useful, in general. Not only because of manually killing it, but also because things can go wrong (e.g. the connection to the OpenFOAM repository times out). But note the following:

* No need to do `vagrant destroy`. Instead, `vagrant up --provision` will run everything again, skipping some parts. From my experience, most steps should be kind-of state-agnostic (e.g. I check if a repository exists before cloning again). But not everything: this may lead to some accumulation of disk space.

Thanks for the correction! I applied it.

* The user is not supposed to build this repository, but get a pre-built image: https://app.vagrantup.com/precice/boxes/precice-vm

Ok. This was I point I totally missed. I thought the only way is building everything from scratch. Is this something that is provided in the README? Is this something I should know? I assume a proficient Vagrant user knows that a "vagrantcloud" exists. However: Most of the users of this vm will not be Vagrant users. Therefore, I would suggest also mentioning this in the README:

Get the VM

Easy:

got to vagrantcloud and do something

Complicated:

build the machine from scratich using this repo.

I have something in mind similar to the python bindings, where we first recommend using pip3 to pull from PyPI, but also provide the commands to build everything from source. See here. We can add this to this PR or open a new one.

MakisH commented 3 years ago

Mentioning the Vagrant Cloud is planned, we have not officially announced this yes and we wanted to test the instructions that we distributed via email first. There is no need to further argue in this direction, it is clear.

MakisH commented 3 years ago

I resolved a conflict that occured after changing the target to develop: I had already added such a note, but yours nicely targets the "there is no GUI" symptom.