Skip to main content

Nucleone

Nucleone is a Python package for identifying dyad positions from nucleosome occupancy profiles. The algorithm first smooths the input nucleosome occupancy profile and then scores each genomic coordinate based on sequence features associated with nucleosome positioning that were identified in our previous study published in Nucleic Acids Research (DOI: 10.1093/nar/gkae623).

The dyad position is defined as the midpoint nucleotide of the 147-bp nucleosomal DNA fragment. A dyad count represents the total number of DNA fragments whose midpoint corresponds to a specific genomic coordinate.

Nucleone is compatible with Windows, macOS, and Linux operating systems and is distributed under the MIT License.

Installation

Nucleone is available from the Python Package Index (PyPI). Install the package using:

python -m pip install Nucleone

Checking Python and pip versions

Python is case-sensitive. It is also important to ensure that pip is associated with the same Python installation that will be used to run Nucleone.

Check the Python version using:

python --version

Check the pip version using:

pip --version

If these commands report different Python versions, use:

python -m pip install Nucleone

instead of:

pip install Nucleone

Using python -m pip ensures that pip is executed through the Python interpreter specified by the python command.

Input

Nucleone requires three parameters. The first two parameters specify two input files in TXT format:

  1. DNA sequence file — contains the DNA nucleotide sequence.
  2. Dyad count file — contains the dyad count corresponding to each nucleotide in the DNA sequence.

Both input files must be provided in plain-text format.

The dyad count file must contain one dyad count for each nucleotide in the DNA sequence, with individual dyad counts separated by commas.

Examples of input files are available in the Download section of the Nucleone website:

https://nucleone.org/DS

Output

The third parameter specifies the output file prefix. Nucleone generates two output files with the same base name but different file extensions.

The first output file contains:

  • The smoothed dyad counts associated with the input nucleosome occupancy profile
  • The genomic coordinates identified as potential dyad positions

The second output file is a JPG-format image showing:

  • The input nucleosome occupancy profile as a blue curve
  • The smoothed nucleosome occupancy profile as a green curve
  • The identified dyad positions as brown dots

Usage

After installing Nucleone, import the package and provide the paths to the input and output files:

import Nucleone

SequenceFile = "The path to the input DNA sequence file"
DyadCountFile = "The path to the input dyad count file"
OutputFile = "The path to the output file"

Nucleone.Nucleone(SequenceFile, DyadCountFile, OutputFile)

where:

  • SequenceFile specifies the DNA sequence file.
  • DyadCountFile specifies the dyad count file.
  • OutputFile specifies the output file prefix.

Example

For example:

import Nucleone

SequenceFile = "DNA.txt"
DyadCountFile = "DyadCount.txt"
OutputFile = "Nucleone_Output"

Nucleone.Nucleone(SequenceFile, DyadCountFile, OutputFile)

This command generates the corresponding output files using Nucleone_Output as the output file prefix.

Web Server

Nucleone is also available as a web-based application. The web server provides both dyad identification and dyad position classification.

The web-based version currently supports DNA sequences with a maximum length of 1,000 nucleotides for dyad identification.

These limits are imposed to ensure that hardware resources are fairly shared among users. For larger datasets, users are recommended to install and use the standalone version of Nucleone.

Nucleone web server:

https://nucleone.org/

Dyad Position Classifier

In addition to dyad identification, the Nucleone web server provides a dyad position classifier. The classifier takes a 201-bp nucleotide sequence as input and predicts whether its midpoint nucleotide corresponds to a dyad position.

The classifier is a separate program from the standalone Nucleone dyad identification package.

Citation

If you use Nucleone in your research, please cite the associated study:

Masoudi-Sobhanzadeh Y, et al. Interpretable deep residual network for nucleosome positioning prediction. Nucleic Acids Research. DOI: 10.1093/nar/gkae623

Source Code and License

The source code of Nucleone is freely available under the MIT License.

Contact

For further information, please visit:

https://nucleone.org/

Metadata

Release files for Nucleone 1.0.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for Nucleone 1.0.1
File Size Uploaded Provenance Actions
nucleone-1.0.1.tar.gz 5.4 kB Without provenance Details for nucleone-1.0.1.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for Nucleone 1.0.1
File Interpreter ABI Platform Actions
nucleone-1.0.1-py3-none-any.whl Python 3 none any Details for nucleone-1.0.1-py3-none-any.whl

Total release size: 10.9 kB

Release files / nucleone-1.0.1.tar.gz

Download URL nucleone-1.0.1.tar.gz
Size 5.4 kB
Tags Source
SHA-256 checksum
How to use checksums
f3d6978b6e4552a5c8d6a6426899938b3b44628b7a01a3ccd91061d2065222ea
BLAKE2b-256 checksum
How to use checksums
dc139d0b365fcc63762a498ace284189db2e24bb3fa29aa68656b97ab06adfd5
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.14.5

Release files / nucleone-1.0.1-py3-none-any.whl

Download URL nucleone-1.0.1-py3-none-any.whl
Size 5.5 kB
Tags Python 3
SHA-256 checksum
How to use checksums
ecbdacd20119c5c0f38da143d4ccf2f72b5b05d1873c4a3ac9c13091f021668d
BLAKE2b-256 checksum
How to use checksums
0e413e9275d28126b9433edd568e8686b6ac7ba767f9e1b3828ba9e24b4fd81d
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.14.5

Security for Nucleone 1.0.1

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

1.0.1 This release

2 release files No provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page