MEIDNet / site /reference /cli.html
Babu09's picture
Deploy MEIDNet Studio
17c0e18 verified
Raw History Blame Contribute Delete
39.6 kB
<!doctype html>
<html lang="en" class="no-js">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width,initial-scale=1">
<meta name="description" content="Multimodal inverse design of crystalline materials — with your own data, rules and families.">
<link rel="canonical" href="https://babu09-meidnet.hf.space/docs/reference/cli.html">
<link rel="prev" href="../examples/double-perovskite.html">
<link rel="next" href="config.html">
<link rel="icon" href="../assets/favicon-64.png">
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.7.6">
<title>Command line - MEIDNet Prism</title>
<link rel="stylesheet" href="../assets/stylesheets/main.484c7ddc.min.css">
<link rel="stylesheet" href="../assets/stylesheets/palette.ab4e12ef.min.css">
<link rel="stylesheet" href="../assets/extra.css">
<link rel="stylesheet" href="../assets/prism-docs.css">
<script>__md_scope=new URL("..",location),__md_hash=e=>[...e].reduce(((e,_)=>(e<<5)-e+_.charCodeAt(0)),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
</head>
<body dir="ltr" data-md-color-scheme="default" data-md-color-primary="custom" data-md-color-accent="custom">
<input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off">
<input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">
<label class="md-overlay" for="__drawer"></label>
<div data-md-component="skip">
<a href="#command-line" class="md-skip">
Skip to content
</a>
</div>
<div data-md-component="announce">
</div>
<header class="md-header" data-md-component="header">
<nav class="md-header__inner md-grid" aria-label="Header">
<a href="../index.html" title="MEIDNet Prism" class="md-header__button md-logo" aria-label="MEIDNet Prism" data-md-component="logo">
<img src="../assets/prism-mark.png" alt="logo">
</a>
<label class="md-header__button md-icon" for="__drawer">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M3 6h18v2H3zm0 5h18v2H3zm0 5h18v2H3z"/></svg>
</label>
<div class="md-header__title" data-md-component="header-title">
<div class="md-header__ellipsis">
<div class="md-header__topic">
<span class="md-ellipsis">
MEIDNet Prism
</span>
</div>
<div class="md-header__topic" data-md-component="header-topic">
<span class="md-ellipsis">
Command line
</span>
</div>
</div>
</div>
<form class="md-header__option" data-md-component="palette">
<input class="md-option" data-md-color-media="(prefers-color-scheme: light)" data-md-color-scheme="default" data-md-color-primary="custom" data-md-color-accent="custom" aria-label="dark mode" type="radio" name="__palette" id="__palette_0">
<label class="md-header__button md-icon" title="dark mode" for="__palette_1" hidden>
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="m17.75 4.09-2.53 1.94.91 3.06-2.63-1.81-2.63 1.81.91-3.06-2.53-1.94L12.44 4l1.06-3 1.06 3zm3.5 6.91-1.64 1.25.59 1.98-1.7-1.17-1.7 1.17.59-1.98L15.75 11l2.06-.05L18.5 9l.69 1.95zm-2.28 4.95c.83-.08 1.72 1.1 1.19 1.85-.32.45-.66.87-1.08 1.27C15.17 23 8.84 23 4.94 19.07c-3.91-3.9-3.91-10.24 0-14.14.4-.4.82-.76 1.27-1.08.75-.53 1.93.36 1.85 1.19-.27 2.86.69 5.83 2.89 8.02a9.96 9.96 0 0 0 8.02 2.89m-1.64 2.02a12.08 12.08 0 0 1-7.8-3.47c-2.17-2.19-3.33-5-3.49-7.82-2.81 3.14-2.7 7.96.31 10.98 3.02 3.01 7.84 3.12 10.98.31"/></svg>
</label>
<input class="md-option" data-md-color-media="(prefers-color-scheme: dark)" data-md-color-scheme="slate" data-md-color-primary="custom" data-md-color-accent="custom" aria-label="light mode" type="radio" name="__palette" id="__palette_1">
<label class="md-header__button md-icon" title="light mode" for="__palette_0" hidden>
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 7a5 5 0 0 1 5 5 5 5 0 0 1-5 5 5 5 0 0 1-5-5 5 5 0 0 1 5-5m0 2a3 3 0 0 0-3 3 3 3 0 0 0 3 3 3 3 0 0 0 3-3 3 3 0 0 0-3-3m0-7 2.39 3.42C13.65 5.15 12.84 5 12 5s-1.65.15-2.39.42zM3.34 7l4.16-.35A7.2 7.2 0 0 0 5.94 8.5c-.44.74-.69 1.5-.83 2.29zm.02 10 1.76-3.77a7.131 7.131 0 0 0 2.38 4.14zM20.65 7l-1.77 3.79a7.02 7.02 0 0 0-2.38-4.15zm-.01 10-4.14.36c.59-.51 1.12-1.14 1.54-1.86.42-.73.69-1.5.83-2.29zM12 22l-2.41-3.44c.74.27 1.55.44 2.41.44.82 0 1.63-.17 2.37-.44z"/></svg>
</label>
</form>
<script>var palette=__md_get("__palette");if(palette&&palette.color){if("(prefers-color-scheme)"===palette.color.media){var media=matchMedia("(prefers-color-scheme: light)"),input=document.querySelector(media.matches?"[data-md-color-media='(prefers-color-scheme: light)']":"[data-md-color-media='(prefers-color-scheme: dark)']");palette.color.media=input.getAttribute("data-md-color-media"),palette.color.scheme=input.getAttribute("data-md-color-scheme"),palette.color.primary=input.getAttribute("data-md-color-primary"),palette.color.accent=input.getAttribute("data-md-color-accent")}for(var[key,value]of Object.entries(palette.color))document.body.setAttribute("data-md-color-"+key,value)}</script>
<label class="md-header__button md-icon" for="__search">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.52 6.52 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5"/></svg>
</label>
<div class="md-search" data-md-component="search" role="dialog">
<label class="md-search__overlay" for="__search"></label>
<div class="md-search__inner" role="search">
<form class="md-search__form" name="search">
<input type="text" class="md-search__input" name="query" aria-label="Search" placeholder="Search" autocapitalize="off" autocorrect="off" autocomplete="off" spellcheck="false" data-md-component="search-query" required>
<label class="md-search__icon md-icon" for="__search">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.52 6.52 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5"/></svg>
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11z"/></svg>
</label>
<nav class="md-search__options" aria-label="Search">
<button type="reset" class="md-search__icon md-icon" title="Clear" aria-label="Clear" tabindex="-1">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M19 6.41 17.59 5 12 10.59 6.41 5 5 6.41 10.59 12 5 17.59 6.41 19 12 13.41 17.59 19 19 17.59 13.41 12z"/></svg>
</button>
</nav>
<div class="md-search__suggest" data-md-component="search-suggest"></div>
</form>
<div class="md-search__output">
<div class="md-search__scrollwrap" tabindex="0" data-md-scrollfix>
<div class="md-search-result" data-md-component="search-result">
<div class="md-search-result__meta">
Initializing search
</div>
<ol class="md-search-result__list" role="presentation"></ol>
</div>
</div>
</div>
</div>
</div>
<div class="md-header__source">
<a href="https://github.com/ABnano/MEIDNet" title="Go to repository" class="md-source" data-md-component="source">
<div class="md-source__icon md-icon">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><!--! Font Awesome Free 7.1.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2025 Fonticons, Inc.--><path d="M439.6 236.1 244 40.5c-5.4-5.5-12.8-8.5-20.4-8.5s-15 3-20.4 8.4L162.5 81l51.5 51.5c27.1-9.1 52.7 16.8 43.4 43.7l49.7 49.7c34.2-11.8 61.2 31 35.5 56.7-26.5 26.5-70.2-2.9-56-37.3L240.3 199v121.9c25.3 12.5 22.3 41.8 9.1 55-6.4 6.4-15.2 10.1-24.3 10.1s-17.8-3.6-24.3-10.1c-17.6-17.6-11.1-46.9 11.2-56v-123c-20.8-8.5-24.6-30.7-18.6-45L142.6 101 8.5 235.1C3 240.6 0 247.9 0 255.5s3 15 8.5 20.4l195.6 195.7c5.4 5.4 12.7 8.4 20.4 8.4s15-3 20.4-8.4l194.7-194.7c5.4-5.4 8.4-12.8 8.4-20.4s-3-15-8.4-20.4"/></svg>
</div>
<div class="md-source__repository">
ABnano/MEIDNet
</div>
</a>
</div>
</nav>
</header>
<div class="md-container" data-md-component="container">
<nav class="md-tabs" aria-label="Tabs" data-md-component="tabs">
<div class="md-grid">
<ul class="md-tabs__list">
<li class="md-tabs__item">
<a href="../index.html" class="md-tabs__link">
Home
</a>
</li>
<li class="md-tabs__item">
<a href="../learn/index.html" class="md-tabs__link">
Learn
</a>
</li>
<li class="md-tabs__item">
<a href="../learn/architectures.html" class="md-tabs__link">
Architectures
</a>
</li>
<li class="md-tabs__item">
<a href="../use/studio.html" class="md-tabs__link">
Build
</a>
</li>
<li class="md-tabs__item">
<a href="../explore/datasets.html" class="md-tabs__link">
Datasets
</a>
</li>
<li class="md-tabs__item">
<a href="../benchmarks/index.html" class="md-tabs__link">
Benchmarks
</a>
</li>
<li class="md-tabs__item">
<a href="../community/contribute.html" class="md-tabs__link">
Community
</a>
</li>
<li class="md-tabs__item">
<a href="../start/quickstart.html" class="md-tabs__link">
Guides
</a>
</li>
<li class="md-tabs__item md-tabs__item--active">
<a href="cli.html" class="md-tabs__link">
Reference
</a>
</li>
<li class="md-tabs__item">
<a href="../research/paper.html" class="md-tabs__link">
About
</a>
</li>
</ul>
</div>
</nav>
<main class="md-main" data-md-component="main">
<div class="md-main__inner md-grid">
<div class="md-sidebar md-sidebar--primary" data-md-component="sidebar" data-md-type="navigation" >
<div class="md-sidebar__scrollwrap">
<div class="md-sidebar__inner">
<nav class="md-nav md-nav--primary md-nav--lifted" aria-label="Navigation" data-md-level="0">
<label class="md-nav__title" for="__drawer">
<a href="../index.html" title="MEIDNet Prism" class="md-nav__button md-logo" aria-label="MEIDNet Prism" data-md-component="logo">
<img src="../assets/prism-mark.png" alt="logo">
</a>
MEIDNet Prism
</label>
<div class="md-nav__source">
<a href="https://github.com/ABnano/MEIDNet" title="Go to repository" class="md-source" data-md-component="source">
<div class="md-source__icon md-icon">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><!--! Font Awesome Free 7.1.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2025 Fonticons, Inc.--><path d="M439.6 236.1 244 40.5c-5.4-5.5-12.8-8.5-20.4-8.5s-15 3-20.4 8.4L162.5 81l51.5 51.5c27.1-9.1 52.7 16.8 43.4 43.7l49.7 49.7c34.2-11.8 61.2 31 35.5 56.7-26.5 26.5-70.2-2.9-56-37.3L240.3 199v121.9c25.3 12.5 22.3 41.8 9.1 55-6.4 6.4-15.2 10.1-24.3 10.1s-17.8-3.6-24.3-10.1c-17.6-17.6-11.1-46.9 11.2-56v-123c-20.8-8.5-24.6-30.7-18.6-45L142.6 101 8.5 235.1C3 240.6 0 247.9 0 255.5s3 15 8.5 20.4l195.6 195.7c5.4 5.4 12.7 8.4 20.4 8.4s15-3 20.4-8.4l194.7-194.7c5.4-5.4 8.4-12.8 8.4-20.4s-3-15-8.4-20.4"/></svg>
</div>
<div class="md-source__repository">
ABnano/MEIDNet
</div>
</a>
</div>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../index.html" class="md-nav__link">
<span class="md-ellipsis">
Home
</span>
</a>
</li>
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2" >
<label class="md-nav__link" for="__nav_2" id="__nav_2_label" tabindex="0">
<span class="md-ellipsis">
Learn
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_2_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_2">
<span class="md-nav__icon md-icon"></span>
Learn
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../learn/index.html" class="md-nav__link">
<span class="md-ellipsis">
Learn multimodality
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../learn/recipes.html" class="md-nav__link">
<span class="md-ellipsis">
Recipes by problem
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="../learn/architectures.html" class="md-nav__link">
<span class="md-ellipsis">
Architectures
</span>
</a>
</li>
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4" >
<label class="md-nav__link" for="__nav_4" id="__nav_4_label" tabindex="0">
<span class="md-ellipsis">
Build
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_4">
<span class="md-nav__icon md-icon"></span>
Build
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../use/studio.html" class="md-nav__link">
<span class="md-ellipsis">
MEIDNet Studio
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../use/explore-3d.html" class="md-nav__link">
<span class="md-ellipsis">
Explore in 3D
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../use/reports.html" class="md-nav__link">
<span class="md-ellipsis">
Reading the reports
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_5" >
<label class="md-nav__link" for="__nav_5" id="__nav_5_label" tabindex="0">
<span class="md-ellipsis">
Datasets
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_5_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_5">
<span class="md-nav__icon md-icon"></span>
Datasets
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../explore/datasets.html" class="md-nav__link">
<span class="md-ellipsis">
Datasets
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../explore/databases.html" class="md-nav__link">
<span class="md-ellipsis">
Databases by application
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../explore/capabilities.html" class="md-nav__link">
<span class="md-ellipsis">
Capabilities
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_6" >
<label class="md-nav__link" for="__nav_6" id="__nav_6_label" tabindex="0">
<span class="md-ellipsis">
Benchmarks
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_6_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_6">
<span class="md-nav__icon md-icon"></span>
Benchmarks
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../benchmarks/index.html" class="md-nav__link">
<span class="md-ellipsis">
MEIDNet Benchmarks
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../benchmarks/perov5.html" class="md-nav__link">
<span class="md-ellipsis">
Perov-5
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../benchmarks/perov5-reproduction.html" class="md-nav__link">
<span class="md-ellipsis">
Perov-5: alignment across seeds
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../benchmarks/perov5-insights.html" class="md-nav__link">
<span class="md-ellipsis">
Perov-5: what the runs show
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../benchmarks/perov5-guide.html" class="md-nav__link">
<span class="md-ellipsis">
Perov-5: choose a model and generate
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../benchmarks/mp20.html" class="md-nav__link">
<span class="md-ellipsis">
MP-20
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../benchmarks/carbon24.html" class="md-nav__link">
<span class="md-ellipsis">
Carbon-24
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_7" >
<label class="md-nav__link" for="__nav_7" id="__nav_7_label" tabindex="0">
<span class="md-ellipsis">
Community
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_7_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_7">
<span class="md-nav__icon md-icon"></span>
Community
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../community/contribute.html" class="md-nav__link">
<span class="md-ellipsis">
Contribute a result
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../community/index.html" class="md-nav__link">
<span class="md-ellipsis">
Community results
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../community/help.html" class="md-nav__link">
<span class="md-ellipsis">
Getting help
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_8" >
<label class="md-nav__link" for="__nav_8" id="__nav_8_label" tabindex="0">
<span class="md-ellipsis">
Guides
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_8_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_8">
<span class="md-nav__icon md-icon"></span>
Guides
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../start/quickstart.html" class="md-nav__link">
<span class="md-ellipsis">
5-minute quickstart
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../start/what-data.html" class="md-nav__link">
<span class="md-ellipsis">
What data do I need?
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../start/colab.html" class="md-nav__link">
<span class="md-ellipsis">
Run in Colab
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../use/your-data.html" class="md-nav__link">
<span class="md-ellipsis">
Bring your own dataset
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../use/config.html" class="md-nav__link">
<span class="md-ellipsis">
The configuration file
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../recipes/change-targets.html" class="md-nav__link">
<span class="md-ellipsis">
Change the target properties
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../recipes/add-property.html" class="md-nav__link">
<span class="md-ellipsis">
Add a property
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../recipes/elements.html" class="md-nav__link">
<span class="md-ellipsis">
Exclude or restrict elements
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../recipes/change-family.html" class="md-nav__link">
<span class="md-ellipsis">
Change the material family
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../recipes/add-constraint.html" class="md-nav__link">
<span class="md-ellipsis">
Add a rule (constraint)
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../recipes/screen.html" class="md-nav__link">
<span class="md-ellipsis">
Screen stability with MACE
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../understand/how-it-works.html" class="md-nav__link">
<span class="md-ellipsis">
How MEIDNet works
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../understand/interpretability.html" class="md-nav__link">
<span class="md-ellipsis">
Interpreting a candidate
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../understand/limits.html" class="md-nav__link">
<span class="md-ellipsis">
Scope and roadmap
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../examples/perov5.html" class="md-nav__link">
<span class="md-ellipsis">
Perov-5 (the paper)
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../examples/double-perovskite.html" class="md-nav__link">
<span class="md-ellipsis">
Double perovskites
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item md-nav__item--active md-nav__item--section md-nav__item--nested">
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_9" checked>
<label class="md-nav__link" for="__nav_9" id="__nav_9_label" tabindex="">
<span class="md-ellipsis">
Reference
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_9_label" aria-expanded="true">
<label class="md-nav__title" for="__nav_9">
<span class="md-nav__icon md-icon"></span>
Reference
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item md-nav__item--active">
<input class="md-nav__toggle md-toggle" type="checkbox" id="__toc">
<a href="cli.html" class="md-nav__link md-nav__link--active">
<span class="md-ellipsis">
Command line
</span>
</a>
</li>
<li class="md-nav__item">
<a href="config.html" class="md-nav__link">
<span class="md-ellipsis">
Configuration
</span>
</a>
</li>
<li class="md-nav__item">
<a href="families.html" class="md-nav__link">
<span class="md-ellipsis">
Family files
</span>
</a>
</li>
<li class="md-nav__item">
<a href="rules.html" class="md-nav__link">
<span class="md-ellipsis">
Rules and search terms
</span>
</a>
</li>
<li class="md-nav__item">
<a href="api.html" class="md-nav__link">
<span class="md-ellipsis">
Python API
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_10" >
<label class="md-nav__link" for="__nav_10" id="__nav_10_label" tabindex="0">
<span class="md-ellipsis">
About
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_10_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_10">
<span class="md-nav__icon md-icon"></span>
About
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../research/paper.html" class="md-nav__link">
<span class="md-ellipsis">
Paper and citation
</span>
</a>
</li>
</ul>
</nav>
</li>
</ul>
</nav>
</div>
</div>
</div>
<div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
<div class="md-sidebar__scrollwrap">
<div class="md-sidebar__inner">
<nav class="md-nav md-nav--secondary" aria-label="Table of contents">
</nav>
</div>
</div>
</div>
<div class="md-content" data-md-component="content">
<article class="md-content__inner md-typeset">
<h1 id="command-line">Command line<a class="headerlink" href="#command-line" title="Permanent link">&para;</a></h1>
<div class="highlight"><pre><span></span><code>meidnet init write a starter meidnet.yaml next to your data
meidnet check CONFIG is my data usable? → check_report.html
meidnet train CONFIG learn the latent space → model.pt, training_report.html
meidnet generate CONFIG design candidates → CIFs, generation_report.html
meidnet studio [CONFIG] interactive workbench in your browser
meidnet space CONFIG every composition of the family with rule values and predictions → CSV
meidnet demo quick demo with the published perovskite model
meidnet screen DIR stability screening of CIFs with MACE (optional extra)
meidnet info MODEL describe a checkpoint
meidnet families [NAME] list / describe material families
meidnet schema JSON Schema of the config (for editors and the Studio)
meidnet download-data fetch the Perov-5 dataset used in the paper
</code></pre></div>
<p><code>meidnet &lt;command&gt; --help</code> lists the options. Useful ones:</p>
<table>
<thead>
<tr>
<th></th>
<th></th>
</tr>
</thead>
<tbody>
<tr>
<td><code>init --template perov5</code></td>
<td>the paper's configuration instead of a blank one</td>
</tr>
<tr>
<td><code>train --epochs N</code></td>
<td>override <code>training.epochs</code></td>
</tr>
<tr>
<td><code>generate --quick</code></td>
<td>few rounds and steps — a smoke test</td>
</tr>
<tr>
<td><code>generate --model PATH</code></td>
<td>use another checkpoint</td>
</tr>
<tr>
<td><code>studio --export-static FILE.html</code></td>
<td>self-contained Studio for a website</td>
</tr>
<tr>
<td><code>studio --port 8765 --no-open</code></td>
<td>choose the port; do not open a browser</td>
</tr>
<tr>
<td><code>studio --public --host 0.0.0.0</code></td>
<td>host the Studio for other people: private session per visitor, capped budgets</td>
</tr>
<tr>
<td><code>studio --run-root DIR --docs-dir site</code></td>
<td>where sessions and searches are written; serve a built docs site at <code>/docs/</code></td>
</tr>
<tr>
<td><code>space --chemiscope FILE.json</code></td>
<td>also write the design space as a <a href="../use/explore-3d.html">3D dataset</a> for chemiscope.org</td>
</tr>
<tr>
<td><code>demo --family oxide --band-gap 3 --enthalpy -0.2 -n 5</code></td>
<td>demo targets</td>
</tr>
</tbody>
</table>
<p>If <code>meidnet</code> is not on your PATH, <code>python -m meidnet.cli …</code> is equivalent.</p>
</article>
</div>
<script>var tabs=__md_get("__tabs");if(Array.isArray(tabs))e:for(var set of document.querySelectorAll(".tabbed-set")){var labels=set.querySelector(".tabbed-labels");for(var tab of tabs)for(var label of labels.getElementsByTagName("label"))if(label.innerText.trim()===tab){var input=document.getElementById(label.htmlFor);input.checked=!0;continue e}}</script>
<script>var target=document.getElementById(location.hash.slice(1));target&&target.name&&(target.checked=target.name.startsWith("__tabbed_"))</script>
</div>
<button type="button" class="md-top md-icon" data-md-component="top" hidden>
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M13 20h-2V8l-5.5 5.5-1.42-1.42L12 4.16l7.92 7.92-1.42 1.42L13 8z"/></svg>
Back to top
</button>
</main>
<footer class="md-footer">
<div class="md-footer-meta md-typeset">
<div class="md-footer-meta__inner md-grid">
<div class="md-copyright">
<div class="md-copyright__highlight">
MIT licence · Anand Babu
</div>
Made with
<a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
Material for MkDocs
</a>
</div>
</div>
</div>
</footer>
</div>
<div class="md-dialog" data-md-component="dialog">
<div class="md-dialog__inner md-typeset"></div>
</div>
<script id="__config" type="application/json">{"annotate": null, "base": "..", "features": ["navigation.tabs", "navigation.sections", "navigation.top", "content.code.copy", "content.tabs.link", "search.suggest"], "search": "../assets/javascripts/workers/search.2c215733.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": null}</script>
<script src="../assets/javascripts/bundle.79ae519e.min.js"></script>
<script src="https://unpkg.com/mathjax@3/es5/tex-mml-chtml.js"></script>
<script src="https://unpkg.com/tablesort@5.3.0/dist/tablesort.min.js"></script>
<script src="https://unpkg.com/tablesort@5.3.0/dist/sorts/tablesort.number.min.js"></script>
<script src="../assets/tablesort.js"></script>
<script src="../assets/learn.js"></script>
<script src="../assets/links.js"></script>
<script src="../assets/prism3d.js"></script>
<script src="../assets/prism-tour.js"></script>
<script src="../assets/prism-docs.js"></script>
<script src="/ask-prism.js"></script>
</body>
</html>