Ouro
  • Docs
  • Blog
  • Pricing
  • Teams
Sign inJoin for free
  • Teams
  • Search
Assets
  • Quests
  • Posts
  • APIs
  • Data
  • Teams
  • Search
Assets
  • Quests
  • Posts
  • APIs
  • Data
4mo

MMD-17

File documentation

Learn how to interact with this file using the Ouro SDK or REST API.

API access requires an API key. Create one in Settings → API Keys, then set OURO_API_KEY in your environment.

Retrieve file

Get file metadata including name, visibility, description, file size, and other asset properties.

import os
from ouro import Ouro
 
# Set OURO_API_KEY in your environment or replace os.environ.get("OURO_API_KEY")
ouro = Ouro(api_key=os.environ.get("OURO_API_KEY"))
 
file_id = "10b9fd50-622e-41ca-8ae8-903f2b2abcfc"
 
# Retrieve file metadata
file = ouro.files.retrieve(file_id)
print(file.name, file.visibility)
print(file.metadata)

Read file data

Get a URL to download or embed the file. For private assets, the URL is temporary and will expire after 1 hour.

# Get signed URL to download the file
file_data = file.read_data()
print(file_data.url)
 
# Download the file using requests
import requests
response = requests.get(file_data.url)
with open('downloaded_file', 'wb') as output_file:
    output_file.write(response.content)

Update file

Update file metadata (name, description, visibility, etc.) and optionally replace the file data with a new file. Requires write or admin permission.

# Update file metadata
updated = ouro.files.update(
    id=file_id,
    name="Updated file name",
    description="Updated description",
    visibility="private"
)
 
# Update file data with a new file
updated = ouro.files.update(
    id=file_id,
    file_path="./new_file.txt"
)

Delete file

Permanently delete a file from the platform. Requires admin permission. This action cannot be undone.

# Delete a file (requires admin permission)
ouro.files.delete(id=file_id)

    Calculate energy above hull

    file.cif→file.html
    9mo
    2.4k uses

    Predict the Curie temperature of a material

    file.cif→JSON
    1y
    2.3k uses

    Calculate the estimated raw material cost per kg

    file.cif→JSON
    9mo
    1.6k uses

    Relax a crystal structure

    file.cif→file.cif
    9mo
    1.5k uses

    Calculate magnetic saturation and related properties

    file.cif→JSON
    10mo
    767 uses

    Calculate phonon dispersion and return band structure plot

    file.cif→file.png
    9mo
    564 uses

    Create a supercell from a material

    file.cif→file.cif
    11mo
    123 uses

    Get basic structural information from a CIF file

    file.cif→JSON
    10mo
    119 uses

    Estimate ZT and key thermoelectric properties

    file.cif→JSON
    20d
    76 uses

    Relax a crystal structure with animation

    file.cif→file.mp4
    8mo
    22 uses

    Create interstitially doped structure

    file.cif→file.cif
    8mo
    21 uses

    Structure relaxation via NequIP-OAM-XL

    file.cif→file.cif
    20d
    19 uses

    Relax a crystal structure and create a post

    file.cif→post
    8mo
    14 uses

    Get a detailed description of a crystal structure

    file.cif→JSON
    8mo
    12 uses

    Predict formation energy per atom (MP dataset)

    file.cif→JSON
    15d
    11 uses

    Predict total magnetic moment per cell

    file.cif→JSON
    15d
    10 uses

    Predict Seebeck coefficient and band gap

    file.cif→JSON
    20d
    10 uses

    Calculate magnetic anisotropy energy

    file.cif→JSON
    4mo
    6 uses

    Predict energy above the convex hull

    file.cif→JSON
    15d
    6 uses

    Synthesis report from CIF file

    file.cif→file.html
    2mo
    5 uses

    Predict superconducting critical temperature

    file.cif→JSON
    15d
    4 uses

    Check phonon stability

    file.cif→file.png
    20d
    2 uses

    Predict band gap using the TBmBJ functional

    file.cif→JSON
    15d
    2 uses

    Predict static dielectric function (εx)

    file.cif→JSON
    15d
    1 use

    Predict average electron effective mass

    file.cif→JSON
    15d
    1 use

    Predict electronic dielectric function (ε∞x)

    file.cif→JSON
    15d

    Predict maximum dielectric constant from DFPT

    file.cif→JSON
    15d

    Predict maximum piezoelectric strain coefficient dij

    file.cif→JSON
    15d

    Predict Voigt bulk modulus

    file.cif→JSON
    15d

    Predict Voigt shear modulus

    file.cif→JSON
    15d

    Predict exfoliation energy for layered materials

    file.cif→JSON
    15d

    Predict n-type Seebeck coefficient

    file.cif→JSON
    15d

    Predict p-type Seebeck coefficient

    file.cif→JSON
    15d

    Predict n-type thermoelectric power factor

    file.cif→JSON
    15d

    Predict maximum electric field gradient

    file.cif→JSON
    15d

    Predict electronic DOS at Fermi level

    file.cif→JSON
    15d

    Predict Debye temperature for superconductor analysis

    file.cif→JSON
    15d

    Predict Eliashberg spectral function α²F(ω)

    file.cif→JSON
    15d

    Predict phonon density of states

    file.cif→JSON
    15d

    Predict optimal k-point length for DFT convergence

    file.cif→JSON
    15d

    Predict oxygen adsorption energy (TinNet)

    file.cif→JSON
    15d

    Predict nitrogen adsorption energy (TinNet)

    file.cif→JSON
    15d

    Predict OH adsorption energy (TinNet)

    file.cif→JSON
    15d

    Predict oxygen adsorption energy (AGRA)

    file.cif→JSON
    15d

    Predict OH adsorption energy (AGRA)

    file.cif→JSON
    15d

    Predict CHO adsorption energy (AGRA)

    file.cif→JSON
    15d

    Predict CO adsorption energy (AGRA)

    file.cif→JSON
    15d

    Predict COOH adsorption energy (AGRA)

    file.cif→JSON
    15d

    Predict adsorption energy (OCP 2020 full)

    file.cif→JSON
    15d

    Predict adsorption energy (OCP 2020, 100k subset)

    file.cif→JSON
    15d

    Predict adsorption energy (OCP 2020, 10k subset)

    file.cif→JSON
    15d

    Predict internal energy at 0 K (molecules)

    file.cif→JSON
    15d

    Predict internal energy at 298.15 K (molecules)

    file.cif→JSON
    15d

    Predict isotropic polarizability (molecules)

    file.cif→JSON
    15d

    Predict HOMO-LUMO gap (molecules)

    file.cif→JSON
    15d

    Predict free energy at 298.15 K (molecules)

    file.cif→JSON
    15d

    Predict HOMO orbital energy (molecules)

    file.cif→JSON
    15d

    Predict LUMO orbital energy (molecules)

    file.cif→JSON
    15d

    Predict zero-point vibrational energy (molecules)

    file.cif→JSON
    15d

    Predict CO₂ adsorption at 5 pressures (MOFs)

    file.cif→JSON
    15d

    Predict maximum CO₂ adsorption capacity (MOFs)

    file.cif→JSON
    15d

    Predict gravimetric surface area (MOFs)

    file.cif→JSON
    15d

    Predict volumetric surface area (MOFs)

    file.cif→JSON
    15d

    Predict pore limiting diameter (MOFs)

    file.cif→JSON
    15d

    Predict largest cavity diameter (MOFs)

    file.cif→JSON
    15d

    Predict void fraction (MOFs)

    file.cif→JSON
    15d

    Estimate minimum lattice thermal conductivity

    file.cif→JSON
    20d

    Predict PBE band gap (MP dataset)

    file.cif→JSON
    15d

    Predict spin-orbit spillage (topological indicator)

    file.cif→JSON
    15d

    Predict spectroscopic limited maximum efficiency

    file.cif→JSON
    15d

    Predict average hole effective mass

    file.cif→JSON
    15d

    Predict conduction band minimum

    file.cif→JSON
    15d

    Predict valence band maximum

    file.cif→JSON
    15d

    Predict work function

    file.cif→JSON
    15d

    Predict formation energy per atom (optB88vdW)

    file.cif→JSON
    15d

    Predict total energy per atom (optB88vdW)

    file.cif→JSON
    15d

    Predict band gap using the optB88vdW functional

    file.cif→JSON
    15d
No more results
1.46 KB
.cif file
magmat.herokuapp.com/info/mmd-17
CC-BY-4.0 license