Skip to main content

Algorithms for Single Particle Reconstruction

Project description

![Logo](http://spr.math.princeton.edu/sites/spr.math.princeton.edu/files/ASPIRE_1.jpg)

[![Azure Build Status](https://dev.azure.com/vineetbansal0645/Aspire-Python/_apis/build/status/ComputationalCryoEM.ASPIRE-Python?branchName=master)](https://dev.azure.com/vineetbansal0645/Aspire-Python/_build/latest?definitionId=3&branchName=master) [![Travis Build Status](https://travis-ci.org/ComputationalCryoEM/ASPIRE-Python.svg?branch=master)](https://travis-ci.org/ComputationalCryoEM/ASPIRE-Python) [![Appveyor Build status](https://ci.appveyor.com/api/projects/status/ywgud2vu9ot330bq/branch/master?svg=true)](https://ci.appveyor.com/project/vineetbansal/aspire-python/branch/master) [![Coverage Status](https://coveralls.io/repos/github/ComputationalCryoEM/ASPIRE-Python/badge.svg?branch=master)](https://coveralls.io/github/ComputationalCryoEM/ASPIRE-Python?branch=master) [![Documentation Status](https://readthedocs.org/projects/aspire/badge/?version=latest)](https://aspire.readthedocs.io/en/latest/?badge=latest)

# ASPIRE - Algorithms for Single Particle Reconstruction

This is the Python version to supersede the [Matlab ASPIRE](https://github.com/PrincetonUniversity/aspire).

ASPIRE is an open-source software package for processing single-particle cryo-EM data to determine three-dimensional structures of biological macromolecules. The package includes advanced algorithms based on rigorous mathematics and recent developments in statistics and machine learning. It provides unique and improved solutions to important computational challenges of the cryo-EM processing pipeline, including 3-D ab-initio modeling, 2-D class averaging, automatic particle picking, and 3-D heterogeneity analysis.

## Installation Instructions

For end-users

ASPIRE is a pip-installable package that works on Linux/Mac/Windows, and requires Python 3.6. The simplest option is to use Anaconda 64-bit for your platform with a minimum of Python 3.6 and pip, and then use pip to install aspire in that environment.

` conda create -n aspire_env python=3.6 pip conda activate aspire_env pip install aspire `

The final step above should install any dependent packages from pip automatically.

Note that this step installs the base aspire package for you to work with, but not the unit tests/scripts/documentation. If you need to install ASPIRE for development purposes, read on.

For developers

After cloning this repo, the simplest option is to use Anaconda 64-bit for your platform, and use the provided environment.yml file to build a Conda environment to run ASPIRE.

` cd /path/to/git/clone/folder conda env create -f environment.yml conda activate aspire `

### Make sure everything works

Once ASPIRE is installed, make sure the unit tests run correctly on your platform by doing: ` cd /path/to/git/clone/folder python setup.py test `

Tests currently take around 2 minutes to run. If some tests fail, you may realize that python setup.py test produces too much information. You may want to re-run tests using: ` cd /path/to/git/clone/folder PYTHONPATH=./src pytest tests ` This provides a cleaner output to analyze.

### Install

If the tests pass, install the ASPIRE package for the currently active Conda environment: ` cd /path/to/git/clone/folder python setup.py install `

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

aspire-0.5.2.tar.gz (128.1 kB view details)

Uploaded Source

File details

Details for the file aspire-0.5.2.tar.gz.

File metadata

  • Download URL: aspire-0.5.2.tar.gz
  • Upload date:
  • Size: 128.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.0.1 requests-toolbelt/0.9.1 tqdm/4.32.1 CPython/3.6.8

File hashes

Hashes for aspire-0.5.2.tar.gz
Algorithm Hash digest
SHA256 fcce7cab424070c02a4ecf17bb6672e8ecac216dce065703c20894f2fd1b0845
MD5 b82ae7c9e7271c3354711b1aff6f107d
BLAKE2b-256 9d414c8844f49cb96438fbaa23383192cf95336b1ab4112fce59a88273a177c0

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page