|
|
|
## Welcome to our Wiki
|
|
|
|
|
|
|
|
Welcome to the Wiki of MetageneDB.
|
|
|
|
|
|
|
|
## Table of content
|
|
|
|
|
|
|
|
Page | content
|
|
|
|
---- | -------
|
|
|
|
[Run the project on your local machine](run the project on your local machine) | Instruction to set up your environment on your local machine to run the project and contribute to it
|
|
|
|
[Contribution guide](contribution-guide) | How to contribute to the project
|
|
|
|
[Dev tips](dev-tips) | Tips for development
|
|
|
|
|
|
|
|
-----
|
|
|
|
|
|
|
|
## Dev tips
|
|
|
|
|
|
|
|
#### Profiling code
|
|
|
|
|
|
|
|
```python
|
|
|
|
from metagenedb.common.utils.profiling import profile
|
|
|
|
|
|
|
|
@profile("/my/file/path")
|
|
|
|
def my_function(a, b, c):
|
|
|
|
...
|
|
|
|
```
|
|
|
|
|
|
|
|
```bash
|
|
|
|
snakeviz /my/file/path
|
|
|
|
``` |