diff --git a/README.md b/README.md index 54e1310..11801e1 100644 --- a/README.md +++ b/README.md @@ -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 # @@ -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` @@ -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 # @@ -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. diff --git a/docs/index.md b/docs/index.md index 281eff4..41ec1eb 100644 --- a/docs/index.md +++ b/docs/index.md @@ -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 ## diff --git a/docs/news.md b/docs/news.md index 8df2117..6941f69 100755 --- a/docs/news.md +++ b/docs/news.md @@ -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 diff --git a/src/neptune/Neptune.py b/src/neptune/Neptune.py index c2e385d..70ff93e 100755 --- a/src/neptune/Neptune.py +++ b/src/neptune/Neptune.py @@ -26,7 +26,7 @@ # ============================================================================= """ -__version__ = '1.2.5-python3' +__version__ = '2.0.0' import time