# mmtoolkit

**Repository Path**: weeshin/mmtoolkit

## Basic Information

- **Project Name**: mmtoolkit
- **Description**: Toolkit for Microstructure-based Modelling
- **Primary Language**: Python
- **License**: GPL-3.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 1
- **Forks**: 0
- **Created**: 2020-08-28
- **Last Updated**: 2022-06-06

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# mmtoolkit

Toolkit for Microstructure-based Modelling


## 使用说明
### 安装
使用`pip`进行安装：
```
pip install mmtoolkit
```
在国内网络环境可以通过`pypi`镜像进行安装，例如：
```
pip install -i https://pypi.tuna.tsinghua.edu.cn/simple mmtoolkit
```

如果使用`anaconda`发行版，可切换至需要安装的虚拟环境，再使用`pip`进行安装：
```
conda activate myenv
python -m pip install -i https://pypi.tuna.tsinghua.edu.cn/simple mmtoolkit
```

### 安装测试
```
import mmtoolkit as mmt

mmt.test()
```

如果安装成功便可输出下方图片。

![输入图片说明](https://images.gitee.com/uploads/images/2020/1001/145708_9dab0446_7853830.png "test_re.png")