ngageoint / hootenanny

Hootenanny conflates multiple maps into a single seamless map.
GNU General Public License v3.0
358 stars 74 forks source link

Getting started instructions #5681

Closed dabreegster closed 1 year ago

dabreegster commented 1 year ago

Hi, I recently discovered this project on my search for methods to conflate (increasingly out-of-date) linear cycleway data with OSM. It's a very tricky problem, to make the reference geometry match up with OSM ways, often split as separate highway=cycleway ways or when tagged as attributes of a road, split into many pieces. I was about to start working on solving this, but I'm very pleased to find this project instead!

However, I'm having trouble just getting Hootenanny to run, so I can initially figure out how well it works for my use case, and whether to invest more energy in it. The main README links to a missing user guide PDF, but I found the vagrant page. I'm on Ubuntu 20, not CentOS, so it appears this is the easiest way to get started. I'm having trouble getting Vagrant+VirtualBox set up, but I'll work through it and continue with the instructions.

I just wanted to start a discussion about how new users could more easily try out Hootenanny. Is there any possibility for running a public shared instance somewhere, if there was a bit of funding available? (If the web UI lets people import new datasets themselves, then it might be sufficient to expose only that publicly.) Is the Vagrant route indeed the simplest setup option -- I also see some notes about Docker images? Is there any interest in using Github Actions or similar to automatically build for every commit, or for providing prebuilt binary releases for some platforms?

Thank you for the project, am excited to try it out!

Related to #5304

brianhatchl commented 1 year ago

Hi @dabreegster Hoot does have CircleCI build nightly RPMs for CentOS 7 from the master branch.

There is a vagrant machine defined to install from these here that you found and should work if you want to fight through getting Vagrant and Virtualbox set up.

If you already have docker installed you can check out the docker_dev_env branch and try these commands instead.

We don't have a public Hoot instance. I don't think we've ever discussed it before and decided against it, but I also think we haven't had one up to this point because we don't want to take on the responsibility.

p.s. The missing pdf is built from the asciidoc files and is not committed to the git repo. We should probably make that a build artifact outside of the release tarball that can then be linked to from the README.

dabreegster commented 1 year ago

Hi Brian,

Thank you for the help! After I got through some Secure Boot issues with vagrant, it was straightforward -- about 7 minutes for the vagrant up command, and I've got the web UI running! I see 265f34eac9d73f5a96739464dcc07b33b8180f70 fixed the link to the user guide, so there's nothing actionable for this issue. Only other thought is that maybe linking to the SOTMUS talk from the readme or user guide could be helpful, since it's a very nice overview of the project?

Excited to try things out. Thanks again!