Skip to content

Commit

Permalink
v1.6.2
Browse files Browse the repository at this point in the history
  • Loading branch information
ayaanhossain committed Jul 6, 2021
1 parent 42ab25e commit 4fa01aa
Show file tree
Hide file tree
Showing 4 changed files with 10 additions and 27 deletions.
2 changes: 1 addition & 1 deletion LICENSE
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
MIT License

Copyright (c) 2020 Ayaan Hossain
Copyright (c) 2020-2021 Ayaan Hossain

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
Expand Down
28 changes: 5 additions & 23 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,7 @@ Non-repetitiveness is a global property of the entire genetic part toolbox, and

`Non-Repetitive Parts Calculator` is a `Linux`/`MacOS`-tested software, and was originally built with `Python2.7`. The software is now `Python3` exclusive, and compatible only with `Python3.6` and above. `Python2.7` is no longer supported.


**Setting up the Environment**

The best way to install `NRP Calculator` is via `conda`. If you have either `anaconda` or `miniconda` installed on your system, you are good to proceed. Otherwise, you may first need to install [miniconda](https://docs.conda.io/en/latest/miniconda.html).
Expand All @@ -50,34 +51,15 @@ $ conda activate nrpenv

> **Note** You don't necessarily need to make a new environment, as long as you know which environment you want `NRP Calculator` installed in, and have it activated during installation. For example, you might have a different project environment inside which you want to install `NRP Calculator`.
**Installing External Dependencies**

To use `NRP Calculator` in a new environment, we must first install `ViennaRNA`, which is an external dependency for the software and not available in [PyPI](https://pypi.org). `ViennaRNA` is easily installed with
```bash
$ conda install -c bioconda viennarna
```

If you are following the instructions as is, this will install the latest copy of `ViennaRNA` inside the new `nrpenv` environment.

If you do not want to install `conda` on your system, you will need to install [ViennaRNA](https://www.tbi.univie.ac.at/RNA/ViennaRNA/doc/html/install.html), and its `Python` bindings manually.

Once completed, you can verify your installation of `ViennaRNA` via:
```python
$ python
Python 3.6.10 | packaged by conda-forge | (default, Apr 24 2020, 16:44:11)
[GCC 7.3.0] on linux
Type "help", "copyright", "credits" or "license" for more information.
>>> import RNA
>>> quit()
```

**Approach 1: Install from PyPI**

Once `ViennaRNA` is installed, you can install `NRP Calculator` from PyPI, where it is published as the `nrpcalc` package. This is as easy as
```bash
$ pip install --upgrade nrpcalc --no-cache-dir
```
which will additionally install all remaining dependencies from PyPI.
which will also install all dependencies from PyPI.


**Approach 2: Install from GitHub**

Expand Down Expand Up @@ -112,7 +94,7 @@ Non-Repetitive Parts Calculator
Automated design and discovery of non-repetitive genetic
parts for engineering stable systems.

Version: 1.6.0
Version: 1.6.2

Authors: Ayaan Hossain <auh57@psu.edu>
Howard Salis <salis@psu.edu>
Expand Down Expand Up @@ -158,7 +140,7 @@ If you encounter any problems during installation, please feel free to [open an

`Non-Repetitive Parts Calculator` is an **open-source software** under [MIT](https://opensource.org/licenses/MIT) License.

See [LICENSE](./LICENSE) file for more details.
See [LICENSE](https://github.com/ayaanhossain/nrpcalc/blob/master/LICENSE) file for more details.

## Citation

Expand Down
2 changes: 1 addition & 1 deletion nrpcalc/nrpcalc.py
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
from .base import kmerSetDB


__version__ = '1.6.0'
__version__ = '1.6.2'

__authors__ = '''
Ayaan Hossain <auh57@psu.edu>
Expand Down
5 changes: 3 additions & 2 deletions setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
name='nrpcalc',

# Link: https://www.python.org/dev/peps/pep-0440/#version-scheme
version='1.6.0',
version='1.6.2',

description='Non-Repetitive Parts Calculator - Automated design and discovery of non-repetitive genetic parts for engineering stable genetic systems',

Expand Down Expand Up @@ -104,7 +104,8 @@
'jupyter>=1.0.0',
'scikit-learn>=0.23.1',
'seaborn>=0.10.1',
'statsmodels>=0.11.0'],
'statsmodels>=0.11.0',
'ViennaRNA>=2.4.18a1'],

project_urls={ # Optional
'Bug Reports': 'https://github.com/ayaanhossain/nrpcalc/issues',
Expand Down

0 comments on commit 4fa01aa

Please sign in to comment.