Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feature/SOF-7166 Add tutorial for Python Transformation #264

Merged
merged 14 commits into from
Jan 17, 2024

Conversation

VsevolodX
Copy link
Member

No description provided.

Copy link

netlify bot commented Jan 7, 2024

Deploy Preview for mat3ra ready!

Name Link
🔨 Latest commit 88d806f
🔍 Latest deploy log https://app.netlify.com/sites/mat3ra/deploys/65a5db093c6515000823f19f
😎 Deploy Preview https://deploy-preview-264--mat3ra.netlify.app/tutorials/materials/interface-with-python
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@@ -0,0 +1,100 @@
# Create an Interface with Python Transformation

In this tutorial, you will learn how to create an interface between two materials using the Python Transformation feature. Specifically, we will explore the creation of an interface between Graphene and Ni(111).
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In this tutorial, we create an interface


In this tutorial, you will learn how to create an interface between two materials using the Python Transformation feature. Specifically, we will explore the creation of an interface between Graphene and Ni(111).

## Open Materials Designer
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Step 0: Open Materials Designer


We start with [opening](../../entities-general/actions/create.md) an instance of the [Materials Designer Interface](../../materials-designer/overview.md) for creating and designing new [Materials structures](../../materials/overview.md) on our platform.

## Import Materials from Standata
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Step 1: Import Materials

- Graphene and Ni should now be available in the materials list.
<img src="/images/tutorials/interface_with_python/graphene_and_ni_imported.png" alt="Gr and Ni available in materials list"/>

## Use Python Transformation Dialog
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Step 2: Use Python Transformation Dialog

# Mind the strain that is introduced by this operation.
"scale_layer_to_fit": False,
}
```
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's remove the settings - it's already in the code. Maybe add a screenshot instead, if not there

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Screenshot won't fit all settings for that screen size.

- `Output Materials` will update with the newly created structure.
<img src="/images/tutorials/interface_with_python/after_run.png" alt="Results of code execution: strain matrix and output materials"/>

- Review the resulting strain matrix, if satisfied, submit the form to add the interface to your materials collection.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This needs a picture with resulting material


- Review the resulting strain matrix, if satisfied, submit the form to add the interface to your materials collection.

## **Key Considerations**
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Move to the top and use !note (see examples in other pages)

@VsevolodX VsevolodX merged commit df84b89 into master Jan 17, 2024
10 checks passed
@VsevolodX VsevolodX deleted the feature/SOF0-7166 branch January 17, 2024 17:07
pranabdas pushed a commit that referenced this pull request Oct 17, 2024
feature/SOF-7166 Add tutorial for Python Transformation
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants