|
1 | 1 | # Mat3ra Documentation |
2 | 2 |
|
3 | | -[**Mat3ra**](https://platform.mat3ra.com) is a cloud-native accessible and collaborative platform for materials modeling from the atomic scale. Our platform makes it easier for scientists, engineers, and researchers to **design new materials** and **predict their properties** using *first-principles* approaches and *AI/ML* techniques. |
4 | | - |
5 | | -First-principles approach does not require any knowledge of experimental observations, instead solely takes into account the atomistic description of material (e.g., constituent atoms, crystal structure, lattice constant, etc.) to compute desired properties thanks to [Density Functional Theory](https://en.wikipedia.org/wiki/Density_functional_theory){:target='_blank'} and its numerical implementations. When enough data is present, the AI/ML techniques can be applied to discover trends and accelerate predictions. Our platform also helps users collaborate, share and gather obtained knowledge with others. |
6 | | - |
7 | | -The present documentation explains how the platform works in detail. |
| 3 | +Mat3ra is a platform for materials modeling from the atoms up. This documentation explains how to use the platform to |
| 4 | +design new materials and predict their properties using physics-based and AI/ML models powered by cloud HPC. |
8 | 5 |
|
| 6 | +!!!note "Migrating to the New Platform (Q4 2025)" |
| 7 | + Existing users: see [Migrating to the New Platform](migrating-to-new-platform.md) for timelines and guidance. |
9 | 8 |
|
10 | 9 | ## Quick start |
11 | 10 |
|
12 | | -You can skip straight to our tutorial summarizing [first steps](getting-started/run-first-simulation/web-interface.md). There you will learn how to set up and run [density functional theory](models-directory/dft/overview.md) calculation to obtain [electronic band structure](properties-directory/non-scalar/bandstructure.md) of silicon, a semiconducting material widely used in making electronic chips. |
13 | | - |
| 11 | +- [Run your first simulation (web)](getting-started/run-first-simulation/web-interface.md) |
| 12 | +- [Run your first CLI job](getting-started/run-first-simulation/cli-job.md) |
| 13 | +- [Content highlights](getting-started/content-highlights.md) |
| 14 | + |
| 15 | +## Popular topics |
| 16 | + |
| 17 | +- **Access the platform**: [Platform access guide](tutorials/platform-access.md) |
| 18 | +- **Jobs via CLI**: [Overview](jobs-cli/overview.md) · Batch scripts |
| 19 | + ([Overview](jobs-cli/batch-scripts/overview.md), |
| 20 | + [General structure](jobs-cli/batch-scripts/general-structure.md), |
| 21 | + [Directives](jobs-cli/batch-scripts/directives.md), |
| 22 | + [Working directory](jobs-cli/batch-scripts/directories.md), |
| 23 | + [Apptainer & Modules](jobs-cli/batch-scripts/apptainer.md), |
| 24 | + [Samples](jobs-cli/batch-scripts/sample-scripts.md)) |
| 25 | +- **Remote connection**: [SSH](remote-connection/ssh.md) · [Web Terminal](remote-connection/web-terminal.md) · |
| 26 | + [Remote Desktop](remote-connection/remote-desktop.md) |
| 27 | +- **Data locations and quotas**: [Data on disk: directories](data-on-disk/directories.md) · |
| 28 | + [Quotas](data-on-disk/quotas.md) |
| 29 | +- **Clusters**: [Overview](infrastructure/clusters/overview.md) · |
| 30 | + [Cluster-101 (free tier)](infrastructure/clusters/cluster-101.md) · |
| 31 | + [AWS](infrastructure/clusters/aws.md) · [Azure](infrastructure/clusters/azure.md) · |
| 32 | + [GCP](infrastructure/clusters/google.md) |
| 33 | +- **Materials**: [Overview](materials/overview.md) · [Import from files](materials/import-from-files.md) |
| 34 | +- **Models**: [DFT overview](models-directory/dft/overview.md) |
| 35 | +- **Properties**: [Overview](properties/overview.md) · [Band structure](properties-directory/non-scalar/bandstructure.md) |
| 36 | +- **Workflows**: [Overview](workflows/overview.md) · [Designer](workflow-designer/overview.md) |
| 37 | +- **REST API**: [Overview](rest-api/overview.md) |
14 | 38 |
|
15 | 39 | ## Searching |
16 | 40 |
|
17 | | -If you are looking for a specific topic of interest, please use the search box on top to quickly locate relevant pages. |
18 | | - |
19 | | -The [Links](#links) section below lists resources containing more in-depth explanations about what we are building and why[^1] and example case studies[^2]. |
20 | | - |
| 41 | +Use the search box at the top to quickly find specific topics across the documentation. |
21 | 42 |
|
22 | | -## Contents |
23 | | - |
24 | | -The navigation bar on the left serves as the table of contents for the whole documentation while the table of contents on the right lists content headers under the current page. You may click on any top-level items on the left sidebar to expand the corresponding section. The [content highlights page](getting-started/content-highlights.md) has a brief overview of various features available in Mat3ra platform and links to them. |
| 43 | +## How this site is organized |
25 | 44 |
|
| 45 | +The left sidebar is the global table of contents. Click any top-level item to expand sections. For a high-level tour of |
| 46 | +major features, see [Content highlights](getting-started/content-highlights.md). |
26 | 47 |
|
27 | 48 | ## Support |
28 | 49 |
|
29 | | -We reply to support requests within 24 hours. Our team can be contacted during working hours Pacific Time through: |
30 | | - |
31 | | -- Email: < a href= "mailto:[email protected]" target= "_blank"> [email protected]</ a> |
32 | | -- Phone: +1 (510) 473-7770 |
33 | | -- Via web widget: click **Support** button at the bottom of our <a href="https://platform.mat3ra.com" target="_blank">web application</a>. |
34 | | - |
35 | | -!!! tip "Let us hear your feedback" |
36 | | - In case you find that something is missing or if you still have questions after reading this documentation, please < a class= "text-muted" href= "mailto:[email protected]" target= "_blank">contact us</ a>. |
37 | | - |
38 | | - |
39 | | -## Links |
| 50 | +We respond to support requests within 24 hours during working hours (Pacific Time). See |
| 51 | +[Help & Support](other/support.md) for ways to get assistance. |
40 | 52 |
|
41 | | -[^1]: [What is materials discovery cloud, article](https://www.linkedin.com/pulse/how-we-design-world-tomorrow-what-materials-discovery-timur-bazhirov) |
42 | | -[^2]: [Mat3ra: case studies](https://mat3ra.com/case-studies) |
| 53 | +!!! tip "Help us improve" |
| 54 | +If something is missing or unclear, please open the [Help & Support](other/support.md) page and get in touch. |
0 commit comments