utils¶
This submodule implements some useful utilities for dealing with OPTIMADE providers that can be used in server or client code.
PROVIDER_LIST_URLS = ('https://providers.optimade.org/v1/links', 'https://raw.githubusercontent.com/Materials-Consortia/providers/master/src/links/v1/providers.json')
module-attribute
¶
LinksResource
¶
Bases: EntryResource
A Links endpoint resource object
Source code in optimade/models/links.py
98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 |
|
get_all_databases(include_providers=None, exclude_providers=None, exclude_databases=None, progress=None)
¶
Iterate through all databases reported by registered OPTIMADE providers.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
include_providers |
Optional[Container[str]]
|
A set/container of provider IDs to include child databases for. |
None
|
exclude_providers |
Optional[Container[str]]
|
A set/container of provider IDs to exclude child databases for. |
None
|
exclude_databases |
Optional[Container[str]]
|
A set/container of specific database URLs to exclude. |
None
|
Returns:
Type | Description |
---|---|
Iterable[str]
|
A generator of child database links that obey the given parameters. |
Source code in optimade/utils.py
169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 |
|
get_child_database_links(provider, obey_aggregate=True, headers=None)
¶
For a provider, return a list of available child databases.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
provider |
LinksResource
|
The links entry for the provider. |
required |
obey_aggregate |
bool
|
Whether to only return links that allow aggregation. |
True
|
headers |
Optional[dict]
|
Additional HTTP headers to pass to the provider. |
None
|
Returns:
Type | Description |
---|---|
list[LinksResource]
|
A list of the valid links entries from this provider that |
list[LinksResource]
|
have |
Raises:
Type | Description |
---|---|
RuntimeError
|
If the provider's index meta-database is down, invalid, or the request otherwise fails. |
Source code in optimade/utils.py
108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 |
|
get_providers(add_mongo_id=False)
¶
Retrieve Materials-Consortia providers (from https://providers.optimade.org/v1/links).
Fallback order if providers.optimade.org is not available:
- Try Materials-Consortia/providers on GitHub.
- Try submodule
providers
' list of providers. - Log warning that providers list from Materials-Consortia is not included in the
/links
-endpoint.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
add_mongo_id |
bool
|
Whether to populate the |
False
|
Returns:
Type | Description |
---|---|
list
|
List of raw JSON-decoded providers including MongoDB object IDs. |
Source code in optimade/utils.py
37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 |
|
mongo_id_for_database(database_id, database_type)
¶
Produce a MongoDB ObjectId for a database
Source code in optimade/utils.py
24 25 26 27 28 29 30 31 32 33 34 |
|