Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
simon-ball committed Dec 19, 2019
1 parent 1dfa5ca commit d03bd30
Showing 1 changed file with 12 additions and 4 deletions.
16 changes: 12 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ You can use [Git](https://git-scm.com/) to keep your copy of PyEdna up to date.

### Installing Python

PyEdna is written in Python 3.7. TO run PyEdna on your computer, you will need a local installation of Python 3. Please follow the instructions below to install Python via [**Anaconda distribution**](https://anaconda.org) for your respective operating system:
PyEdna is written in Python 3.7. To run PyEdna on your computer, you will need a local installation of Python 3. Please follow the instructions below to install Python via [**Anaconda distribution**](https://anaconda.org) for your respective operating system:

* [macOS](./mac_conda_install.md)
* [Windows](./windows_conda_install.md)
Expand All @@ -24,16 +24,24 @@ PyEdna is written in Python 3.7. TO run PyEdna on your computer, you will need a

#### With Git

If you have created a Github account and installed git, you can install PyEdna with a single command. In a terminal (e.g. Anaconda Prompt), give the command `pip install git+https://github.com/simon-ball/PyEdna`
If you have installed git, you can install PyEdna with a single command. In a terminal (e.g. Anaconda Prompt), give the command `pip install git+https://github.com/simon-ball/PyEdna`

You can also clone the repository locally, either using git, or using [Github's desktop application ](https://desktop.github.com/)

#### Without Git

Use the "Clone or Download" button on the right hand side of the screen to download a copy of PyEdna's code. Extract it to a file on your computer. To simplify importing the library, add this location to the [Python Path variable ](https://stackoverflow.com/questions/3402168/).


### Running PyEdna
## Running PyEdna

You can start PyEdna by importing the Python library and calling its `start()` method

>>> import pyedna
>>> pyedna.start()
>>> pyedna.start()

You can also use the analysis tools directly, without the GUI, using the class `pyedna.EdnaCalc`

## Issues?

Please submit issues to the [project's issue tracker](https://github.com/simon-ball/PyEdna/issues) on Github.

0 comments on commit d03bd30

Please sign in to comment.