From 83f27f31165550e937eb287c0d4c892ee8de77df Mon Sep 17 00:00:00 2001 From: Timur Bazhirov Date: Wed, 8 Oct 2025 20:25:59 -0700 Subject: [PATCH 1/3] update: colors, icons, cleanups --- images/logo/favicon.ico | Bin 1150 -> 0 bytes images/logo/favicon.svg | 19 +++++ lang/en/docs/migrating-to-new-platform.md | 83 ++++++++++++---------- mkdocs.yml | 4 +- 4 files changed, 68 insertions(+), 38 deletions(-) delete mode 100644 images/logo/favicon.ico create mode 100644 images/logo/favicon.svg diff --git a/images/logo/favicon.ico b/images/logo/favicon.ico deleted file mode 100644 index e8f843742907d922f206ea1cca21f54968810913..0000000000000000000000000000000000000000 GIT binary patch literal 0 HcmV?d00001 literal 1150 zcmbu8Pb)-W6o=2CMq@+Dmawo@43c~p8;i+;n%Pk7d(7Fjo;m0Jo%5Ub+a`wN zfJ4}V2~bZh?L614*<-IBy&Lcd?>XnhF(~`htff9ZdhZKbsk6!1Tf=k$e zZWw_xNY`VoX3ZXZ_2`Y(WIHy<$8*hnlQ%^*`|WAup3Gmbb)Yq28q|LCyRW@^l7Eie z`*r}HiJ#`LQQL=GmBomgdx>*ZaKye|mqb7ZIJupK;^$ QO2lSghPj_|U-cs51OFd9KL7v# diff --git a/images/logo/favicon.svg b/images/logo/favicon.svg new file mode 100644 index 000000000..1c189c0a9 --- /dev/null +++ b/images/logo/favicon.svg @@ -0,0 +1,19 @@ + + + + + + + + diff --git a/lang/en/docs/migrating-to-new-platform.md b/lang/en/docs/migrating-to-new-platform.md index 35055aa9e..7fe8da2ba 100644 --- a/lang/en/docs/migrating-to-new-platform.md +++ b/lang/en/docs/migrating-to-new-platform.md @@ -1,32 +1,44 @@ -# Migrating to the New Mat3ra Platform (Q4 2025) +# Migrating to The New Platform (Q4 2025) > Last updated Oct 7, 2025. -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. +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. -!!! 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. +!!! 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. --- ## What’s New -- **Free compute tier (cluster-101)** - - A new always-available free tier via `cluster-101`. - - Read more: [Free Tier and Community Access](other/community-programs.md) and [Cluster-101](infrastructure/clusters/cluster-101.md). +### Free compute tier (cluster-101) -- **New cloud infrastructure setup** - - Google Cloud Platform via `cluster-001` — see [GCP clusters](infrastructure/clusters/google.md) - - Amazon Web Services via `cluster-002` — see [AWS clusters](infrastructure/clusters/aws.md) - - Microsoft Azure via `cluster-003` — see [Azure clusters](infrastructure/clusters/azure.md) - - Updated set of instance types across providers, including larger CPU and GPU options +A new always-available free tier via `cluster-101`. Read +more: [Free Tier and Community Access](other/community-programs.md) +and [Cluster-101](infrastructure/clusters/cluster-101.md). -- **Operating system upgrade** - - Base OS updated to RHEL 9 across the new platform infrastructure +### New cloud infrastructure setup -- **Apptainer-based application deployment** - - Modernized packaging and runtime isolation for scientific applications - - See: [Jobs via Command Line](jobs-cli/overview.md) for updated CLI usage and examples - - We welcome contributions for additional applications your workflows require +As below: + +- Google Cloud Platform via `cluster-001` — see [GCP clusters](infrastructure/clusters/google.md) +- Amazon Web Services via `cluster-002` — see [AWS clusters](infrastructure/clusters/aws.md) +- Microsoft Azure via `cluster-003` — see [Azure clusters](infrastructure/clusters/azure.md) +- Updated set of instance types across providers, including larger CPU and GPU options + +### Operating system upgrade + +Base OS updated to RHEL 9 across the new platform infrastructure + +### Apptainer-based application deployment + +As below: + +- Modernized packaging and runtime isolation for scientific applications +- See: [Jobs via Command Line](jobs-cli/batch-scripts/apptainer.md) for updated CLI usage and examples +- We welcome contributions for additional applications your workflows require --- @@ -43,28 +55,30 @@ You can sign in to the new platform with the same credentials you use for the cu ## Migration Timeline -- **Now → Oct 31, 2025** - - Both old and new platforms are live. You can explore and begin migrating at your convenience. +- **Now → Oct 31, 2025**: + - Both old and new platforms are live. You can explore and begin migrating at your convenience. - **On/after Nov 1, 2025** - - `https://platform.mat3ra.com` will route to the new platform - - The old platform will remain accessible at `https://platform-old.mat3ra.com` - - Equivalent routing changes will apply to related URLs (docs, login) + - `https://platform.mat3ra.com` will route to the new platform + - The old platform will remain accessible at `https://platform-old.mat3ra.com` + - Equivalent routing changes will apply to related URLs (docs, login) - **On/after Jan 1, 2026** - - Only the new platform will remain available + - Only the new platform will remain available --- ## What Gets Migrated Automatically -- Application data stored in the platform database (entities, metadata, workflows, settings) is migrated automatically. +Application data stored in the platform database (entities, metadata, workflows, settings) is migrated automatically. ## What Does NOT Migrate Automatically -- 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. +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. -> 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. +> 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. --- @@ -78,15 +92,12 @@ You can sign in to the new platform with the same credentials you use for the cu ## CLI and Environment Modules with Apptainer -See examples of module loading, `$EXEC_CMD`, and containerized execution in: [Apptainer and Environment Modules](jobs-cli/batch-scripts/apptainer.md) - -### Using in job scripts - -As below: - -``` +See examples of module loading, `$EXEC_CMD`, and containerized execution +in: [Apptainer and Environment Modules](jobs-cli/batch-scripts/apptainer.md) -## Contact and Support +## Contact Support -- 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`. -- If you require a specific application or environment, please let us know — we welcome contributions and requests to expand supported software. +- 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`. +- If you require a specific application or environment, please let us know — we welcome contributions and requests to + expand supported software. diff --git a/mkdocs.yml b/mkdocs.yml index 79bdc1c12..58385ad21 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -86,7 +86,7 @@ theme: primary: indigo accent: indigo logo: "images/logo/logo-white.png" - favicon: "images/logo/favicon.ico" + favicon: "images/logo/favicon.svg" icon: edit: material/pencil repo: fontawesome/brands/github @@ -121,7 +121,7 @@ plugins: nav: - Home: index.md - - Migrating to New Platform, Q4.2025: migrating-to-new-platform.md + - Migrating to New Platform: migrating-to-new-platform.md # INTRODUCTION - Getting Started: From af91e10003ae76fa3183f3ba634f9421259e6891 Mon Sep 17 00:00:00 2001 From: Timur Bazhirov Date: Wed, 8 Oct 2025 21:49:24 -0700 Subject: [PATCH 2/3] update: index.md + migration --- lang/en/docs/index.md | 66 +++++++++++++---------- lang/en/docs/migrating-to-new-platform.md | 2 +- 2 files changed, 40 insertions(+), 28 deletions(-) diff --git a/lang/en/docs/index.md b/lang/en/docs/index.md index a3855224f..4fd665ccc 100644 --- a/lang/en/docs/index.md +++ b/lang/en/docs/index.md @@ -1,42 +1,54 @@ # Mat3ra Documentation -[**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. - -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. - -The present documentation explains how the platform works in detail. +Mat3ra is a platform for materials modeling from the atoms up. This documentation explains how to use the platform to +design new materials and predict their properties using physics-based and AI/ML models powered by cloud HPC. +!!!note "Migrating to the New Platform (Q4 2025)" + Existing users: see [Migrating to the New Platform](migrating-to-new-platform.md) for timelines and guidance. ## Quick start -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. - +- [Run your first simulation (web)](getting-started/run-first-simulation/web-interface.md) +- [Run your first CLI job](getting-started/run-first-simulation/cli-job.md) +- [Content highlights](getting-started/content-highlights.md) + +## Popular topics + +- **Access the platform**: [Platform access guide](tutorials/platform-access.md) +- **Jobs via CLI**: [Overview](jobs-cli/overview.md) · Batch scripts + ([Overview](jobs-cli/batch-scripts/overview.md), + [General structure](jobs-cli/batch-scripts/general-structure.md), + [Directives](jobs-cli/batch-scripts/directives.md), + [Working directory](jobs-cli/batch-scripts/directories.md), + [Apptainer & Modules](jobs-cli/batch-scripts/apptainer.md), + [Samples](jobs-cli/batch-scripts/sample-scripts.md)) +- **Remote connection**: [SSH](remote-connection/ssh.md) · [Web Terminal](remote-connection/web-terminal.md) · + [Remote Desktop](remote-connection/remote-desktop.md) +- **Data locations and quotas**: [Data on disk: directories](data-on-disk/directories.md) · + [Quotas](data-on-disk/quotas.md) +- **Clusters**: [Overview](infrastructure/clusters/overview.md) · + [Cluster-101 (free tier)](infrastructure/clusters/cluster-101.md) · + [AWS](infrastructure/clusters/aws.md) · [Azure](infrastructure/clusters/azure.md) · + [GCP](infrastructure/clusters/google.md) +- **Materials**: [Overview](materials/overview.md) · [Import from files](materials/import-from-files.md) +- **Models**: [DFT overview](models-directory/dft/overview.md) +- **Properties**: [Overview](properties/overview.md) · [Band structure](properties-directory/non-scalar/bandstructure.md) +- **Workflows**: [Overview](workflows/overview.md) · [Designer](workflow-designer/overview.md) +- **REST API**: [Overview](rest-api/overview.md) ## Searching -If you are looking for a specific topic of interest, please use the search box on top to quickly locate relevant pages. - -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]. - +Use the search box at the top to quickly find specific topics across the documentation. -## Contents - -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. +## How this site is organized +The left sidebar is the global table of contents. Click any top-level item to expand sections. For a high-level tour of +major features, see [Content highlights](getting-started/content-highlights.md). ## Support -We reply to support requests within 24 hours. Our team can be contacted during working hours Pacific Time through: - -- Email: support@mat3ra.com -- Phone: +1 (510) 473-7770 -- Via web widget: click **Support** button at the bottom of our web application. - -!!! tip "Let us hear your feedback" - In case you find that something is missing or if you still have questions after reading this documentation, please contact us. - - -## Links +We respond to support requests within 24 hours during working hours (Pacific Time). See +[Help & Support](other/support.md) for ways to get assistance. -[^1]: [What is materials discovery cloud, article](https://www.linkedin.com/pulse/how-we-design-world-tomorrow-what-materials-discovery-timur-bazhirov) -[^2]: [Mat3ra: case studies](https://mat3ra.com/case-studies) +!!! tip "Help us improve" +If something is missing or unclear, please open the [Help & Support](other/support.md) page and get in touch. diff --git a/lang/en/docs/migrating-to-new-platform.md b/lang/en/docs/migrating-to-new-platform.md index 7fe8da2ba..41daa23ac 100644 --- a/lang/en/docs/migrating-to-new-platform.md +++ b/lang/en/docs/migrating-to-new-platform.md @@ -6,7 +6,7 @@ We are excited to announce the immediate availability of the new iteration of th upgrade over previous monthly releases and introduces new infrastructure, compute options, and improvements to the overall user experience. -!!! note "Important": For a smooth transition, both the old and the new platform versions will remain operational +!!!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. --- From 8ccc0f4fd35cc7ff48056f4695a76a9e8c12a1b7 Mon Sep 17 00:00:00 2001 From: Timur Bazhirov Date: Wed, 8 Oct 2025 21:52:35 -0700 Subject: [PATCH 3/3] update: index.md --- lang/en/docs/index.md | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) diff --git a/lang/en/docs/index.md b/lang/en/docs/index.md index 4fd665ccc..7b083c4c9 100644 --- a/lang/en/docs/index.md +++ b/lang/en/docs/index.md @@ -1,5 +1,3 @@ -# Mat3ra Documentation - Mat3ra is a platform for materials modeling from the atoms up. This documentation explains how to use the platform to design new materials and predict their properties using physics-based and AI/ML models powered by cloud HPC. @@ -51,4 +49,4 @@ We respond to support requests within 24 hours during working hours (Pacific Tim [Help & Support](other/support.md) for ways to get assistance. !!! tip "Help us improve" -If something is missing or unclear, please open the [Help & Support](other/support.md) page and get in touch. + If something is missing or unclear, please open the [Help & Support](other/support.md) page and get in touch.