chamaeleo

BGI DNA Storage Kit

https://github.com/ntpz870817/chamaeleo

Science Score: 23.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • CITATION.cff file
  • codemeta.json file
  • .zenodo.json file
  • DOI references
    Found 1 DOI reference(s) in README
  • Academic publication links
    Links to: biorxiv.org
  • Committers with academic emails
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (18.0%) to scientific vocabulary
Last synced: 11 months ago · JSON representation

Repository

BGI DNA Storage Kit

Basic Info
  • Host: GitHub
  • Owner: ntpz870817
  • License: mit
  • Language: Python
  • Default Branch: master
  • Size: 49.1 MB
Statistics
  • Stars: 43
  • Watchers: 4
  • Forks: 9
  • Open Issues: 2
  • Releases: 0
Created about 7 years ago · Last pushed over 1 year ago
Metadata Files
Readme License

README.md

Chamaeleo


Chamaeleo is currently the only collection focused on different codec methods for DNA storage. This kit is mainly developed and operated by Synthetic Platform of BGI-Research, for a detailed list of authors, see authors.md. It provides you a chance to use the classical DNA encoding and decoding methods to save files into DNA sequences or load them from DNA sequences.


Here, we provide guidance for different visitors. We recommend that you read the user manual first and then the contributor manual.

  • If you are a learner or a engineer, please pay attention to the user manual, see user_manual.md.
  • If you want to be a contributor, please pay attention to the contributor manual, see contributor_manual.md.

Chamaeleo has undergone major adjustments before. Versions smaller than 1.3 are unstable. If you insist on using earlier versions, you may get unexpected results.

You can find the latest version in: (1) GitHub release here, (2) PyPI website here. Simply, installation through the command line (pip install Chamaeleo) is the easiest way to obtain the latest and most stable version of Chamaeleo.

As a kind suggestion, when you first touch this package, pipeline cases in the examples folder (please note here) may help you get started well.

Sometimes the results obtained by Chamaeleo do not meet your expectations. We recommend that you can check by following steps: (1) related length settings include segment length, index length, and error-correction length. (2) the method for calculating information density. For the built-in calculation method, it is bound inside the class AbstractCodingAlgorithm(please note here).

In some cases, you may encounter software errors. If you can't solve the problem, please describe your problem here or sent your problem to zhanghaoling@genomics.cn.


Here we declare the digital file used in our library for testing.

  • DNA Fountain Input Files.tar: http://files.teamerlich.org/dna_fountain/dna-fountain-input-files.tar.gz. Erlich, Y., & Zielinski, D. (2017). DNA Fountain enables a robust and efficient storage architecture. Science, 355(6328), 950-954.

  • Microsoft Winmine.exe: https://www.microsoft.com/en-us/p/microsoft-minesweeper/9wzdncrfhwcn?activetab=pivot:overviewtab. 2012 Microsoft Corporation.

  • A Tale of Two Cities.pdf: https://epdf.pub/a-tale-of-two-cities-penguin.html. Fictionwise.

  • The Wandering Earth.pdf: https://epdf.pub/the-wandering-earth.html. Beijing Guomi Digital Technology Co., Ltd.

  • For Elise.wma: https://www.youtube.com/watch?v=mVW8tgGYw. Youtube.

  • Summer.mp3: https://www.youtube.com/watch?v=J7or0noYfMA. Youtube.

  • Mona Lisa.jpg: https://en.wikipedia.org/wiki/Mona_Lisa. wiki.

  • United Nations Flag.bmp: https://www.britannica.com/topic/flag-of-the-United-Nations

  • Exiting the Factory.flv: https://www.youtube.com/watch?v=DEQeIRLxaM4. Youtube.

  • I have a Dream.mp4: https://www.youtube.com/watch?v=MgYzJGmBXU8. Youtube.


If you think this repo helps or being used in your research, please consider refer this paper.

Chamaeleo: an integrated evaluation platform for DNA storage

with its English version

Thank you!

English version: @article{ping2020chamaeleo, title={Chamaeleo: an integrated evaluation platform for DNA storage}, author={Ping, Zhi and Zhang, Haoling and Chen, Shihong and Zhuang, Qianlong and Zhu, Sha and Shen, Yue}, journal={Synthetic Biology Journal}, year={2020}, pages={1-15}, }

Chinese version: @article{ping2020chamaeleo, title={Chamaeleo:DNA存储碱基编解码算法的可拓展集成与系统评估平台}, author={平质, 张颢龄, 陈世宏, 倪鸣, 徐讯, 朱砂, 沈玥}, journal={合成生物学}, year={2020}, pages={1-15}, }

GitHub Events

Total
  • Watch event: 6
  • Pull request event: 1
  • Create event: 1
Last Year
  • Watch event: 6
  • Pull request event: 1
  • Create event: 1

Committers

Last synced: over 2 years ago

All Time
  • Total Commits: 252
  • Total Committers: 5
  • Avg Commits per committer: 50.4
  • Development Distribution Score (DDS): 0.254
Past Year
  • Commits: 0
  • Committers: 0
  • Avg Commits per committer: 0.0
  • Development Distribution Score (DDS): 0.0
Top Committers
Name Email Commits
HaolingZHANG h****n@g****m 188
Joe Zhu s****u@g****m 43
JensenAmes 1****3@q****m 17
ntpz870817 n****7@a****m 2
ntpz870817 3****7 2
Committer Domains (Top 20 + Academic)

Issues and Pull Requests

Last synced: about 1 year ago

All Time
  • Total issues: 17
  • Total pull requests: 22
  • Average time to close issues: 6 months
  • Average time to close pull requests: 5 days
  • Total issue authors: 3
  • Total pull request authors: 3
  • Average comments per issue: 0.47
  • Average comments per pull request: 0.18
  • Merged pull requests: 21
  • Bot issues: 0
  • Bot pull requests: 1
Past Year
  • Issues: 0
  • Pull requests: 1
  • Average time to close issues: N/A
  • Average time to close pull requests: N/A
  • Issue authors: 0
  • Pull request authors: 1
  • Average comments per issue: 0
  • Average comments per pull request: 0.0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 1
Top Authors
Issue Authors
  • shajoezhu (9)
  • HaolingZHANG (7)
  • ntpz870817 (1)
Pull Request Authors
  • HaolingZHANG (14)
  • shajoezhu (7)
  • dependabot[bot] (1)
Top Labels
Issue Labels
good first issue (2) bug (2) enhancement (1) question (1)
Pull Request Labels
dependencies (1)

Packages

  • Total packages: 1
  • Total downloads:
    • pypi 831 last-month
  • Total dependent packages: 0
  • Total dependent repositories: 1
  • Total versions: 15
  • Total maintainers: 2
pypi.org: chamaeleo

library for the well accepted coding schemes of DNA storage

  • Versions: 15
  • Dependent Packages: 0
  • Dependent Repositories: 1
  • Downloads: 831 Last month
Rankings
Dependent packages count: 10.1%
Stargazers count: 11.8%
Forks count: 11.9%
Average: 15.5%
Dependent repos count: 21.5%
Downloads: 22.3%
Maintainers (2)
Last synced: 11 months ago

Dependencies

requirements.txt pypi
  • nose ==1.3.7
  • numpy *
  • pycodestyle *
  • reedsolo *
  • sphinx *
  • sphinx_markdown_tables *
  • sphinx_rtd_theme *
  • terminaltables *
  • virtualenv ==16.6.0
setup.py pypi
  • numpy *