# pylineardesign

**Repository Path**: monash_li/pylineardesign

## Basic Information

- **Project Name**: pylineardesign
- **Description**: 这是一个手工实现lineardesign的项目。
- **Primary Language**: Python
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 2
- **Forks**: 0
- **Created**: 2023-07-10
- **Last Updated**: 2025-02-07

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# 项目名称

LinearDesign Algorithm 使用文档

## 简介

LinearDesign Algorithm 是一个用于优化 mRNA 序列的算法。它基于目标蛋白质序列和密码子使用频率表，通过动态规划算法生成优化的 mRNA 序列，以提高编码效率和表达效果。

## 安装要求

- Python 3.7+
- 安装所需的依赖项：`pip install -r requirements.txt`

## 使用方法

```shell
python main.py --codon_usage <codon_usage_file> --codon_table <codon_table_file> --protein_sequence <protein_sequence>
```

参数说明：

- `--codon_usage <codon_usage_file>`：指定密码子使用频率表的路径，默认为 `./data/codon_usage.csv`。
- `--codon_table <codon_table_file>`：指定密码子表的路径，默认为 `./data/codon_table.json`。
- `--protein_sequence <protein_sequence>`：指定目标蛋白质序列，默认为 `MADLWQLLLTLALAGSSDAFSGSEATAAILSRAPWSLQSVNP`。

## 示例

1. 使用默认参数运行 LinearDesign Algorithm：

```shell
python main.py
```

2. 指定密码子使用频率表和密码子表的路径，以及自定义的目标蛋白质序列：

```shell
python main.py --codon_usage ./data/my_codon_usage.csv --codon_table ./data/my_codon_table.json --protein_sequence MYPROTEIN
```

## 输出结果

LinearDesign Algorithm 将输出优化后的 mRNA 序列以及其对应的 CAI 和 MFE 值。

样例输出：

```
优化后的 mRNA 序列： AUGGGUCCCGAAGAGC...

优化后的 mRNA 序列的 CAI： 0.8

优化后的 mRNA 序列的 MFE： -26.3 kcal/mol/nt
```

## 常见问题

### 1. 如何获取密码子使用频率表和密码子表？

密码子使用频率表和密码子表可以从公共数据库或文献中获取，也可以根据实验室或组织内部的数据进行统计和分析。

### 2. 如何解读输出结果中的 CAI 和 MFE 值？

CAI（Codon Adaptation Index）反映了密码子序列与参考物种的适应性，值越高表示编码效率越高。

MFE（Minimum Free Energy）表示优化后的 mRNA 序列的二级结构稳定性，负值越大表示稳定性越高。

## 其他注意事项

- 请确保提供的密码子使用频率表和密码子表的格式正确并符合要求。
- 请注意安装所需的依赖项，并使用兼容的 Python 版本运行项目。

## TODO
- 完成对mRNA结构可视化。
- 完成对codon lattice的可视化。