aitomic.nomad_nmr.Client¶
- class aitomic.nomad_nmr.Client(url, username, password, auth_token, timeout=5.0)[source]¶
Client for interacting with a NOMAD server.
Use the methods on the client send requests to the NOMAD server.
Examples
- Parameters:
Attributes
The URL of the NOMAD server.
The username to use for authentication.
The password to use for authentication.
The authentication token to use for requests.
The timeout for requests.
Methods
Make the client use a new authentication token.
Get a collection of auto experiments.
Get the groups on the server.
Create a new client by logging into the NOMAD server.
Get the users on the server.
- auth()[source]¶
Make the client use a new authentication token.
Examples
- Raises:
requests.HTTPError – If the authentication request fails.
- Return type:
None
- auto_experiments(query=None)[source]¶
Get a collection of auto experiments.
Examples
- Parameters:
query (AutoExperimentQuery | None) – The query to use for filtering the experiments.
- Returns:
The collection of auto experiments.
- Raises:
requests.HTTPError – If the request fails.
- Return type:
- static login(url, *, username, password, timeout=5.0)[source]¶
Create a new client by logging into the NOMAD server.
Examples