Kitware / minerva

Minerva: client/server/services for analysis and visualization
Apache License 2.0
36 stars 14 forks source link

Clarify client/server/services in Readme #111

Closed mgrauer closed 8 years ago

mgrauer commented 8 years ago

As this repo is getting more complex, we should standardize on some terms and clean up the Readme.

client: the web client of Minerva, written in Backbone.js
server: the server side Rest endpoints of Minerva, written in Python, based on Girder
services: the set of services that host and process datasets, including
    * Geonode/Geoserver stack
    * Celery tasks for downloading and processing data
    * Geonode templates for specific tasks
    * Provisioning scripts with Ansible
aashish24 commented 8 years ago

:+1: thanks for writing this up. I am updating the README as well.

mgrauer commented 8 years ago

@mbertrand @jbeezley You two might have more to say here, in case I'm missing something obvious. Or maybe you two can contribute later to the README once your current data services work is complete.

jbeezley commented 8 years ago

It does seem to me that the definition of "data" is a bit broad. I think the first three might qualify as services. In many cases, the minerva server acts as a proxy to other services.

The ansible playbooks I would probably put in a different category. Maybe "deployment"?

jbeezley commented 8 years ago

I also noticed earlier today that the repository description just says "minerva". We should come up with a short tag line to put there.

mgrauer commented 8 years ago

Thanks for the note about the short tag. I changed it to

Minerva: web application for geospatial analysis and visualization

and am happy for someone with a stronger opinion to change it further.

aashish24 commented 8 years ago

@jbeezley @mgrauer I am working on updating the README so please wait until then. One another thing I am adding is licensing and shared ownership with Epidemico.

aashish24 commented 8 years ago

client/server/data is short form. I agree that in its complete description it would be: client (UI and visualization)/ server (analysis and proxy to other serivces) / data services.

jbeezley commented 8 years ago

I would suggest just "services" for a short form. I wouldn't think of any of those as data.

aashish24 commented 8 years ago

client/server/services sounds good to me. @mgrauer @mbertrand what you guys think?

mgrauer commented 8 years ago

great :tiger:

aashish24 commented 8 years ago

We have updated the READMe. I am closing this now.