Skip to content

Commit

Permalink
fix variable change name error and update readme with more details
Browse files Browse the repository at this point in the history
  • Loading branch information
adrnp committed May 16, 2019
1 parent 4f36ee4 commit c39f048
Showing 2 changed files with 22 additions and 3 deletions.
23 changes: 21 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -9,7 +9,10 @@ To get up and running and using the toolbox, check out the [Using the Toolbox](#

## Getting Started ##

TODO: add how to download the toolbox, or how to clone the code and add it to the MATLAB path.
There are two ways to get started with the toolbox:

- [download and install the toolbox for use](#toolbox)
- [download the source code and install the toolbox for developement](#clone-of-code)

### Toolbox ###

@@ -25,6 +28,8 @@ Now you're all set to use the toolbox, so [check out below for how to get workin

If you clone the code to your computer (with `git clone https://github.com/adrnp/adsb-log.git`) you will need to make sure you add the `adsblog` directory to your MATLAB path.

**Note:** If you plan on developing the code actively, it is recommended that you [fork the repository](https://help.github.com/en/articles/fork-a-repo).

Follow along with MATLAB's [guide to adding a directory to the path](https://www.mathworks.com/help/matlab/matlab_env/add-remove-or-reorder-folders-on-the-search-path.html) and make sure you add the `adsblog` directory within this repository to the MATLAB path. **Note:** You need only add the one directory (folder) to the path.


@@ -71,6 +76,8 @@ To do this task, we can use the `createKML()` function:
ac.createKML('kml-file-name');
```

**Note:** The creation of the KML file required python be installed the the [dependencies listed below](#kml-dependencies).

If no parameter is passed, then the function will use a default filename.

**Note:** the filename does not contain an extension. This is because the function `createKML()` create 2 different types of KML files (one with a time slider, one without) and appends an identifier to the filename for the 2 different file types and then adds the `.kml` extension.
@@ -103,4 +110,16 @@ Each segment does contain `origin` and `destination` data that is a post process

### Sighting ###

The `Sighting` class is the final container used to represent the JSON log data. This class encapsulates the data for each of the ADS-B sightings. Note that some of the sightings are interpolated sightings and flagged accordingly in the Sighting for that sighting.
The `Sighting` class is the final container used to represent the JSON log data. This class encapsulates the data for each of the ADS-B sightings. Note that some of the sightings are interpolated sightings and flagged accordingly in the Sighting for that sighting.

## Dependencies ##

This section covers some of the code dependencies.

### KML Dependencies ###

The KML creation uses a couple python scripts that have the following python dependencies (can be installed with `pip install` for each of these):

- `csv`
- `pytz`
- `simplekml`
2 changes: 1 addition & 1 deletion adsblog/+adsblog/FlightSegment.m
Original file line number Diff line number Diff line change
@@ -64,7 +64,7 @@
newobj = copyElement@matlab.mixin.Copyable(obj);

% make sure to properly copy custom classes
newobj.Messages = copy(obj.Messages);
newobj.Sightings = copy(obj.Sightings);
end
end

0 comments on commit c39f048

Please sign in to comment.