geoscixyz / em

Electromagnetic methods in geophysics - open educational resources.
http://em.geosci.xyz
Creative Commons Attribution 4.0 International
67 stars 65 forks source link

Case History Landing Page #300

Closed lheagy closed 8 years ago

lheagy commented 8 years ago

The index page for the case histories would benefit from being more visual and having more info on each case history present. Perhaps this is accomplished in an manner similar to the contributors page (using the contributors.json)

image

The casehistories.json (from which the page could be auto-generated) could be:

{
    "mtisa":{
        "title":"Mt. Isa",
        "application":"Mining",
        "thumbnail":"mtisa.png",
        "citation":"rutley2001",
        "categories":["DC", "IP"],
        "contributors":{
            "authors": ["fourndo", "krisdavis"],
            "reviewers": "dwo"
    }
}

What is nice about having data structured like this is that eventually, we can also query by any of the fields (eg. categories, applications, etc). In addition, the html index page would be auto generated, so it could be improved independent of adding case histories.

lheagy commented 8 years ago

After chatting with @rowanc1, a better format might be

{
    "mtisa":{
        "title":"Mt. Isa",
        "thumbnail":"mtisa.png",
        "citations":["rutley2001"],
        "contributors":[
            {"uid":"fourndo", "role":"author"}, 
            {"uid":"krisdavis", "role":"author"},  
            {"uid":"dwo", "role":"reviewer"}
        ],
        "tags":[
            {"uid":"DC", "as":"category"},
            {"uid":"IP", "as":"category"}, 
            {"uid":"Mining", "as":"application"}
        ]
    }
}

This is essentially building a graph database (we will be able to sort and visualize case histories that are tagged as being mining applications or in the category of DC)

lheagy commented 8 years ago

two additions: keywords should be included, as should the directory containing the case history. Perhaps also the methods are tagged as "geophysical_surveys" (and these must correspond to geophysical surveys that are documented in em geosci

{
    "mtisa":{
        "title":"Mt. Isa",
        "source":"./mtisa/",
        "thumbnail":"mtisa.png",
        "citations":["rutley2001"],
        "contributors":[
            {"uid":"fourndo", "role":"author"}, 
            {"uid":"krisdavis", "role":"author"},  
            {"uid":"dwo", "role":"reviewer"}
        ],
        "tags":[
            {"uid":"DC", "as":"geophysical_survey"},
            {"uid":"IP", "as":"geophysical_survey"}, 
            {"uid":"Mining", "as":"application"},
        ],
        "keywords":["shale"]
    }
}

thoughts @dougoldenburg, @rowanc1 ?

lheagy commented 8 years ago

closed in #332