Skip to content

Commit

Permalink
RLS Version 2.0.0
Browse files Browse the repository at this point in the history
Effectively a minor release, turning the _SemiBin2 beta_ into a full
SemiBin2 release.

Full ChangeLog:

- `SemiBin`: Better error checking throughout
- `SemiBin`: Write a log file
- `concatenate_fasta`: support compression
- `concatenate_fasta`: slightly better error message when contig ID already contains separator
- `SemiBin`: add `bin_short` as alias for `bin`
  • Loading branch information
luispedro committed Oct 19, 2023
1 parent cf77f56 commit 6a03950
Show file tree
Hide file tree
Showing 6 changed files with 9 additions and 6 deletions.
3 changes: 2 additions & 1 deletion ChangeLog
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
Unreleased
Version 2.0.0
* SemiBin: Better error checking throughout
* SemiBin: Write a log file
* concatenate_fasta: support compression
* concatenate_fasta: slightly better error message when contig ID already
Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ Please find more options and details below and [read the docs](https://semibin.r

## Advanced Installation

SemiBin runs on Python 3.7-3.11.
SemiBin runs on Python 3.7-3.11. Python 3.12 should work as well, but not well tested yet.

### Bioconda

Expand Down
2 changes: 1 addition & 1 deletion SemiBin/semibin_version.py
Original file line number Diff line number Diff line change
@@ -1 +1 @@
__version__ = '1.5.1'
__version__ = '2.0.0'
2 changes: 1 addition & 1 deletion docs/subcommands.md
Original file line number Diff line number Diff line change
Expand Up @@ -222,7 +222,7 @@ These have the same meaning as for `single_easy_bin`

### bin_short

The `bin_short` subcommand (`bin` is an accepted alias, for backwards compatibility) requires the contig file and output (files `data.csv`, `model.h5`) from the `generate_sequence_features_single`, `generate_sequence_features_multi` and `train` subcommand as inputs and output the final bins in the `output_recluster_bins` directory.
The `bin_short` subcommand (for backwards compatibility reasons, `bin` is accepted as an alias) requires the contig file and output (files `data.csv`, `model.h5`) from the `generate_sequence_features_single`, `generate_sequence_features_multi` and `train` subcommand as inputs and output the final bins in the `output_recluster_bins` directory.

#### Required arguments

Expand Down
2 changes: 1 addition & 1 deletion docs/usage.md
Original file line number Diff line number Diff line change
Expand Up @@ -257,7 +257,7 @@ Having access to a GPU can speed up this mode.
(4) Bin

```bash
SemiBin2 bin \
SemiBin bin_short \
-i contig.fa \
--model contig_output/model.h5 \
--data contig_output/data.csv \
Expand Down
4 changes: 3 additions & 1 deletion docs/whatsnew.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,13 @@
# What's New

## Unreleased version
## Version 2.0.0

### User-visible changes

- Running SemiBin now writes a log file in the output directory
- The `concatenate_fasta` subcommand now supports compression
- Adds `bin_short` subcommand as alias for `bin` (by analogy with `bin_long`)


## Version 1.5.1 (SemiBin2 beta)

Expand Down

0 comments on commit 6a03950

Please sign in to comment.