Skip to content

Commit

Permalink
updated README
Browse files Browse the repository at this point in the history
  • Loading branch information
lucananni93 committed Jan 7, 2019
1 parent db44bc4 commit f07dfe6
Showing 1 changed file with 22 additions and 32 deletions.
54 changes: 22 additions & 32 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,22 +25,34 @@ You can ask questions or provide some feedback through our Gitter channel.
[![Join the chat at https://gitter.im/DEIB-GECO/PyGMQL](https://badges.gitter.im/DEIB-GECO/PyGMQL.svg)](https://gitter.im/DEIB-GECO/PyGMQL?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)


## Installation
### From github
First of all download this repository in a choosen location:
```
git clone https://github.com/DEIB-GECO/PyGMQL.git
```
Than go inside the library folder and install the package as follows:
```
cd PyGMQL
pip install -e .
```

### From PyPi
```
pip install gmql
```

## Setup

#### Use Anaconda
### Use Anaconda
We suggest to manage your python distribution through Anaconda.
The latest version of can be downloaded from https://www.continuum.io/downloads.

Once your Anaconda distribution is installed, let's create a brand new environment:
```
conda create --name pygmql python=3.6
```

#### Download this repository
First of all download this repository in a choosen location:
```
git clone https://github.com/DEIB-GECO/PyGMQL.git
conda create --name pygmql python=3
```
### Check if JAVA is installed
Check that the `JAVA_HOME` enviroment variable is correctly set to
the latest JAVA distribution.
```
Expand Down Expand Up @@ -68,13 +80,8 @@ On Windows:
edit JAVA_HOME to point to where the JDK software is located,
for example, C:\Program Files\Java\jdk1.6.0_02.

#### Install with pip
Than go inside the library folder and install the package as follows:
```
cd PyGMQL
pip install -e .
```

### Use it in Jupyter Notebooks
We strongly suggest to use the library with the support of a **Jupyter Notebook**
for the best graphical rendering of the data structures.
It may be necessary to manually install the Jupyter kernel:
Expand All @@ -83,28 +90,11 @@ source activate pygmql
python -m ipykernel install --user --name pygmql --display-name "Python (pygmql)"
```

#### Run the library
Firstly activate the `pygmql` conda environment and enter in the interactive
Python shell
```
source activate pygmql
python
```

Then simply import the library
```python
import gmql as gl
```
Now you are ready to use PyGMQL! Congratulations!

### Keep the code updated
This is a constantly evolving project. Therefore the library will be
constantly added with new features. Therefore we suggest to update your
local copy periodically:
```
cd PyGMQL
git pull
```

## Tutorial
You can download a tutorial for beginners at this [link](https://www.dropbox.com/s/48cr8hvuytcufgj/Tutorial_PyGMQL.zip?dl=0)
```

0 comments on commit f07dfe6

Please sign in to comment.