PLYNET 2.0

Python Planetary Physics Package

[DESCRIPTION] (https://github.com/sbustamante/Plynet#description)
[USER VERSION (Read-Only version)] (https://github.com/sbustamante/Plynet#user-version-read-only-version)
[DEVELOPER VERSION (Read-Write version)] (https://github.com/sbustamante/Plynet#developer-version-read-write-version)
[PACKAGE INSTALLATION] (https://github.com/sbustamante/Plynet#package-installation)
[LICENSE] (https://github.com/sbustamante/Plynet#license)

DESCRIPTION:

Plynet is a free and object-oriented code in python to calculate physical properties of rocky planets. The aim of this proyect is to compile in just one code several algorithms commonly used in planetary sciences to compute mechanical, thermal and magnetic properties of planets. We make use of the OOP paradigm to make a versatile code that allows to work with many planets (grid) at time unlike the current private existing codes.

USER VERSION (Read-Only version):

Download the zip file of Plynet in GitHub from here.

DEVELOPER VERSION (Read-Write version):

Plynet is a open source code, thus you can contribuite with us. With the next steps you can get a read-write version of Plynet

Create the Plynet folder for your personal copy of the code.
```
$ mkdir Plynet
```
Initialize your local git repository
```
$ git init
```

Link with the github proyect

$ git remote add origin git@github.com:sbustamante/Plynet.git

Pull the proyect in your local copy
```
$ git pull
```
Finally, link with 'master' branch
```
$ git push -u origin master
```
Before this step, the user must request to macsebas33@gmail.com to be added as collaborator of Plynet. It's also necessary create a personal ssh key, for this, the user must add a new associated email direction, view github user-help

(Optional) If you want to push your changes in master branch of repository

$ git add <files>
$ git commit -m 'commit message'
$ git push -u origin master

PACKAGE INSTALLATION:

Once you had get a (user or developer) copy of Plynet, to install it perform the following operations:

Create the directory usr/local in your home directory:
```
$ mkdir -p $HOME/usr/local
```
Add the following line to your .bashrc:
```
$ export PYTHONPATH=$PYTHONPATH:$HOME/usr/lib/python2.6/site-packages
```
Steps 1 and 2 must be followed only the first time your install.
Executes:
```
$ make install
```

The installation ends with the command "python -c'import plynet'". If you don't see this command at the end of the last command, see if any language error has arosen.
Otherwise if the command is executed but it show errors like:

To test all the package:

$ make test

To test a given module executes:

$ make test<module>

To clean all the package

$ make clean

LICENSE:

This program is free software; you can redistribute it and/or modify it under the terms of the Academic Free License (AFL) version 3.0.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.

You should have received a copy of the Academic Free License along with this program; if not an online version is available here.

Sebastian Bustamante (macsebas33@gmail.com), Jorge Zuluaga (zuluagajorge@gmail.com)