Move gallery examples to EinsteinExamples repository

Create issue
Issue #2055 open
Ian Hinder created an issue

The [http://einsteintoolkit.org/gallery.html Einstein Toolkit Gallery examples] parameter files could be moved from the [https://bitbucket.org/einsteintoolkit/www/src/master/gallery/?at=master www] repository to the [https://bitbucket.org/einsteintoolkit/einsteinexamples/src/master/par/?at=master EinsteinExamples] repository and arrangement. This would mean: They are checked out when someone downloads the ET, avoiding a separate web browser or curl download They will have branches like the rest of the ET, so they can be associated with a given release if necessary Note that this will separate them from the other related material on the website, such as thornlists, images, etc, but I think it is worth it to make it easier for new users. Eventually, we hope that all the gallery examples will use the standard ET thornlist anyway.

Keyword:

Comments (6)

  1. Frank Löffler
    • removed comment

    I think this is a good idea. Separate thornlists are not a problem (I could imagine providing "minimal" thornlists for example), and they should go into the same place as the parameter file, as should any additional material for each example. The web server could host checkouts of that in a transparent way.

    What I would like to avoid is to fragment the places that hold information about a particular example. In this sense, we could structure CactusExamples in a way that gives each example a separate directory, much like the gallery already, and provide all data from there.

    What I didn't make up my mind about is the html itself. There are arguments for both keeping that where it is, and moving it alongside to the data, but I do lean towards keeping it in the www repository for now - mostly because they do depend on other files within the www repository, and it would be easy to provide a link within the example directories / parfiles.

  2. Ian Hinder reporter
    • removed comment

    I added a pull request for the EinsteinExamples repo (https://bitbucket.org/einsteintoolkit/einsteinexamples/pull-requests/1/add-gw150914-example/diff). This addresses just the GW150914 example. I think the parameter file, any thornlist, any citation information, and a very brief README pointing to the website text, should be in EinsteinExamples. All descriptive text and images should be in the webserver repo, as it would be hard to have that linked from bitbucket. If this is OK, the pull request can be merged, and the website repo can be adjusted to point to the bitbucket URL. We can also change the instructions to use the version in an already-downloaded ET checkout, rather than having to use curl to download the parfile.

  3. Roland Haas
    • removed comment

    Mostly fine to apply. Please see comments in the pull request though. Namely: If this is just the gallery example anyway then fine with me to include. I would ask though that you add information on how many cores, GB of memory etc are expected to be used and how long the parfile would run to completion.

  4. Roland Haas
    • removed comment

    The BBH example was added by Ian in git hash 81fb8ec "Import GW150914.rpar from website repository" on Mon Jan 29 15:46:24 2018 +0100 .

    Keeping this ticket open for the other gallery examples:

  5. Log in to comment