Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update installation instructions #6

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Update installation instructions #6

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 4 additions & 9 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,23 +1,18 @@
# DynaMight

[![License](https://img.shields.io/pypi/l/dynamight.svg?color=green)](https://github.com/schwabjohannes/dynamight/raw/main/LICENSE)
[![PyPI](https://img.shields.io/pypi/v/dynamight.svg?color=green)](https://pypi.org/project/dynamight)
[![Python Version](https://img.shields.io/pypi/pyversions/dynamight.svg?color=green)](https://python.org)
[![CI](https://github.com/schwabjohannes/dynamight/actions/workflows/ci.yml/badge.svg)](https://github.com/schwabjohannes/dynamight/actions/workflows/ci.yml)
[![codecov](https://codecov.io/gh/schwabjohannes/dynamight/branch/main/graph/badge.svg)](https://codecov.io/gh/schwabjohannes/dynamight)

Estimating dynamics from cryo-EM images and use them to improve your map (maybe)

Analysing continuous heterogeneity in a cryo-EM dataset with dynamight consists of 3 main steps:

## Installation

*DynaMight* is available from the Python package index ([PyPI](https://pypi.org/)).
*DynaMight* is not yet available from the Python package index ([PyPI](https://pypi.org/)).

Please install using `pip` in a clean virtual environment.
Instead, please install the project locally using `pip` in a clean virtual environment.

```shell
pip install dynamight
git clone https://github.com/3dem/DynaMight.git
pip install --editable DynaMight
```

## Step 1: Estimation and inspection of deformations
Expand Down