Skip to content

YunyunGao/AUSPEX

Repository files navigation

AUSPEX

Getting Started

These instructions will get you a copy of the project up and running on your local machine.

Prerequisites

The easiest approach to install AUSPEX is through conda environment.

Either install Anaconda or miniconda

Once installed, create a new virtual environment using the provided environment.yml

conda env create -f environment.yml

Activate the new environment with

conda activate auspex

Installing

Install Auspex through pip install from its Git repository.

pip install git+https://github.com/thorn-lab/AUSPEX.git

Usage

To use Auspex, use following console command:

auspex [path_to_data_file] [options]

To read the detailed help message:

auspex -h

Tests

auspex src/test/4puc.mtz

Documentation

You can generate the documentation with sphinx

cd docs
make html
your_favorite_browser build/auspex.html

About

Newly forged AUSPEX by THORNLAB

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published