search

OceanParcels / oceanparcels_website

Repository for the oceanparcels.org website
7 stars 7 forks source link

Installation process not correct since `parcels_get_examples` script removed #79

Closed erikvansebille closed 1 year ago

erikvansebille commented 1 year ago

From Parcels v.2.4.2., there is no more parcels_get_examples script, so step 4 of the installation instructions needs to be updated. I think it should now be a matter of downloading the zip at the Tutorial and Documentation page, right? Can you confirm, @VeckoTheGecko?

VeckoTheGecko commented 1 year ago

Yes, thats it

erikvansebille commented 1 year ago

OK, but is that link static? https://docs.oceanparcels.org/en/latest/_downloads/307c382eb1813dc691e8a80d6c0098f7/parcels_tutorials.zip seems rather random. I'd rather put the link right on the Installation instructions than point users first to https://docs.oceanparcels.org/en/latest/documentation.html and ask them to click the link.

Also, for the testing in the coda-forge, we test the peninsula_example; but that would also require downloading it, then? Any way to script the download? Or perhaps is it best to wget is directly from the parcels repo on GitHub?

VeckoTheGecko commented 1 year ago

Also, for the testing in the coda-forge, we test the peninsula_example; but that would also require downloading it, then?

Just saw the recipe. I think a wget from the parcels repo may be easiest. Alternatively could change the test case itself.

OK, but is that link static?

Doesn't look like it, and I don't think a static one exists. Honestly, I think the whole Installing Parcels and Contributing to Parcels development sections would be better on RTD anyway. With the new tutorials page on RTD, it may be that the purpose of the oceanparcels site shifts to be primarily for high level overview, research output, and documenting future plans for the package.

Of course, that's just my opinion as someone relatively detached from the purpose of the website.

erikvansebille commented 1 year ago

Yes, I agree that we soon need to overhaul the whole oceanparcels.org landing page, moving the installation instructions to docs, the articles to a separate pages, etc. But in the meantime, I suggest to implement #80 so that at least the installation instructions are correct