Skip to content

Commit

Permalink
updated installation instructions to indicate how to test if scadnano…
Browse files Browse the repository at this point in the history
… was installed successfully
  • Loading branch information
dave-doty committed Dec 30, 2020
1 parent 2168dec commit b096e5d
Showing 1 changed file with 19 additions and 0 deletions.
19 changes: 19 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,14 @@ Please report issues in the web interface at the [scadnano web interface GitHub

## Installation

Short version: type this at the command line:

```console
pip install scadnano
```

Read below for troubleshooting suggestions if that didn't work.

### Getting Python
The scadnano Python package requires Python version 3.7 or later (with a workaround available for version 3.6, but not for any lower version).

Expand Down Expand Up @@ -73,6 +81,17 @@ Once Python is installed (and the dataclasses backport if you have Python versio
pip install scadnano
```

If it worked, you should be able to open a Python interpreter and import the scadnano module:

```console
Python 3.7.9 (default, Aug 31 2020, 17:10:11) [MSC v.1916 64 bit (AMD64)] :: Anaconda, Inc. on win32
Type "help", "copyright", "credits" or "license" for more information.
>>> import scadnano as sc
>>> print(sc.Domain(helix=1, forward=True, start=0, end=8))
Domain(, helix=1, forward=True, start=0, end=8)
>>>
```

### Troubleshooting
If the above does not work for you, here are some things to try.

Expand Down

0 comments on commit b096e5d

Please sign in to comment.