opentreemap/otm-core

OpenTreeMap is a collaborative platform for crowdsourced tree inventory, ecosystem services calculations, urban forestry analysis, and community engagement.

OpenTreeMap 2

Questions?

Join the user mailing list and let us know: http://groups.google.com/group/opentreemap-user

Or, try our Gitter channel:

Installation

For full installation instructions, see the Github wiki.

Alternatively, you can also use the otm-vagrant project to get started. While not recommended for production, otm-vagrant greatly simplifies getting a development environment for testing and contributing to OTM locally.

Environment variables

This project requires several environment variables, to provide API keys for several services.

ROLLBAR_SERVER_SIDE_ACCESS_TOKEN=....
GOOGLE_MAPS_KEY=...

ROLLBAR_SERVER_SIDE_ACCESS_TOKEN is a token for Rollbar. GOOGLE_MAPS_KEY is a browser key for the Google Maps Javascript API, which can be obtained here.

Other Repositories

This repository (ie, otm-core) is but one of a few separate repositories that together compose the OpenTreeMap project. Others include:

• otm-tiler - map tile server based on Windshaft
• otm-ecoservice - ecosystem benefits calculation service
• otm-ios - An OpenTreeMap client for iOS devices.
• otm-android - An OpenTreeMap client for Android devices.

Additional Documentation

The REST API that provides data for the native mobile apps is documented in api.md

Deprecated Repositories

OpenTreeMap has a long history. These repositories still exist, but are deprecated and no development is happening here moving forward.

• OpenTreeMap - Otherwise known as "OTM1", this is previous generation codebase of OpenTreeMap. It has been entirely superceded by this repository and the others listed above. However, there are some live tree map sites still running on the old OTM1 code, and so we have left it up for archival purposes.

Developer documentation

• Javascript module conventions
• Python mixins

Acknowledgements

This application includes code based on django-url-tools, Copyright (c) 2013 Monwara LLC.

USDA Grant

Portions of OpenTreeMap are based upon work supported by the National Institute of Food and Agriculture, U.S. Department of Agriculture, under Agreement No. 2010-33610-20937, 2011-33610-30511, 2011-33610-30862 and 2012-33610-19997 of the Small Business Innovation Research Grants Program. Any opinions, findings, and conclusions, or recommendations expressed on the OpenTreeMap website are those of Azavea and do not necessarily reflect the view of the U.S. Department of Agriculture.

otm-core's Issues

Cultivar_name on the species model should be "cultivar"

The fact that is it different than the rest if just plain annoying

Upgrade typeahead.js to version 0.10

Typeahead.js is will be releasing v0.10 sometime in August, see twitter/typeahead.js#335.

It has some features we'll need, such as the ability to programmatically open the suggestion list.

Append the active search to the map page query string

If you run a search then navagate away from the map, then return the search is removed. In browsers that support it we should update the querystring via pushstate

Plot model has unused zones property

https://github.com/azavea/OTM2/blob/master/opentreemap/treemap/models.py#L224
It has no references and a typo that would cause it to throw an error. We should probably remove it until it is needed.

Prototype index.html has overlapping content in a small browser window

The text labels do responsively change to small icons but the search UI does not reconfigure.

Attempting to register an existing user name fails, but does not show an error message

Support multiple i-Tree regions within a single implementation

This is listed as a later feature to develop.

Can't create new objects if a user only has pending privs

If a user can only create normal pends, then none of them will be applied! That means that if a user with only pending creates a new plot with a plot width of 5 you get:

Audit(1, CREATE NEW PLOT)
Audit(2, UPDATE PLOT #???? SET WIDTH=5)

Since the second one has no id, it can't be applied and, in fact, is tightly coupled to audit 1.

Also, if a user with sufficient WRITE DIRECT privileges approves Audit #2 but without sufficient privileges to CREATE and object how would we mark that?

Ecobenefits search endpoint doesn't respect field permissions for "not visible"

Migration tests are printing to console

One of the migration tests is printing "Warning: Species matching query does not exist. Lookup parameters were {'pk': 85} ... SKIPPING" to the console.

Speak to @steventlamb for more information.

Cannot tap a tree on iPad

b769b8a

A dozen or so taps at different zoom levels did not show a popup

When creating new users what should the audit records insert show as the 'acting user'?

It appears like the best policy is to have a 'system' user that can't login but has full privileges automatically be assigned to a user's save method.

ReputationMetric (and the rep system) need better test coverage

Cannot reset search

The button is not connected

Counts after filtering by species can show more plots than trees

When filtering by species, the tree and plot counts should be equal. Searching http://ec2-54-224-212-206.compute-1.amazonaws.com/3/trees/ with b769b8a for "Accolade Elm" returns 2 trees and 13 planting sites.

Need create database permissions for otm user for tests

Should be added to the provisioner.

Add case-insensitive LIKE matcher to filter syntax

We need a case-insensitive like matcher

{"name": {"LIKE": "%joe%"}}

Exclusive as a property of min/max

https://github.com/azavea/OTM2/blob/master/opentreemap/treemap/search.py#L96

Should 'EXCLUSIVE' be a property of a min, max value, not a sibling value-property?
ex:

{ "tree.dbh" : {
    "MIN": { "VALUE": 12, "EXCLUSIVE": true }
    "MAX": { "VALUE": 15, "EXCLUSIVE": false }
}
}

URL should reference plot and tree numbers

In OTM1, http://phillytreemap.org/trees/467254/ and http://phillytreemap.org/plots/1200/ go to the same page - which is just confusing.

We need to keep the concept that a tree is linked to a planting site in order to track the history of that site over time. Maybe, users should be able to see all trees that were at a site so http://opentremap.com/philadelphia/plots/1200/trees/467254 would go to the specific tree but http://opentremap.com/philadelphia/plots/1200/ would go to a page for the plot with links to all trees that were ever at that plot.

Designers are working this into the design prototypes.

Backport https://github.com/azavea/OpenTreeMap/pull/156

Default boundary value of 'None' is being passed to filter

Pull request #70 added a boundary search dropdown to map.html with a default value of None. This default value needs to NOT be included in the q= filter argument.

Separate endpoints for returning tree counts and ecobenefits

Computing tree counts is fast, and shouldn't be held up by computing ecobenefits. Also we wouldn't have to split the returned markup.

Importer doesn't update postgres id sequences

Since the objects are inserted with an id set, the primary key sequences aren't queried. For now run the following to update:

select setval('treemap_user_id_seq', (select max(id) from treemap_user));
select setval('treemap_plot_id_seq', (select max(id) from treemap_plot));
select setval('treemap_tree_id_seq', (select max(id) from treemap_tree));

Shouldn't be able to add a Tree to instance A with a plot belonging to instance B

https://github.com/azavea/OpenTreeMap-cloud/blob/be4017307f954858c20cf259cf18651fbc255eec/opentreemap/treemap/tests.py#L108

This test will create, as part of the product, a tree on plot1, whose instance is instance1, but adds the tree to instance2. That should fail, but it doesn't.

treemap.js bundle is 8.3MB

vagrant@precise64:/usr/local/otm/static/js$ ls -lah treemap.js 
-rw-r--r-- 1 root root 8.3M Jul 26 21:10 treemap.js

The Chrome dev tools freeze for 5-10 seconds when you try to open treemap.js.

Storing only currency symbol does not allow for aggregating benefits over multiple instances

In PR #162 we are storing only the displayed currency symbol to identify which currency the ecobenefits-to-money conversion is happening in, which seems OK for right now.

If in the future we want to show aggregate benefits for multiple instances together, e.g. how much money do all trees in every OpenTreeMap instance save, we should save the currency used in an unambiguous way. currency symbol alone does not suffice, as multiple countries use '$' to represent their different currencies.

Display ecobenefits in currency other than US dollars

Needs to take exchange rates into account

species.native_status(CharField) -> species.is_native(NullBooleanField)

When displaying audits only show fields that user has read access to

Allow the profile to be set to "private"

If a user sets their profile to private they are the only person that can visit /users/{username}

Don't show email address on /users/<username>

...since that page is publicly viewable

Instance is nullable on ReputationMetric

Do we actually want this? The comment says:
# instance is nullable because some auditables don't have instances
instance = models.ForeignKey('Instance', null=True, blank=True)

but will users ever be editing and receiving reputation points for models that aren't instance-specific?

Rename BoundaryZones model to BoundaryZoneGroup or BoundaryZoneSet

I think it's unconventional to pluralize the name of a model. If I understand correctly, this is a multipolygon and so it is a group of boundaries, we should consider putting that into the name and removing the pluralization.

From a developer perspective, if I were to get all BoundaryZones objects, would I call them BoundaryZoneses? I think if we use some of the builtin django niceties, we'll be going against the grain. We can always set the model meta option verbose_name_plural, but maybe we don't want to bother.

Clearing out the species text box does not remove the species from the search

Reproducible in eceb19f

1. Open /1/trees/
2. Filter by species
3. Clear the species text box and submit the search

expected: All trees are shown

actual: the species is still part of the search

Can't delete a user

u.delete_with_user(u)
Traceback (most recent call last):
  File "<console>", line 1, in <module>
  File "/usr/local/otm/app/opentreemap/treemap/audit.py", line 371, in delete_with_user
    instance=self.instance,
AttributeError: 'User' object has no attribute 'instance'

Add another tree with same details should load last location used, not last address

When a user selects the "add another tree with same details" option on the add a tree page, the map reloads with the location dot on the default location for that address. The map should load with the location dot at the place where the user moved it before adding the tree.

URLs are not consistent

We should settle on a consistent URL pattern.

Some of the URLs end in trailing slashes: "/users/vagrant/"
Some do not: "/1/benefit/search"

If possible, I think ommitting the trailing slash looks better, as it prevents URLs with query params after the trailing slash like "/users/vagrant/?instance_id=1"

Show loading feedback when fetching eco benefits

For a large number of trees, calculating eco benefits can take seconds. When a search is triggered, the subhead and the accordion on the map page should show loading indicators which should be cleared and replaced with either content or a friendly error message.

Merge downstream importer code

Merge the importer into OTM2 and refactor to move validation logic into models

Password reset fails

Password reset is failing to save the User model because we need to call save_with_user() rather than save(). We will be adding the concept of a 'system user' so this issue should be addressed after that is in place.

Remove ambiguous strict equal filter syntax

Currently there are two ways to encode an exact match filter

{"field": "value")

{"field": {"IS": "value")}

To keep things simple, remove the shorthand syntax so that all strict equal matches use the "IS" marcher.

The label for TMS should be "Tile Map Service"

Teeny tiny nitpick

https://github.com/azavea/OpenTreeMap-cloud/blob/6e77c3a820cd15862797d0219e4e8182c52853ba/opentreemap/treemap/models.py#L22

"Tile Mapping Service" --> "Tile Map Service"

http://wiki.osgeo.org/wiki/Tile_Map_Service_Specification

Use a hash for instance id in the url conf

Should we change the url for instances so that instead of having an ID in the path, we have a string of some kind?

This can be useful because:

1. It prevents people from poking around other instances. You can imagine people trying to test the water by looping over instance ids and hitting urls to see what kind of privileges they have. Hashstrings are harder to iterate over.
2. It can further separate premium instances from regular instances. If you are a high paying customer, you can get www.opentreemap.org/winnipeg-trees/ but if you have a free acount you have to deal with www.opentreemap.org/sliding-snails-91x231/
   3) Heroku does this.

Remove logout template and redirect to root url on logout

to be completed after we have content for the application root

Running a search on iPad should hide the keyboard

Show advanced search UI

The diameter search fields from our early prototypes were lost after applying stying

Prototype cleanup

Please do the following for the prototypes/markup:

General Styling Edits

• Strip out Glyphicons from Bootstrap, replace with Fontello library. Be sure to keep a copy of the icons.html file so we have a reference of the icons available.
• If you use SVGs anywhere (which I'd like to keep minimal and only for custom things, like the logo), either convert them to images (.pngs) or be sure to have cross-platform fallbacks.

Layout/UI

• Do we need the full header on the login and signup pages (do they need to extend the full layout of base.html)? I think we can remove the search options from this page.
• Let's make the signup form simpler -- check with Deb if it's necessary for us to have all of these items.
• The static page and tree detail pages feel overloaded and crowded as 100% width. Consider adjusting these to use the responsive width container or add additional padding. The navigation on the left on the static page is problematic on smaller desktop screens.

Mobile

• Although we're not supporting a mobile-specific version of the site, we likely want to have the mobile view look decent (or remove > 767px media queries). At this point, the site is completely unusable.

Make admin work with audit (i.e. save_with_user)

Add Grunticon

Would it be possible to add Grunticon into the workflow for OTM2, since we're already using Grunt?

A user's permissions and reputation points should be linked to a specific instance

If a user is an advanced user on one tree map, they don't also get to be an advanced user on another tree map. User accounts work on all tree maps, but permissions are linked to a particular instance.