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.

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 docs #24

Merged
merged 6 commits into from
Apr 22, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
56 changes: 56 additions & 0 deletions INSTALLATION.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,56 @@
# Install Whiscy

Below we will go into a step-by-step guide on how to install Whiscy. Instructions are provived for Ubuntu Linux, in other systems the installation process may vary.

## Third-Party

Whiscy depends on the following third-party software:

- Muscle
- FreeSASA
- HSSPCONV
- Protdist

The installation of these dependencies is described in the [THIRDPARTY.md](THIRDPARTY.md) file.

## Whiscy

To install Whiscy, follow these steps:

- Clone the repository:

```bash
git clone https://github.com/haddocking/whiscy && cd whiscy
```

- Install the scripts

Make sure you are using an environment with Python3.11+

```bash
pip install .
```

- Check the installation

```text
$ whiscy -h
usage: whiscy [-h] [-o output_file] [--version]
surface_list conversion_table alignment_file distance_file

positional arguments:
surface_list Surface list
conversion_table Conversion table
alignment_file Alignment file
distance_file Distance file

options:
-h, --help show this help message and exit
-o output_file, --output output_file
If set, output prediction to this file
--version show program's version number and exit
```

### Troubleshooting

If you get an error such as `ValueError: MUSCLE_BIN not found in system variables`, make sure you have followed the steps in [THIRDPARTY.md](THIRDPARTY.md) to install the third-party dependencies.
3 changes: 3 additions & 0 deletions MANIFEST.in
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
include src/whiscy/param/parasmooth.par
include src/whiscy/param/weight_ma.txt
include src/whiscy/param/ztable.txt
Loading
Loading