diff --git a/README.md b/README.md index 97869d3..e04eb1b 100644 --- a/README.md +++ b/README.md @@ -1,75 +1,9 @@ - +Greetings, we are from the MPOD team at the Center for Advanced Materials Research, and here is a brief description of our database. -# OPTIMADE Providers Index Meta-Database +The Material Properties Open Database (MPOD) is a web-based, open access repository of quantitative information about the physical properties of crystalline materials. -The list of providers is published as an [OPTIMADE](https://www.optimade.org/) Index Meta-Database here: [https://providers.optimade.org/](https://providers.optimade.org/) +MPOD is oriented to design engineers, scientists, science teachers and students. Properties are generally treated as tensor magnitudes. In MPOD the compact matrix notation is applied. To bring an intuitive view of tensor properties, so-called longitudinal properties surfaces are displayed. -You can obtain the list of providers in a machine-readable format following the [OPTIMADE specification for Index Meta-Databases](https://github.com/Materials-Consortia/OPTIMADE/blob/master/optimade.rst#index-meta-database) by using the following URL: +3D printing of properties surfaces is implemented via creation of stl files. -- [https://providers.optimade.org/v1/links](https://providers.optimade.org/v1/links) - -where `v1` is currently the latest version and can be replaced with any major version name of the OPTIMADE specification. - -For convenience, you can also access the most recent list of providers in the format mandated by the latest version of the OPTIMADE specification directly at this URL: - -- [https://providers.optimade.org/providers.json](https://providers.optimade.org/providers.json) - -Additionally, there is a providers dashboard that includes the results of validation of listed implementations. -This can be accessed at the following URL: - -- [https://optimade.org/providers-dashboard](https://optimade.org/providers-dashboard) - -You can contribute a new provider or amend the current information by creating a pull request to [the `providers` repository](https://github.com/Materials-Consortia/providers). - -## Repository organization - -The OPTIMADE providers repository is hosted here: [https://github.com/Materials-Consortia/providers](https://github.com/Materials-Consortia/providers) - -The repository is organized this way: - -- `/src/links//providers.json` is the current providers.json file formatted according to OPTIMADE version `` and any later version that uses a format that is backward compatible with this version. - -- `/src/info//info.json` is the proper response to the info endpoint formatted according to OPTIMADE version `` and any later version that uses a format that is backward compatible with this version. - -- `/src/index-metadbs///info.json` and `/src/index-metadbs///links.json` are static Index Meta-Databases that are hosted in this repository for those providers that only have one main sub-database (or very few sub-databases) and do not wish to maintain one on their own. - See more details and instructions in `/src/index-metadbs/README.md`. - -- `/_redirects` specifies http rewrites to map index meta-database URLs `//info` and `//links` to the corresponding files under `src/`, as well as `/providers.json`. - It also creates `/index-metadbs///info.json` and `/index-metadbs///links.json` URLs to point to the corresponding files in the `/src/index-metadbs` subfolders. - This is used by the deploy tool Netlify. - -Presently, only the `v1` version of the formats exist. -Hence, to update the list of providers, file a pull-request against the repository to edit `/src/links/v1/providers.json`. - -## Requirements to be listed in this providers list - -It is a policy of this providers list ([providers.optimade.org](http://providers.optimade.org)) that links inside `providers.json` must be links to an [OPTIMADE Index Meta-Database](https://github.com/Materials-Consortia/OPTIMADE/blob/master/optimade.rst#index-meta-database). - -If you only have one or few databases in your implementation, and you do not want to host an Index Meta-Database yourself, you can host the Index Meta-Database directly in this repository. -You can find instructions [here](./src/index-metadbs). - -## Fork this repository to set up an index meta-database for your own databases - -- Click on the Fork button in GitHub and follow the instructions. - -- Edit `/src/info/v1/info.json` with your information: - - - Make sure to update the URL in `available_api_versions` to point at your hosting location. - -- Copy the file `src/index-metadbs/exmpl/v1/links.json` to `/src/info/v1/links.json` and edit this template to supply information about your own databases. - -- Edit `README.md` to say who you are and what databases you provide. - -- Remove the directory 'src/static-index-metadbs' - -- Configure your hosting provider to use your forked repository. - The repository presently contains configuration files for Netlify, which you can set up as follows: - - - Deploy using the Netlify *Continuous Deployment: GitHub App* option, and give it access to your forked repository with the following settings: - - - Build commmand: `jekyll build` - - Publish directory: `_site/` - - - You are also recommended to configure a subdomain in *Domain settings* at Netlify, or setup your own custom domain. - -- If you are a provider of OPTIMADE databases and you have set up the index meta-database to point at them, please post a pull-request against [https://github.com/Materials-Consortia/providers](https://github.com/Materials-Consortia/providers) to add the URL for your index meta-database to the central OPTIMADE providers list. +A dictionary of properties definitions is included. Eventually, comments are added. Syntax and notation in MPOD files is oriented towards matching IUCr standards and so tries to comply with CIF format. diff --git a/src/info/v1/info.json b/src/info/v1/info.json index f257c60..3fda0d2 100644 --- a/src/info/v1/info.json +++ b/src/info/v1/info.json @@ -15,7 +15,7 @@ "api_version": "1.0.0", "available_api_versions": [ { - "url": "https://www.optimade.org/providers/optimade/v1/", + "url": "http://mpod_optimade.cimav.edu.mx/", "version": "1.0.0" } ], diff --git a/src/info/v1/links.json b/src/info/v1/links.json new file mode 100644 index 0000000..84811b3 --- /dev/null +++ b/src/info/v1/links.json @@ -0,0 +1,34 @@ +{ + "meta" : { + "api_version" : "1.0.0", + "query" : { + "representation" : "/links" + }, + "more_data_available" : false, + "schema" : "https://schemas.optimade.org/openapi/v1.0/optimade_index.json" + }, + "data" : [ + { + "id" : "mpod", + "type" : "links", + "attributes" : { + "name": "Material Properties Open Database (MPOD)", + "description": "MPOD is a web-based, open access repository of quantitative information about the physical properties of crystalline materials.", + "base_url": "http://mpod_optimade.cimav.edu.mx/", + "homepage": "http://mpod.cimav.edu.mx/", + "link_type": "child" + } + }, + { + "id" : "optimade-providers", + "type" : "links", + "attributes" : { + "name": "OPTIMADE Providers Index Meta-Database", + "description": "The list of OPTIMADE providers maintained by Materials-Consortia", + "base_url": "https://providers.optimade.org", + "homepage": "https://www.optimade.org", + "link_type": "providers" + } + } + ] +}