Skip to content

Commit 9c3956a

Browse files
Merge pull request #333 from Exabyte-io/chore/SOF-7666
update: colors, icons, cleanups
2 parents cfefb5d + 8ccc0f4 commit 9c3956a

File tree

5 files changed

+107
-67
lines changed

5 files changed

+107
-67
lines changed

images/logo/favicon.ico

-1.12 KB
Binary file not shown.

images/logo/favicon.svg

Lines changed: 19 additions & 0 deletions
Loading

lang/en/docs/index.md

Lines changed: 39 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -1,42 +1,52 @@
1-
# Mat3ra Documentation
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.
1+
Mat3ra is a platform for materials modeling from the atoms up. This documentation explains how to use the platform to
2+
design new materials and predict their properties using physics-based and AI/ML models powered by cloud HPC.
83

4+
!!!note "Migrating to the New Platform (Q4 2025)"
5+
Existing users: see [Migrating to the New Platform](migrating-to-new-platform.md) for timelines and guidance.
96

107
## Quick start
118

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-
9+
- [Run your first simulation (web)](getting-started/run-first-simulation/web-interface.md)
10+
- [Run your first CLI job](getting-started/run-first-simulation/cli-job.md)
11+
- [Content highlights](getting-started/content-highlights.md)
12+
13+
## Popular topics
14+
15+
- **Access the platform**: [Platform access guide](tutorials/platform-access.md)
16+
- **Jobs via CLI**: [Overview](jobs-cli/overview.md) · Batch scripts
17+
([Overview](jobs-cli/batch-scripts/overview.md),
18+
[General structure](jobs-cli/batch-scripts/general-structure.md),
19+
[Directives](jobs-cli/batch-scripts/directives.md),
20+
[Working directory](jobs-cli/batch-scripts/directories.md),
21+
[Apptainer & Modules](jobs-cli/batch-scripts/apptainer.md),
22+
[Samples](jobs-cli/batch-scripts/sample-scripts.md))
23+
- **Remote connection**: [SSH](remote-connection/ssh.md) · [Web Terminal](remote-connection/web-terminal.md) ·
24+
[Remote Desktop](remote-connection/remote-desktop.md)
25+
- **Data locations and quotas**: [Data on disk: directories](data-on-disk/directories.md) ·
26+
[Quotas](data-on-disk/quotas.md)
27+
- **Clusters**: [Overview](infrastructure/clusters/overview.md) ·
28+
[Cluster-101 (free tier)](infrastructure/clusters/cluster-101.md) ·
29+
[AWS](infrastructure/clusters/aws.md) · [Azure](infrastructure/clusters/azure.md) ·
30+
[GCP](infrastructure/clusters/google.md)
31+
- **Materials**: [Overview](materials/overview.md) · [Import from files](materials/import-from-files.md)
32+
- **Models**: [DFT overview](models-directory/dft/overview.md)
33+
- **Properties**: [Overview](properties/overview.md) · [Band structure](properties-directory/non-scalar/bandstructure.md)
34+
- **Workflows**: [Overview](workflows/overview.md) · [Designer](workflow-designer/overview.md)
35+
- **REST API**: [Overview](rest-api/overview.md)
1436

1537
## Searching
1638

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-
39+
Use the search box at the top to quickly find specific topics across the documentation.
2140

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.
41+
## How this site is organized
2542

43+
The left sidebar is the global table of contents. Click any top-level item to expand sections. For a high-level tour of
44+
major features, see [Content highlights](getting-started/content-highlights.md).
2645

2746
## Support
2847

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:support@mat3ra.com" target="_blank">support@mat3ra.com</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:support@mat3ra.com" target="_blank">contact us</a>.
37-
38-
39-
## Links
48+
We respond to support requests within 24 hours during working hours (Pacific Time). See
49+
[Help & Support](other/support.md) for ways to get assistance.
4050

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)
51+
!!! tip "Help us improve"
52+
If something is missing or unclear, please open the [Help & Support](other/support.md) page and get in touch.
Lines changed: 47 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -1,32 +1,44 @@
1-
# Migrating to the New Mat3ra Platform (Q4 2025)
1+
# Migrating to The New Platform (Q4 2025)
22

33
> Last updated Oct 7, 2025.
44
5-
We are excited to announce the immediate availability of the new iteration of the Mat3ra platform. This is a significant upgrade over previous monthly releases and introduces new infrastructure, compute options, and improvements to the overall user experience.
5+
We are excited to announce the immediate availability of the new iteration of the Mat3ra platform. This is a significant
6+
upgrade over previous monthly releases and introduces new infrastructure, compute options, and improvements to the
7+
overall user experience.
68

7-
!!! note "Important": For a smooth transition, both the old and the new platform versions will remain operational through the end of 2025. See the timeline below.
9+
!!!note "Important": For a smooth transition, both the old and the new platform versions will remain operational
10+
through the end of 2025. See the timeline below.
811

912
---
1013

1114
## What’s New
1215

13-
- **Free compute tier (cluster-101)**
14-
- A new always-available free tier via `cluster-101`.
15-
- Read more: [Free Tier and Community Access](other/community-programs.md) and [Cluster-101](infrastructure/clusters/cluster-101.md).
16+
### Free compute tier (cluster-101)
1617

17-
- **New cloud infrastructure setup**
18-
- Google Cloud Platform via `cluster-001` — see [GCP clusters](infrastructure/clusters/google.md)
19-
- Amazon Web Services via `cluster-002` — see [AWS clusters](infrastructure/clusters/aws.md)
20-
- Microsoft Azure via `cluster-003` — see [Azure clusters](infrastructure/clusters/azure.md)
21-
- Updated set of instance types across providers, including larger CPU and GPU options
18+
A new always-available free tier via `cluster-101`. Read
19+
more: [Free Tier and Community Access](other/community-programs.md)
20+
and [Cluster-101](infrastructure/clusters/cluster-101.md).
2221

23-
- **Operating system upgrade**
24-
- Base OS updated to RHEL 9 across the new platform infrastructure
22+
### New cloud infrastructure setup
2523

26-
- **Apptainer-based application deployment**
27-
- Modernized packaging and runtime isolation for scientific applications
28-
- See: [Jobs via Command Line](jobs-cli/overview.md) for updated CLI usage and examples
29-
- We welcome contributions for additional applications your workflows require
24+
As below:
25+
26+
- Google Cloud Platform via `cluster-001` — see [GCP clusters](infrastructure/clusters/google.md)
27+
- Amazon Web Services via `cluster-002` — see [AWS clusters](infrastructure/clusters/aws.md)
28+
- Microsoft Azure via `cluster-003` — see [Azure clusters](infrastructure/clusters/azure.md)
29+
- Updated set of instance types across providers, including larger CPU and GPU options
30+
31+
### Operating system upgrade
32+
33+
Base OS updated to RHEL 9 across the new platform infrastructure
34+
35+
### Apptainer-based application deployment
36+
37+
As below:
38+
39+
- Modernized packaging and runtime isolation for scientific applications
40+
- See: [Jobs via Command Line](jobs-cli/batch-scripts/apptainer.md) for updated CLI usage and examples
41+
- We welcome contributions for additional applications your workflows require
3042

3143
---
3244

@@ -43,28 +55,30 @@ You can sign in to the new platform with the same credentials you use for the cu
4355

4456
## Migration Timeline
4557

46-
- **Now → Oct 31, 2025**
47-
- Both old and new platforms are live. You can explore and begin migrating at your convenience.
58+
- **Now → Oct 31, 2025**:
59+
- Both old and new platforms are live. You can explore and begin migrating at your convenience.
4860

4961
- **On/after Nov 1, 2025**
50-
- `https://platform.mat3ra.com` will route to the new platform
51-
- The old platform will remain accessible at `https://platform-old.mat3ra.com`
52-
- Equivalent routing changes will apply to related URLs (docs, login)
62+
- `https://platform.mat3ra.com` will route to the new platform
63+
- The old platform will remain accessible at `https://platform-old.mat3ra.com`
64+
- Equivalent routing changes will apply to related URLs (docs, login)
5365

5466
- **On/after Jan 1, 2026**
55-
- Only the new platform will remain available
67+
- Only the new platform will remain available
5668

5769
---
5870

5971
## What Gets Migrated Automatically
6072

61-
- Application data stored in the platform database (entities, metadata, workflows, settings) is migrated automatically.
73+
Application data stored in the platform database (entities, metadata, workflows, settings) is migrated automatically.
6274

6375
## What Does NOT Migrate Automatically
6476

65-
- Runtime files and bulk data stored on disk do not migrate automatically. Due to updated infrastructure libraries and layout in the new environment, data migration from legacy cluster homes and shares is handled on a case-by-case basis.
77+
Runtime files and bulk data stored on disk do not migrate automatically. Due to updated infrastructure libraries and
78+
layout in the new environment, data migration from legacy cluster homes and shares is handled on a case-by-case basis.
6679

67-
> Tip: Review data locations under [Data on Disk > Directory Structure](data-on-disk/directories.md) and [Infrastructure > Login Node Directories](infrastructure/login/directories.md) to plan your migration.
80+
> Tip: Review data locations under [Data on Disk > Directory Structure](data-on-disk/directories.md)
81+
> and [Infrastructure > Login Node Directories](infrastructure/login/directories.md) to plan your migration.
6882
6983
---
7084

@@ -78,15 +92,12 @@ You can sign in to the new platform with the same credentials you use for the cu
7892

7993
## CLI and Environment Modules with Apptainer
8094

81-
See examples of module loading, `$EXEC_CMD`, and containerized execution in: [Apptainer and Environment Modules](jobs-cli/batch-scripts/apptainer.md)
82-
83-
### Using in job scripts
84-
85-
As below:
86-
87-
```
95+
See examples of module loading, `$EXEC_CMD`, and containerized execution
96+
in: [Apptainer and Environment Modules](jobs-cli/batch-scripts/apptainer.md)
8897

89-
## Contact and Support
98+
## Contact Support
9099

91-
- For migration help (data movement, cluster selection, workflow updates), contact your Mat3ra representative or reach us via Support Widget in the platform header or `support@mat3ra.com`.
92-
- If you require a specific application or environment, please let us know — we welcome contributions and requests to expand supported software.
100+
- For migration help (data movement, cluster selection, workflow updates), contact your Mat3ra representative or reach
101+
us via Support Widget in the platform header or `support@mat3ra.com`.
102+
- If you require a specific application or environment, please let us know — we welcome contributions and requests to
103+
expand supported software.

mkdocs.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -86,7 +86,7 @@ theme:
8686
primary: deep purple
8787
accent: deep purple
8888
logo: "images/logo/logo-white.png"
89-
favicon: "images/logo/favicon.ico"
89+
favicon: "images/logo/favicon.svg"
9090
icon:
9191
edit: material/pencil
9292
repo: fontawesome/brands/github
@@ -121,7 +121,7 @@ plugins:
121121

122122
nav:
123123
- Home: index.md
124-
- Migrating to New Platform, Q4.2025: migrating-to-new-platform.md
124+
- Migrating to New Platform: migrating-to-new-platform.md
125125

126126
# INTRODUCTION
127127
- Getting Started:

0 commit comments

Comments
 (0)