Skip to content
This repository has been archived by the owner on Apr 14, 2019. It is now read-only.

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Joshua Murphy committed Sep 28, 2018
1 parent d4dadf6 commit 4c965c6
Showing 1 changed file with 6 additions and 7 deletions.
13 changes: 6 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,18 +1,19 @@
# marvis
QGIS plugin for visualization of Marxan data output

## Status Update
Marvis was mainly developed via an internship during the Summer of 2018. There is currently no work being done on the project.
Right now, Marvis doesn't do anything, and its full scope as not yet been realized. Most of the work was done behind the scenes, such as reading training manuals for [Marxan](https://github.com/mattwatts/marxan244), learning [QGIS](https://www.qgis.org/en/site/) and it's development API, as well as writing project [documentation](https://marvis.readthedocs.io/en/latest/).

## About
Marvis (a conjuction of the words Marxan and Visualizer, rhyming with 'Jarvis' or 'Tardis') is a QGIS plugin for visualizing data output by the open-source conversation planning software, [Marxan](https://github.com/mattwatts/marxan244). It is currently unknown if the web-based Marxan solution uses the same data output format (a plaintext ``.dat``) that the desktop-based Marxan uses. *Therefore, it is unknown if Marvis is compatible with web-based implementations of Marxan.*
Marvis (a conjuction of the words Marxan and Visualizer, rhyming with 'Jarvis' or 'Tardis') will become a QGIS plugin for visualizing data output by the open-source conversation planning software, [Marxan](https://github.com/mattwatts/marxan244).

## Getting Started
View the [help](https://marvis.readthedocs.org) documentation.

## Installation
View the [installation](https://marvis.readthedocs.org/#installation) section.

## Usage


## License
Licensed under the GNU GPL v3. See the [``LICENSE.md``](https://github.com/ranguli/marvis/blob/master/LICENSE.md) for more information.

Expand All @@ -21,6 +22,4 @@ Author: Joshua Murphy (ranguli)

You can contact me here:

``mun.ca @ jmurphy17``

*(For anti-spam purposes*)
``mun.ca@jmurphy17``

0 comments on commit 4c965c6

Please sign in to comment.