matgraph-cli-docs / index.html
Himan-de's picture
Upload folder using huggingface_hub
cd5edae verified
Raw
History Blame Contribute Delete
4.26 kB
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>MatGraph CLI | Trinetra Labs</title>
<style>
body {
font-family: 'Inter', -apple-system, BlinkMacSystemFont, 'Segoe UI', Roboto, Helvetica, Arial, sans-serif;
line-height: 1.6;
color: #333;
max-width: 800px;
margin: 0 auto;
padding: 2rem;
background-color: #fcfcfc;
}
h1 {
color: #2c3e50;
font-size: 2.5rem;
margin-bottom: 0.5rem;
}
h2 {
color: #34495e;
margin-top: 2rem;
border-bottom: 2px solid #ecf0f1;
padding-bottom: 0.5rem;
}
.subtitle {
font-size: 1.2rem;
color: #7f8c8d;
margin-bottom: 2rem;
}
.code-block {
background-color: #282c34;
color: #abb2bf;
padding: 1rem;
border-radius: 8px;
overflow-x: auto;
font-family: 'Courier New', Courier, monospace;
}
.btn {
display: inline-block;
background-color: #3498db;
color: white;
padding: 0.8rem 1.5rem;
text-decoration: none;
border-radius: 5px;
margin-top: 1rem;
font-weight: bold;
transition: background-color 0.3s;
}
.btn:hover {
background-color: #2980b9;
}
.btn-github {
background-color: #333;
}
.btn-github:hover {
background-color: #111;
}
.feature-list {
margin-top: 1rem;
}
.feature-list li {
margin-bottom: 0.5rem;
}
footer {
margin-top: 4rem;
text-align: center;
color: #95a5a6;
font-size: 0.9rem;
}
</style>
</head>
<body>
<h1>🔬 MatGraph CLI</h1>
<div class="subtitle">A modern CLI and GraphQL API tool for Material Science Deep Learning Pipelines, powered by Trinetra Labs.</div>
<p>MatGraph CLI replaces the outdated, bloated ML implementations in materials science with a sleek, universal interface. It natively wraps the state-of-the-art <strong>M3GNet Universal Potentials</strong> developed by the Materials Virtual Lab.</p>
<a href="https://pypi.org/project/matgraph-cli/" class="btn" target="_blank">View on PyPI</a>
<a href="https://github.com/Himan-D/matgraph-cli" class="btn btn-github" target="_blank">GitHub Repository</a>
<h2>🚀 Quick Start</h2>
<p>Install via pip and set up your Materials Project API key in seconds:</p>
<div class="code-block">
pip install matgraph-cli<br><br>
# Persistently save your API key (No more 'export' commands!)<br>
matgraph setup YOUR_MP_API_KEY
</div>
<h2>✨ Key Features</h2>
<ul class="feature-list">
<li><strong>Thermodynamic Stability:</strong> Instantly predict Formation Energy and Band Gaps.</li>
<li><strong>Structural Relaxation:</strong> Perform ASE Geometry Optimization using M3GNet.</li>
<li><strong>Generative Discovery:</strong> Simulate elemental substitution (e.g., swapping Li for Na in LiFePO4) to discover stable alternatives.</li>
<li><strong>X-Ray Diffraction:</strong> Simulate accurate Cu-Ka XRD patterns.</li>
<li><strong>Phonon DOS:</strong> Fetch exact Phonon Density of States for thermodynamic properties.</li>
<li><strong>Blazing Fast:</strong> Zero-config SQLite local caching and highly optimized lazy loading.</li>
</ul>
<h2>💻 Example Usage</h2>
<p>Predict the properties of a material using the CLI:</p>
<div class="code-block">
matgraph predict LiFePO4 --model m3gnet
</div>
<p>Or perform generative elemental substitution (Inverse Design):</p>
<div class="code-block">
matgraph substitute LiFePO4 Li Na
</div>
<footer>
&copy; 2026 Trinetra Labs. All rights reserved.<br>
Built with ❤️ for the Material Science community.
</footer>
</body>
</html>