Skip to content

Commit

Permalink
Updating version.
Browse files Browse the repository at this point in the history
  • Loading branch information
emarinier committed Nov 1, 2024
1 parent 1e7ac51 commit 532c78b
Show file tree
Hide file tree
Showing 4 changed files with 21 additions and 33 deletions.
40 changes: 10 additions & 30 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,18 +1,9 @@
# Introduction #

A genomic signature is a genomic locus that is sufficiently represented in an
inclusion group, and sufficiently absent from a background, or exclusion
group. A signature might correlate genomic features with phenotypic traits,
such as the presence of a gene with increased organism pathogenicity.

Neptune locates genomic signatures using an exact k-mer matching strategy while
accommodating k-mer mismatches. The software identifies sequences that are
sufficiently represented within inclusion targets and sufficiently absent from
exclusion targets. The signature discovery process is accomplished using
probabilistic models instead of heuristic strategies. Neptune may be leveraged
to reveal discriminatory signature sequences to uniquely delineate one group of
organisms, such as isolates associated with a disease cluster or event, from
unrelated sporadic or environmental microbes.
A genomic signature is a genomic locus that is sufficiently represented in an inclusion group, and sufficiently absent from a background, or exclusion group. A signature might correlate genomic features with phenotypic traits, such as the presence of a gene with increased organism pathogenicity.

Neptune locates genomic signatures using an exact k-mer matching strategy while accommodating k-mer mismatches. The software identifies sequences that are sufficiently represented within inclusion targets and sufficiently absent from exclusion targets. The signature discovery process is accomplished using probabilistic models instead of heuristic strategies. Neptune may be leveraged to reveal discriminatory signature sequences to uniquely delineate one group of
organisms, such as isolates associated with a disease cluster or event, from unrelated sporadic or environmental microbes.

# Resources #

Expand All @@ -24,16 +15,13 @@ unrelated sporadic or environmental microbes.

**Neptune 1.2.5**

This release provides fixes for ambiguous crashes as a consequence of inputs
containing no A, C, G, or T characters, and also makes improvements to the
code quality.
This release provides fixes for ambiguous crashes as a consequence of inputs containing no A, C, G, or T characters, and also makes improvements to the code quality.

# Installation #

It is strongly recommended you refer to the
[documentation](https://phac-nml.github.io/neptune/install/) for full
installation instructions. Neptune may be installed on any 64-bit Linux system
using Bioconda, preferably with [Mamba](https://mamba.readthedocs.io/en/latest/installation/mamba-installation.html) or with the Mamba resolver under Conda:
installation instructions. Neptune may be installed on any 64-bit Linux system using Bioconda, preferably with [Mamba](https://mamba.readthedocs.io/en/latest/installation/mamba-installation.html) or with the Mamba resolver under Conda:

1. Install [Bioconda](https://bioconda.github.io/)
2. Create an environment for Neptune and install within it: `mamba create -n neptune bioconda::neptune -c conda-forge`
Expand All @@ -60,8 +48,7 @@ A simple example of running Neptune:
--output /path/to/output/

Please refer to the
[documentation](https://phac-nml.github.io/neptune/parameters/) for more
details.
[documentation](https://phac-nml.github.io/neptune/parameters/) for more details.

# Contact #

Expand All @@ -77,17 +64,10 @@ Written by: Eric Marinier, Public Health Agency of Canada,
National Microbiology Laboratory

Funded by the National Micriobiology Laboratory and the Genome Canada / Alberta
Innovates Bio Solutions project "Listeria Detection and Surveillance
using Next Generation Genomics"
Innovates Bio Solutions project "Listeria Detection and Surveillance using Next Generation Genomics"

Licensed under the Apache License, Version 2.0 (the "License"); you may not use
this work except in compliance with the License. You may obtain a copy of the
License at:
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this work except in compliance with the License. You may obtain a copy of the License at:

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed
under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
CONDITIONS OF ANY KIND, either express or implied. See the License for the
specific language governing permissions and limitations under the License.

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
6 changes: 4 additions & 2 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,11 @@ Neptune locates genomic signatures using an exact *k*-mer matching strategy whil

## Release ##

**Neptune 1.2.5**
## Neptune 2.0.0 ##

This release provides fixes for ambiguous crashes as a consequence of inputs containing no A, C, G, or T characters, and also makes improvements to the code quality.
2024-10-21

This release updates Neptune to Python3, removes DRMAA support, fixes a crash when no signatures are produced, and updates the installation process.

## Resources ##

Expand Down
6 changes: 6 additions & 0 deletions docs/news.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,11 @@
# News #

## 2.0.0 ##

2024-10-21

This release updates Neptune to Python3, removes DRMAA support, fixes a crash when no signatures are produced, and updates the installation process.

## Version 1.2.5 ##

2017-05-04
Expand Down
2 changes: 1 addition & 1 deletion src/neptune/Neptune.py
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@
# =============================================================================
"""

__version__ = '1.2.5-python3'
__version__ = '2.0.0'

import time

Expand Down

0 comments on commit 532c78b

Please sign in to comment.