Skip to content

Commit

Permalink
update README
Browse files Browse the repository at this point in the history
(1) update total
(2) update examples
  • Loading branch information
HaolingZHANG committed Sep 10, 2021
1 parent 7821da4 commit 2307f8f
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 3 deletions.
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,16 +20,16 @@ We recommend that you read the user manual first and then the contributor manual

**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 (especially actual information density).
If you insist on using earlier versions, you may get unexpected results.

You can find the latest version in:
(1) GitHub release [here](https://github.com/ntpz870817/Chamaeleo/releases/),
(2) PyPI website [here](https://pypi.org/project/Chamaeleo/).
Simply, installation through the command line (pip install Chamaeleo) is the easiest way to obtain the latest and most stable version of Chamaeleo.
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](https://github.com/ntpz870817/Chamaeleo/tree/master/examples)) may help you get started well.

Sometimes the results (especially actual information density) obtained by Chamaeleo do not meet your expectations.
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](https://github.com/ntpz870817/Chamaeleo/blob/master/methods/default.py#L40)).
Expand Down
4 changes: 4 additions & 0 deletions examples/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,11 @@
This folder is used for end-to-end (overall process) integration testing

Step 1: using **demo_case_individual_transcode.py** to learn how to complete the encoding and decoding process.

Step 2: using **demo_case_combined_transcode.py** to learn how to compare different coding schemes.

Step 3: using **demo_case_robustness.py** to learn how to evaluate the robustness of coding schemes.

Step 4: using **demo_case_basic_feature.py** to learn how to calculate the basic features of DNA sequences encoded by different coding schemes.

Step 5: using **demo_case_best_choice.py** to learn how to find the best choice in different coding schemes.

0 comments on commit 2307f8f

Please sign in to comment.