Skip to content

Commit

Permalink
Updated README
Browse files Browse the repository at this point in the history
  • Loading branch information
merttoka committed Aug 2, 2021
1 parent 5fa96df commit f0a36cf
Show file tree
Hide file tree
Showing 6 changed files with 24 additions and 19 deletions.
2 changes: 1 addition & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

### Project Name: `DynamoVis`

##### 1.0 - 2021/08/01
##### `1.0` - 2021/08/01
- Renamed MacOS menubar title to "DynamoVis"
- Renamed "Configure Animation" to "Input Data and Animation Configuration"
- Renamed Control Panel entry "Line Thickness" under Tracks to "Line Width"
Expand Down
39 changes: 22 additions & 17 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,28 +1,33 @@
# DynamoVis

<img src="repo-resources/screenshot.png"
alt="A screenshot of Albatross Data"
style="float: left;" />
<img src="repo-resources/banner.png"
alt="Collage of visualizations of Sarkis turkey vulture"
/>

**DynamoVis** is a data visualization software spesifically targeted for spatiotemporal movement data. It is developed by [Move Lab @ UC Santa Barbara](https://move.geog.ucsb.edu/) and designed to be accessible and easily usable for scientists without extensive prior experience with programming, GIS software, or custom data visualization tools. The intuitive design focuses on a simple interface for scientists to apply spatial data visualization techniques, giving ecologists and biologists of all backgrounds the power to visualize complicated spatial patterns.

[Download (`.jar`)](https://github.com/move-ucsb/DynamoVis/releases)

## Installation
If you'd like to clone the repository and compile from the source, make sure to have [Git Large File System](https://git-lfs.github.com/) installed and enabled. Git-LFS is required for large `*.csv` files. If you don't want to install Git-LFS, you will need to clone the repository and manually download .csv files in `/config` and `/public-data`.
<img src="repo-resources/animation.gif"
alt="A screenshot of Albatross Data"
style="float: left;" />

## Release
The latest release can use [found here ](https://github.com/move-ucsb/DynamoVis/releases).
## Usage
Download the latest release [here](https://github.com/move-ucsb/DynamoVis/releases).

Zip file contains automated scripts to run the software on Windows (`run_windows.bat`) and Unix-based systems (`run_unix.sh`). Make sure to have Java 15 installed and set up in your system or user PATH. If script files don't work, you can run the jar file using `java -jar DynamoVis-0.4.2.2.jar`.
Zip file contains automated scripts to run the software on Windows (`run_windows.bat`) and Unix-based systems (`run_unix.sh`). Make sure to have Java 15 installed and set up in your system or user PATH.

Please let us know or take a look at the [issues](https://github.com/move-ucsb/DynamoVis/issues) in case something is wrong.
You can also run the jar file using below command in extracted folder:

```shell
java -jar DynamoVis-1.0.jar
```

**Tested with:**
- Java version 15.0.2
- Windows 10 / macOS Catalina - 10.15
#### Tested on:
- Windows 10
- macOS Catalina - 10.15
- Java 15.0.2

### TODO:
[] Documentation will be available soon
## Compile from source
If you'd like to clone the repository and compile from the source, make sure to have [Git Large File System](https://git-lfs.github.com/) installed and enabled. Git-LFS is required for large `*.csv` files. If you don't want to install Git-LFS, you will need to clone the repository and manually download .csv files in `/config` and `/public-data`.

[] Add how to cite
## Contact
Feel free to open an [issue](https://github.com/move-ucsb/DynamoVis/issues) in case something is wrong.
Binary file added repo-resources/animation.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added repo-resources/banner.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed repo-resources/screenshot.png
Binary file not shown.
2 changes: 1 addition & 1 deletion src/main/DesktopPane.java
Original file line number Diff line number Diff line change
Expand Up @@ -86,7 +86,7 @@ public class DesktopPane extends JFrame implements ActionListener {

public final String projectWebsite = "https://github.com/move-ucsb/DynamoVis";
private static final String buildVersionString = "1.0";
private static final String buildVersionDate = "Aug 01, 2021";
private static final String buildVersionDate = "Aug 1, 2021";

JFrame desktop;
public Dimension animationSize = new Dimension(1280, 720);
Expand Down

0 comments on commit f0a36cf

Please sign in to comment.